Skip to Content
CLI referencegensx start

gensx start

The gensx start command starts a local development server that enables you to test and debug your GenSX workflows.

Usage

gensx start <file> [options]

Arguments

ArgumentDescription
<file>The workflow file to serve (e.g., src/workflows.tsx).

Options

OptionDescription
--port <port>Port to run the server on.
-q, --quietSuppress output.
-h, --helpDisplay help for the command.

Description

This command starts a local development server that:

  • Watches your workflow file for changes and automatically reloads
  • Provides a web interface to test and debug your workflows
  • Simulates the cloud environment locally
  • Runs your workflow components in a development mode

The development server includes:

  • A web UI for testing your workflows
  • Real-time logs and execution visibility
  • Access to the GenSX development dashboard

Examples

# Start server with a specific workflow file gensx start src/workflows.tsx <<<<<<< HEAD # Start server with minimal output gensx start src/workflows.tsx --quiet ======= # Start server with a custom project name gensx start src/workflows.tsx --project my-custom-name # Start server on port 3000 gensx start src/workflows.tsx --port 3000 >>>>>>> 4c75b171c6cd6b0bd9779d07cc1ca5b9e1679e0b

Notes

  • The server runs on port 1337 by default
  • You can access the development UI at http://localhost:1337/swagger-ui
  • Environment variables from your local environment are available to the workflow
  • For more complex environment variable setups, consider using a .env file in your project root
Last updated on