GenSX CLI reference
The GenSX command-line interface (CLI) provides a set of commands to help you build, deploy, and manage your GenSX applications.
Installation
The GenSX CLI is included when you install the main GenSX package:
npm install -g gensx
Available commands
Auth
Command | Description |
---|---|
gensx login | Log in to GenSX Cloud |
Development
Command | Description |
---|---|
gensx new | Create a new GenSX project |
gensx start | Start a local development server |
gensx build | Build a workflow for deployment |
Deployment & Execution
Command | Description |
---|---|
gensx deploy | Deploy a workflow to GenSX Cloud |
gensx run | Run a workflow on GenSX Cloud |
Environment Management
Command | Description |
---|---|
gensx env | Show the current environment details |
gensx env create | Create a new environment |
gensx env ls | List all environments for a project |
gensx env select | Select an environment as active |
gensx env unselect | Unselect the current environment |
Common Workflows
Starting a New Project
# Log in to GenSX Cloud
gensx login
# Create a new project
gensx new my-project
cd my-project
# Start local development
gensx start src/workflows.tsx
Managing Environments
# Create and switch to a development environment
gensx env create dev
gensx env select dev
# View current environment
gensx env
Deploying and Running Workflows
# Build and deploy your workflow
gensx deploy src/workflows.tsx
# Run a workflow
gensx run my-workflow --input '{"message": "Hello, world!"}'
For detailed information about each command, please refer to the corresponding documentation pages.
Last updated on