Getting Started¶
Prerequisites¶
- Python 3.12+ (3.12 or 3.13 recommended)
- Debian/Ubuntu package manager (
apt) - age encryption tool
Install age:
On macOS you can still use:
Verify:
Installation¶
Clone the repo and install in editable mode:
Verify the CLI:
Initialize the Vault¶
Set up encrypted credential storage:
Store some credentials:
Verify they are stored:
Create Your First Skill¶
Use the interactive scaffolder:
Follow the prompts:
Skill name (kebab-case): hello-world
Description: Print a greeting
Script type (bash, python) [bash]: bash
This creates skills/hello-world/ with a ready-to-edit script. Open the generated file and add your logic:
Run it:
Or use it as a Claude Code slash command -- type /hello-world in your Claude Code session.
One-Shot Skill Creation¶
Skip the prompts with flags:
claw skill create \
--name check-ports \
--description "Check if common ports are open on a target" \
--type bash
Explore Existing Skills¶
# List all skills
claw skill list
# Get details on a skill
claw skill info network-scan
# Validate a skill directory
claw skill validate skills/network-scan
# Re-sync all slash commands
claw skill sync
Available Slash Commands¶
After running claw skill sync, any skill with slash_command: true in its manifest is available as a Claude Code slash command. Type / followed by the skill name:
/network-scan-- Scan all home network subnets/hello-world-- (your custom skill)- Any other skill you create with
slash_command: true
Project Structure at a Glance¶
claw vault init/set/get/list/delete # Encrypted credential management
claw skill list/info/run/sync/create # Skill lifecycle
claw skill validate <path> # Manifest validation
claw status # System health check
Next Steps¶
All 8 core phases are complete. Explore additional subsystems:
| Subsystem | Command | Documentation |
|---|---|---|
| Cron scheduling | claw cron list |
docs/reference/cron.md |
| Multi-channel messaging | claw msg channels |
docs/reference/messaging.md |
| SSH remote execution | claw ssh hosts |
docs/reference/ssh.md |
| Browser automation | claw browse open <url> |
docs/reference/browser.md |
| Workflow orchestration | claw workflow list |
docs/reference/workflows.md |
| Persistent memory | claw memory list |
docs/reference/memory.md |
| File watchers | claw watcher list |
docs/reference/watchers.md |
| Web dashboard | claw dashboard |
docs/reference/dashboard.md |
| MCP server | Configure in Claude Code settings | docs/reference/mcp-server.md |
Troubleshooting¶
age: command not found¶
Install age on Debian/Ubuntu: sudo apt install -y age (or brew install age on macOS).
Identity file not found ... Run claw vault init¶
Run claw vault init to generate the age keypair.
Skill not found: <name>¶
Make sure the skill directory exists under skills/ and contains a valid skill.yaml. Run claw skill validate skills/<name> to check.
Slash command not appearing in Claude Code¶
Run claw skill sync to regenerate symlinks. Verify the symlink exists: