Skip to Content
CLI referencegensx deploy

gensx deploy

The gensx deploy command uploads and deploys a workflow to GenSX Cloud, making it available for remote execution.

Usage

gensx deploy <file> [options]

Arguments

ArgumentDescription
<file>File to deploy. This should be a TypeScript file that exports a GenSX workflow.

Options

OptionDescription
-ev, --env-var <KEY=value>Environment variable to include with deployment. Can be used multiple times.
-p, --project <name>Project name to deploy to.
-e, --env <name>Environment name to deploy to.
-h, --helpDisplay help for the command.

Description

This command:

  1. Builds your workflow
  2. Uploads it to GenSX Cloud
  3. Creates or updates the deployment
  4. Sets up any environment variables specified

After successful deployment, your workflow will be available for remote execution via the GenSX Cloud console or through the gensx run command.

Examples

# Deploy a workflow gensx deploy src/workflows.tsx # Deploy to a specific project and environment gensx deploy src/workflows.tsx --project my-production-project --env dev # Deploy with environment variables gensx deploy src/workflows.tsx -ev API_KEY=abc123 -ev DEBUG=true # Deploy with an environment variable taken from your local environment gensx deploy src/workflows.tsx -ev OPENAI_API_KEY

Notes

  • You must be logged in to GenSX Cloud to deploy (gensx login)
  • gensx deploy requires Docker to be running
  • If your workflow requires API keys or other secrets, provide them using the -ev or --env-var option
  • For environment variables without a specified value, the CLI will use the value from your local environment
  • After deployment, you can manage your workflows from the GenSX Cloud console
  • The deployment process automatically handles bundling dependencies
Last updated on