Skip to main content

Basic Usage

klaw [command] [subcommand] [flags]

Global Flags

FlagDescription
--help, -hShow help for any command
--version, -vShow version information
--configPath to config file
--jsonOutput in JSON format

Command Categories

Core Commands

CommandDescription
klaw chatInteractive terminal chat
klaw startStart platform (Slack + scheduler)
klaw dispatchSend one-shot task to agent
klaw initInitialize klaw configuration

Agent Management

CommandDescription
klaw create agentCreate a new agent
klaw get agentsList all agents
klaw describe agentShow agent details
klaw delete agentDelete an agent

Container Operations

CommandDescription
klaw buildBuild container image
klaw runRun agent in container
klaw psList running containers
klaw logsView container logs
klaw stopStop container
klaw attachAttach to container

Cluster Operations

CommandDescription
klaw controller startStart controller
klaw controller statusShow controller status
klaw node joinJoin a controller
klaw node statusShow node status
klaw get nodesList connected nodes
klaw get tasksList dispatched tasks

Namespace Management

CommandDescription
klaw create clusterCreate a cluster
klaw create namespaceCreate a namespace
klaw get clustersList clusters
klaw get namespacesList namespaces
klaw context useSwitch context
klaw context listList contexts

Skill Management

CommandDescription
klaw skill listList available skills
klaw skill installInstall a skill
klaw skill uninstallRemove a skill
klaw skill showShow skill details
klaw skill createCreate new skill

Cron Jobs

CommandDescription
klaw cron createCreate cron job
klaw cron listList cron jobs
klaw cron enableEnable a job
klaw cron disableDisable a job
klaw cron deleteDelete a job
klaw cron runRun job manually

Configuration

CommandDescription
klaw config viewView configuration
klaw config setSet config value
klaw config resetReset to defaults

Quick Reference

Start Interactive Chat

klaw chat
klaw chat --tui
klaw chat --model gpt-4o
klaw chat --agent coder

Start Full Platform

klaw start
klaw start --provider anthropic
klaw start --model claude-sonnet-4-20250514

Create and Use Agents

# Create
klaw create agent myagent \
  --model claude-sonnet-4-20250514 \
  --skills code-exec,git \
  --task "Development tasks"

# List
klaw get agents

# Use
klaw chat --agent myagent
klaw dispatch "fix the bug" --agent myagent

Run in Container

klaw build
klaw run myagent --task "Review code"
klaw run myagent --detach
klaw ps
klaw logs myagent
klaw stop myagent

Distributed Mode

# Controller
klaw controller start --port 9090 --token mytoken

# Node
klaw node join controller:9090 --token mytoken

# Dispatch
klaw dispatch "analyze codebase" --agent researcher

Manage Skills

klaw skill list
klaw skill install web-search
klaw skill show web-search

Cron Jobs

klaw cron create daily-report \
  --schedule "0 9 * * *" \
  --agent reporter \
  --task "Generate report"

klaw cron list
klaw cron enable daily-report

Output Formats

Default (Human-Readable)

klaw get agents
NAME     MODEL                      SKILLS         STATUS
coder    claude-sonnet-4-20250514   code-exec,git  Ready

JSON

klaw get agents --json
[
  {
    "name": "coder",
    "model": "claude-sonnet-4-20250514",
    "skills": ["code-exec", "git"],
    "status": "Ready"
  }
]

Exit Codes

CodeMeaning
0Success
1General error
2Invalid arguments
3Configuration error
4Connection error

Next Steps