Skip to content

Commands

Vyft CLI reference.

Scaffold a new Vyft project. Prompts for project name, template, and options.

Deploy all resources defined in vyft.config.ts.

Terminal window
vyft deploy [--stage <name>] [--project <name>]
FlagDescription
--stageDeployment stage (default: production)
--projectProject name

Tear down all deployed resources.

Terminal window
vyft destroy [--stage <name>] [--project <name>] [-y]
FlagDescription
-y, --yesSkip confirmation prompt

Preview planned changes without deploying.

Terminal window
vyft preview [--stage <name>] [--project <name>]

Output format:

+ urn:vyft:resource:runtime:service:app (create)
~ urn:vyft:resource:runtime:service:api (update)
- urn:vyft:resource:runtime:volume:data (delete)

Sync local state with the actual runtime state by calling resource read handlers.

Terminal window
vyft refresh [--stage <name>] [--project <name>]

Manage deployment contexts.

Terminal window
vyft context list # List all contexts
vyft context add <name> # Add a new context
vyft context use <name> # Switch active context
vyft context remove <name> # Remove a context