Vellum CLI
The Vellum CLI is a command line interface for interacting with Vellum. It allows you to push and pull resources defined in both the Vellum application and the Vellum SDKs.
Ping
vellum ping
Used to verify that the Vellum CLI is authenticated correctly. It should return your active Organization and Workspace information based on your configured Vellum API key.
Pull
vellum workflows pull
Used to pull Vellum resources from the Vellum application into the local SDK.
Arguments
The module to pull the workflow into. If not provided, a module will be generated based on the Workflow Sandbox ID.
Pull the Workflow from a specific Sandbox ID. If not provided, the Workflow Sandbox ID defined in the pyproject.toml
associated with [module]
will be used. Must be provided if [module]
is not provided.
Pull the Workflow from a specific Deployment. Can use the name or the ID of the Deployment.
Include the JSON representation of the Workflow in the pull response. Should only be used for debugging purposes.
Exclude the code definition of the Workflow from the pull response. Should only be used for debugging purposes.
Fail immediately when encountering an error. By default, errors are collected and printed at the end of the pull.
Include a sandbox.py
file in the pull response. This file will contain a SandboxRunner
class that can be used to run the Workflow locally.
Push
vellum workflows push
Used to push Vellum resources defined with the SDK to the Vellum application.
Arguments
The module to push from local. If not provided, the first module defined in the pyproject.toml
file will be used.
The specific Workflow Sandbox ID to use when pushing. Must either be already associated with the provided module or be available for use. The Workflow Sandbox must also exist in Vellum.
The specific Workspace config to use when pushing. If not provided, the default Workspace config uses the VELLUM_API_KEY
environment variable.
If provided, the Workflow will be automatically deployed once pushed to Vellum.
The label to use for the deployment. Can only be provided if --deploy
is also provided.
The name to use for the deployment. Can only be provided if --deploy
is also provided.
The description to use for the deployment. Can only be provided if --deploy
is also provided.
The release tags to use for the deployment. Can only be provided if --deploy
is also provided.