Migrate from the community voiceflow-cli to the vf CLI - Voiceflow Documentation

The community voiceflow-cli (installed as voiceflow from a personal Homebrew tap) has been retired from this documentation. The official CLI is vf, developed at github.com/voiceflow/cli. They are different binaries with different commands, flags, and defaults, so scripts need the mapping below rather than a rename.

Install the replacement

Follow Install, then authenticate. The old tap install (brew install xavidop/tap/voiceflow) has no supported upgrade path to vf.

Command mapping

Community `voiceflow` command	Official `vf` equivalent
`voiceflow kb query`	`vf knowledge-base query`
`voiceflow document upload-file`	`vf document` create commands
`voiceflow document upload-url`	`vf document` create commands
`voiceflow transcript fetch`	`vf transcript`
`voiceflow transcript fetch-all`	`vf transcript` list and get
`voiceflow analytics fetch`	`vf analytics query` per-metric commands
`voiceflow agent export`	`vf environment export-json`
`voiceflow dialog start`	`vf conversation send`
`voiceflow dialog replay`	No direct equivalent. Script `vf conversation send` over a saved transcript
`voiceflow test execute`	No equivalent yet. Use Tests in the product, or the evaluation commands
`voiceflow test suites`	No equivalent yet. See Tests
`voiceflow server` (api-serve)	No equivalent. The hosted APIs cover the same surface
`voiceflow completion`	No equivalent yet
`voiceflow jsonschema`	No equivalent. `vf --usage` prints the CLI usage schema in KDL format

Rows marked “no equivalent” are the truth, not a placeholder: those community features have no counterpart in vf today. If one of them blocks you, say so on the CLI issue tracker.

What the official CLI adds

Beyond the mapped commands, vf covers surface the community CLI never had: projects, environments, functions, API tools, MCP servers, playbooks, variables, evaluations, and workspaces, plus structured output (--output-format), inline jq filtering, and --dry-run on every command.

The retired test platform

The community Test Platform web app was built on the community CLI’s server mode and is retired with it. For testing agents, use Tests and evaluations in the product.