* CLAUDE.md: project layout, key conventions, where to look first. Captures the non-obvious things a future session needs. * CONTRIBUTING.md: build/test workflow, how to add a subcommand (concrete walkthrough), code style. * CHANGELOG.md: history. 0.1.0 entry covers initial feature set; Unreleased captures stability + optimization batch. * docs/architecture.md: module graph, layering rules, the HTTP funnel, pager + SIGINT, repo resolution, test strategy. * docs/jq.md: --jq syntax cheatsheet (dot paths, brackets, negative indices, pipes, what's not supported). * docs/troubleshooting.md: keychain re-prompts, debug logging, pager opt-out, alias precedence, hook bypass, common 401s. * README.md: links into docs/ and updates binary size to 4 MB. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
12 lines
537 B
Markdown
12 lines
537 B
Markdown
# `fj` documentation
|
|
|
|
- [`architecture.md`](architecture.md) — module graph, layering rules,
|
|
the HTTP funnel, pager + SIGINT, repo resolution, test strategy.
|
|
- [`jq.md`](jq.md) — the `fj api --jq` syntax. Dot paths, brackets,
|
|
negative indices, pipes.
|
|
- [`troubleshooting.md`](troubleshooting.md) — keychain prompts, hangs,
|
|
401 errors, `--debug`, pager opt-out, alias precedence, hook bypass.
|
|
|
|
For build/test workflow see [`../CONTRIBUTING.md`](../CONTRIBUTING.md).
|
|
For project conventions see [`../CLAUDE.md`](../CLAUDE.md).
|