Push
vellum workflows push
Used to push Vellum resources defined with the SDK to the Vellum application.
The push feature has different levels of support for different components. See the Push Feature Status page for more details.
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.
Validates the workflow without actually pushing it to Vellum. Useful for checking if your workflow can be pushed successfully. Also returns an expected diff.
Fail immediately when encountering an error. By default, errors are collected and printed at the end of the push.