Velociraptor Logo

#Configuration

Velociraptor accepts YAML, JSON or TypeScript configuration files. Config files can be named scripts.<EXT> or velociraptor.<EXT> where EXT is one of yml, yaml, json or ts.

#Format

In its simplest form, the scripts property behaves like in package.json: the keys are script names and the values are command strings:

# scripts.yaml
scripts:
  start: deno run --allow-net server.ts
  test: deno test --allow-net server_test.ts
// scripts.json
{
  "scripts": {
    "start": "deno run --allow-net server.ts",
    "test": "deno test --allow-net server_test.ts"
  }
}
// scripts.ts
export default {
  scripts: {
    start: "deno run --allow-net server.ts",
    test: "deno test --allow-net server_test.ts",
  },
};

#Compact deno run

When a command starts with a .ts or .js file, deno run is automatically prepended:

scripts:
  start: server.ts # Equivalent to `deno run server.ts`

#More script options

Scripts can also be objects:

scripts:
  start:
    desc: Runs the server
    cmd: deno run --allow-net server.ts

In this case the command(s) are specified in the cmd property. Use the desc property to provide a description of what the script does, it'll be shown in the list of available scripts (when running vr without arguments).

More script object properties are detailed in the next guides.

#Config files reference

See the complete config files reference here.