For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
BlogLog InRequest Demo
HomeProductDevelopersSelf-HostingChangelog
HomeProductDevelopersSelf-HostingChangelog
  • Getting Started
    • Overview
  • Workflows SDK
    • Introduction
    • Installation
    • Core Concepts
    • Defining Control Flow
    • Configuration
    • Custom Docker Images
      • Displayable Nodes
      • Datasets
      • CLI
        • Ping
        • Pull
        • Push
  • Client SDK
    • Introduction
    • Authentication
    • API Versioning
LogoLogo
BlogLog InRequest Demo
Workflows SDKAPI ReferenceCLI

Pull

Example Usage
$vellum workflows pull my.example
Was this page helpful?
Previous

Push

Next
Built with

vellum workflows pull

Used to pull Vellum resources from the Vellum application into the local SDK.

Arguments

[module]
str

The module to pull the workflow into. If not provided, a module will be generated based on the Workflow Sandbox ID.

--workflow-sandbox-id
str

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.

--workflow-deployment
str

Pull the Workflow from a specific Deployment. Can use the name or the ID of the Deployment.

--include-json
bool

Include the JSON representation of the Workflow in the pull response. Should only be used for debugging purposes.

--exclude-code
bool

Exclude the code definition of the Workflow from the pull response. Should only be used for debugging purposes.

--strict
bool

Fail immediately when encountering an error. By default, errors are collected and printed at the end of the pull.

--include-sandbox
bool

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.