CLI Reference
Planned Commands
Section titled “Planned Commands”The following commands are planned for the herdctl CLI:
Fleet Management
Section titled “Fleet Management”| Command | Description |
|---|---|
herdctl start [agent] | Start all agents, or a specific agent |
herdctl stop [agent] | Stop all agents, or a specific agent |
herdctl restart | Restart all agents |
herdctl status [agent] | Show fleet status, or specific agent status |
Monitoring
Section titled “Monitoring”| Command | Description |
|---|---|
herdctl logs [agent] | View logs for all agents, or a specific agent |
Manual Operations
Section titled “Manual Operations”| Command | Description |
|---|---|
herdctl trigger <agent> | Manually trigger an agent to run |
Configuration
Section titled “Configuration”| Command | Description |
|---|---|
herdctl config validate | Validate configuration files |
Web UI
Section titled “Web UI”| Command | Description |
|---|---|
herdctl web | Start the local monitoring dashboard |
Global Options (Planned)
Section titled “Global Options (Planned)”herdctl [command] [options]
Options: -c, --config <path> Path to config file (default: ./herdctl.yaml) -v, --verbose Enable verbose output --json Output in JSON format --help Show help --version Show versionAdditional Commands (Future)
Section titled “Additional Commands (Future)”The following additional commands are planned for future releases:
Agent Commands
Section titled “Agent Commands”herdctl agent list # List all agentsherdctl agent status <name> # Show agent statusherdctl agent start <name> # Start specific agentherdctl agent stop <name> # Stop specific agentherdctl agent logs <name> # View agent logsherdctl agent resume <name> # Resume agent sessionJob Commands
Section titled “Job Commands”herdctl jobs list # List all jobsherdctl jobs list --agent <name> # List jobs for agentherdctl jobs show <id> # Show job detailsherdctl jobs logs <id> # View job logsherdctl jobs cancel <id> # Cancel running jobherdctl jobs resume <id> # Resume job sessionWorkspace Commands
Section titled “Workspace Commands”herdctl workspace list # List workspacesherdctl workspace status <name> # Show workspace statusherdctl workspace clean <name> # Reset workspaceherdctl workspace remove <name> # Remove workspaceConfiguration Commands
Section titled “Configuration Commands”herdctl config show # Show current configherdctl init # Initialize new projectChat Integration
Section titled “Chat Integration”herdctl discord start # Start Discord botherdctl discord status # Show bot statusExit Codes (Planned)
Section titled “Exit Codes (Planned)”| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | General error |
| 2 | Configuration error |
| 3 | Agent error |
| 4 | Job error |
Environment Variables
Section titled “Environment Variables”See Environment Variables for configuration options.