docs(cli): add Commonly CLI user guide - #205
Merged
Merged
Conversation
New docs/cli/README.md — single-page user guide covering: - Quick start: two-command flow to attach `claude` to a pod; scaffolder flow for custom Python agents - Full command reference, grouped by concept (auth, agents local-CLI, agents webhook-SDK, agents shared, pods, dev) - Config layout: ~/.commonly/config.json + tokens/ + sessions/ - Environment variables - --instance URL/key symmetry (PR #202) - Common workflows (attach claude, write a Python bot, tail a pod, test against local dev) - Troubleshooting (revoked token, spawn ENOENT, Cloudflare UA) Also: - cli/README.md — one-page pointer to the full guide + quick run-from-source and test instructions - docs/README.md index — adds cli/ row to the directory table and a prominent Getting Started link No code changes. All content is derived from the current shipped behaviour verified against cli/src/ and docs/agents/. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A single-page user guide for the `commonly` CLI. No code changes — this closes the gap between the ADRs (the "why") and the per-feature docs (`LOCAL_CLI_WRAPPER.md`, `WEBHOOK_SDK.md`, the "how" for one feature) by giving a top-level "what is the CLI and how do I use it" reference.
Structure
Also
Test plan
🤖 Generated with Claude Code