Skip to main content

Managing Simulations via CLI

Create, configure, and control mock simulations from the command line.

Listing Simulations​

# List all simulations in the current workspace
surestage simulations list

# Filter by status
surestage simulations list --status active

# Output as JSON
surestage simulations list --format json

Creating Simulations​

# Interactive creation
surestage simulations create

# With flags
surestage simulations create \
  --name "Payment API" \
  --base-path "/api/v1" \
  --description "Stripe-like payment mock"

Simulation Lifecycle​

# Start a simulation
surestage simulations start <simulation-id>

# Stop a simulation
surestage simulations stop <simulation-id>

# Reset state (clear logs and state, keep config)
surestage simulations reset <simulation-id>

# Delete a simulation
surestage simulations delete <simulation-id>

Simulation Details​

# View simulation details
surestage simulations get <simulation-id>

# View simulation URL
surestage simulations url <simulation-id>

# View live request log
surestage simulations logs <simulation-id> --follow

Import / Export​

# Import from OpenAPI spec
surestage simulations import --file openapi.yaml --name "My API"

# Export simulation as OpenAPI
surestage simulations export <simulation-id> --format openapi

Next Steps​