README
¶
TODO(bootstrap): opener fragment, 80 chars max, in the writing-docs opener
register. TODO(bootstrap): at most one plain expansion sentence — see the
writing-docs skill's references/readme.md for the register and the skeleton.
Get started
brew install yasyf/tap/cc-guides
cc-guides hello
Without Homebrew
go install github.com/yasyf/cc-guides/cmd/cc-guides@latest
TODO(bootstrap): replace hello above with the real first command, then capture
the demo as a real run of that exact command. Default: a static terminal
screenshot via freeze, with the one-liner committed at docs/scripts/demo.sh.
When motion is the payoff (TUI, progress, multi-step flow): an animated SVG via
the cli-demo skill, with .cli-demo/demo.tape committed. No tooling: replace the
img line with a fenced output block.
Driving with an agent? Paste this:
Install cc-guides (`brew install yasyf/tap/cc-guides`) and TODO(bootstrap): the first concrete goal to hand an agent.
Use cases
TODO(bootstrap): 2-4 ### subsections, each named for a reader goal, shaped
before/after: one pain sentence, the exact command (or in-app flow), the real
outcome (output, demo image, or metric).
TODO(bootstrap): no docs site — carry the how-to and reference content inline
here, per the writing-docs skill's references/standalone-readme.md (no hard
length ceiling; <details> blocks and a visual break every 500-1000 words).
TODO(bootstrap): optional one-line Status: note (honest maturity), or delete this line.
Licensed under MIT.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
cc-guides
command
Command cc-guides: Canonical agent guides as a shipped Go binary — render AGENTS.md, CLAUDE.md, and shell artifacts from embedded, versioned fragments
|
Command cc-guides: Canonical agent guides as a shipped Go binary — render AGENTS.md, CLAUDE.md, and shell artifacts from embedded, versioned fragments |
|
internal
|
|
|
cli
Package cli builds the cobra command tree.
|
Package cli builds the cobra command tree. |
|
log
Package log configures the process-wide structured logger.
|
Package log configures the process-wide structured logger. |
|
version
Package version exposes the build version.
|
Package version exposes the build version. |