Skip to content

CLI Reference

The following commands are planned for the herdctl CLI:

CommandDescription
herdctl start [agent]Start all agents, or a specific agent
herdctl stop [agent]Stop all agents, or a specific agent
herdctl restartRestart all agents
herdctl status [agent]Show fleet status, or specific agent status
CommandDescription
herdctl logs [agent]View logs for all agents, or a specific agent
CommandDescription
herdctl trigger <agent>Manually trigger an agent to run
CommandDescription
herdctl config validateValidate configuration files
CommandDescription
herdctl webStart the local monitoring dashboard
Terminal window
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 version

The following additional commands are planned for future releases:

Terminal window
herdctl agent list # List all agents
herdctl agent status <name> # Show agent status
herdctl agent start <name> # Start specific agent
herdctl agent stop <name> # Stop specific agent
herdctl agent logs <name> # View agent logs
herdctl agent resume <name> # Resume agent session
Terminal window
herdctl jobs list # List all jobs
herdctl jobs list --agent <name> # List jobs for agent
herdctl jobs show <id> # Show job details
herdctl jobs logs <id> # View job logs
herdctl jobs cancel <id> # Cancel running job
herdctl jobs resume <id> # Resume job session
Terminal window
herdctl workspace list # List workspaces
herdctl workspace status <name> # Show workspace status
herdctl workspace clean <name> # Reset workspace
herdctl workspace remove <name> # Remove workspace
Terminal window
herdctl config show # Show current config
herdctl init # Initialize new project
Terminal window
herdctl discord start # Start Discord bot
herdctl discord status # Show bot status
CodeMeaning
0Success
1General error
2Configuration error
3Agent error
4Job error

See Environment Variables for configuration options.