Skip to main content

​
Install

npm install -g @vela/cli

​
Requirements

  • Node.js 18+

​
Set up

​
1. Create a config file

Create vela.config.json in your project root: 
{
  "app": "my-app-slug"
}

​
2. Set your client secret

export VELA_CLIENT_SECRET="vela_cs_..."

​
3. Create your schemas directory

mkdir -p vela/schemas

​
4. Verify

vela --help

Usage: vela <command> [options]

Commands:
  push    Sync local schema files to the remote Vela API
  pull    Download remote schemas to local JSON files
  diff    Show pending changes without pushing

Options:
  --app <slug>    App slug or ID (overrides vela.config.json)
  --dir <path>    Schemas directory (overrides vela.config.json)
  --help          Show this help message
  --version       Show version