Skip to main content

​
Run with npx

DISPATCHQ_API_KEY=dq_live_... npx dispatchq --help

​
Install globally

npm install -g dispatchq
dispatchq --help

​
Monorepo local development

If you are working in this repository: 
git clone https://github.com/jayhickey/DispatchQ.git
cd DispatchQ/packages/cli
npm install
npm run build
node dist/index.js --help

​
Environment setup

The CLI reads these values:
  • DISPATCHQ_API_KEY (required)
  • DISPATCHQ_API_URL (optional, defaults to https://api.dispatchq.dev)
export DISPATCHQ_API_KEY=dq_live_...
export DISPATCHQ_API_URL=https://api.dispatchq.dev

​
.dispatchq config file

You can store config in a .dispatchq file in your home directory or current project directory. 
DISPATCHQ_API_KEY=dq_live_...
DISPATCHQ_API_URL=https://api.dispatchq.dev

​
Override with flags

CLI flags override environment/config values: 
dispatchq --api-key dq_live_... --api-url https://api.dispatchq.dev jobs list