Loading...
Last updated on
The GenSX command-line interface (CLI) provides a set of commands to help you build, deploy, and manage your GenSX applications.
The GenSX CLI is included when you install the main GenSX package:
npm install -g gensx| Command | Description |
|---|---|
gensx login | Log in to GenSX Cloud |
| Command | Description |
|---|---|
gensx new | Create a new GenSX project |
gensx start | Start a local development server |
gensx build | Build a workflow for deployment |
| Command | Description |
|---|---|
gensx deploy | Deploy a workflow to GenSX Cloud |
gensx run | Run a workflow on GenSX Cloud |
| 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 |
| Command | Description |
|---|---|
gensx project | Show project details |
gensx project create | Create a new project |
gensx project ls | List all projects |
| Command | Description |
|---|---|
gensx examples | List all available examples |
gensx examples clone | Clone an example project |
You can start a new project either from scratch or by cloning an example:
# 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.ts# Log in to GenSX Cloud
gensx login
# See available examples
gensx examples
# Clone an example project
gensx examples clone chat-ux my-chat-app
cd my-chat-app
# Follow the README for setup instructions# Create and switch to a development environment
gensx env create dev
gensx env select dev
# View current environment
gensx env# Build and deploy your workflow
gensx deploy src/workflows.ts
# Run a workflow
gensx run my-workflow --input '{"message": "Hello, world!"}'For detailed information about each command, please refer to the corresponding documentation pages.