Platform — Developer Tools

CLI Tools

The Ventryx CLI (vtx) lets you manage platform resources, deploy workflows, tail logs, and trigger events directly from your terminal. It's designed for developer workflows and CI/CD automation.

Installation

macOS / Linux (Homebrew)

brew install ventryx/tap/vtx

npm (global)

npm install -g @ventryx/cli

Verify installation

vtx --version
# vtx 1.8.2

Authentication

# Using an API key (recommended for CI/CD)
export VENTRYX_API_KEY=vtx_live_...
vtx auth status

# Interactive browser login
vtx auth login

Core commands

Command	Description
`vtx workflows list`	List all workflows in the current org
`vtx workflows deploy <file>`	Deploy a workflow definition from a YAML/JSON file
`vtx workflows run <id>`	Manually trigger a workflow run
`vtx workflows logs <id>`	Tail live logs for a workflow
`vtx events emit <type>`	Emit a platform event by type
`vtx events list`	List recent events with optional type filter
`vtx keys list`	List all API keys for the org
`vtx keys create <name>`	Create a new scoped API key
`vtx keys revoke <id>`	Immediately revoke an API key
`vtx env switch <name>`	Switch active environment (live / test)

CI/CD usage

Use the CLI in GitHub Actions, GitLab CI, or any CI/CD system by exporting your API key as a secret:

GitHub Actions step

- name: Deploy Ventryx workflow
  env:
    VENTRYX_API_KEY: ${{ secrets.VENTRYX_API_KEY }}
  run: |
    npm install -g @ventryx/cli
    vtx workflows deploy ./workflows/order-processing.yml