Skip to main content
The AgentSystems SDK includes command-line tools for managing your platform deployment.
The agentsystems CLI includes platform management commands.

​
Platform Management

​
Lifecycle

Control the platform lifecycle with these commands:
  • Start Platform
  • Stop Platform
  • Restart
# Start all services
agentsystems up

# Start in detached mode (default)
agentsystems up --detach

# Start with fresh containers
agentsystems up --fresh

# Start without Langfuse tracing
agentsystems up --no-langfuse
The platform starts at:

​
Monitoring

Check platform status and view logs:
  • Status
  • Logs
# Show all container status
agentsystems status

# Check specific service
agentsystems status --service gateway

​
Running Agents

Execute agents with JSON payloads and optional file uploads:
  • Simple Execution
  • With File Upload
agentsystems run hello-world-agent '{"date": "October 15, 1979"}'

​
Artifact Management

Access input and output files from agent executions: 
# Get output directory for a thread
agentsystems artifacts-path abc123-def456

# Get specific output file path
agentsystems artifacts-path abc123-def456 result.json

# Get input directory
agentsystems artifacts-path abc123-def456 --input

# Get specific input file
agentsystems artifacts-path abc123-def456 data.csv --input

​
System Maintenance

Manage platform resources and updates:
  • Clean System
  • Update Platform
# Nuclear cleanup
agentsystems clean

# Skip Docker prune
agentsystems clean --no-prune-system
Removes all containers, volumes, and optionally prunes Docker.

​
Command Reference

​
Platform Commands

CommandDescription
agentsystems init [DIR]Initialize new deployment
agentsystems upStart platform services
agentsystems downStop platform services
agentsystems restartRestart platform
agentsystems logsView service logs
agentsystems statusCheck service status
agentsystems runExecute an agent
agentsystems artifacts-pathGet artifact file paths
agentsystems cleanDeep clean system
agentsystems updateUpdate platform images
agentsystems versionShow SDK version
agentsystems infoShow diagnostics

​
Command Alias

For convenience, a shorter alias is available:
  • agntsys → agentsystems

​
Getting Help

All commands support --help to display detailed usage information, available options, and examples: 
# Show all available commands and global options
agentsystems --help

# Show options for running agents (payloads, file uploads, polling)
agentsystems run --help

# Show options for viewing logs (filtering, following, tail)
agentsystems logs --help
⌘I