Skip to content

Commit e988a12

Browse files
alsk1992claude
andcommitted
Add CLI commands section to README
All terminal commands now properly documented with clodds prefix: - Core: start, repl, doctor, status, endpoints - User management: pairing list/approve/users/add - Configuration: config get/set/path - Skills: list/search/install/update - Sessions & memory management - Automation (cron jobs) - MCP servers - Permissions - Usage tracking - Account: login/logout/version Also clarified Chat Commands section for in-chat /commands Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 829b3d0 commit e988a12

1 file changed

Lines changed: 67 additions & 1 deletion

File tree

README.md

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,70 @@ For Telegram: add `TELEGRAM_BOT_TOKEN` to `.env` and message your bot.
5050

5151
---
5252

53+
## CLI Commands
54+
55+
After installing, all commands start with `clodds`:
56+
57+
```bash
58+
# Core
59+
clodds start # Start the gateway
60+
clodds repl # Interactive local REPL
61+
clodds doctor # Run system diagnostics
62+
clodds status # Show system status
63+
clodds endpoints # Show webhook endpoints
64+
65+
# User Management
66+
clodds pairing list <channel> # List pending pairing requests
67+
clodds pairing approve <ch> <c> # Approve a pairing request
68+
clodds pairing users <channel> # List paired users
69+
clodds pairing add <ch> <user> # Add user to allowlist
70+
71+
# Configuration
72+
clodds config get [key] # Get config value
73+
clodds config set <key> <val> # Set config value
74+
clodds config path # Show config file path
75+
76+
# Skills & Extensions
77+
clodds skills list # List installed skills
78+
clodds skills search <query> # Search skill registry
79+
clodds skills install <slug> # Install a skill
80+
clodds skills update [slug] # Update skills
81+
82+
# Sessions & Memory
83+
clodds session list # List active sessions
84+
clodds session clear [id] # Clear session(s)
85+
clodds memory list <userId> # View user memories
86+
clodds memory clear <userId> # Clear memories
87+
88+
# Automation
89+
clodds cron list # List scheduled jobs
90+
clodds cron show <id> # Show job details
91+
clodds cron enable <id> # Enable a job
92+
clodds cron disable <id> # Disable a job
93+
94+
# MCP Servers
95+
clodds mcp list # List MCP servers
96+
clodds mcp add <name> <cmd> # Add MCP server
97+
clodds mcp test <name> # Test connection
98+
99+
# Permissions (sandboxed execution)
100+
clodds permissions list # Show permission rules
101+
clodds permissions allow <pat> # Add allow pattern
102+
clodds permissions pending # Show pending requests
103+
104+
# Usage Tracking
105+
clodds usage summary # Token usage summary
106+
clodds usage by-model # Usage by model
107+
clodds usage by-user # Usage by user
108+
109+
# Account
110+
clodds login # Authenticate
111+
clodds logout # Sign out
112+
clodds version # Show version
113+
```
114+
115+
---
116+
53117
## Everything We Built
54118

55119
### At a Glance
@@ -296,7 +360,9 @@ Edge: 7% (buy YES)
296360

297361
---
298362

299-
## Commands
363+
## Chat Commands
364+
365+
These commands work inside any chat interface (Telegram, Discord, WebChat, etc.):
300366

301367
### Opportunity Finding
302368
```

0 commit comments

Comments
 (0)