Skip to content

docs: sync CLAUDE.md with the current command surface - #27

Merged
colevels merged 1 commit into
mainfrom
docs/refresh-claude-md
Jul 19, 2026
Merged

docs: sync CLAUDE.md with the current command surface#27
colevels merged 1 commit into
mainfrom
docs/refresh-claude-md

Conversation

@colevels

Copy link
Copy Markdown
Owner

CLAUDE.md had drifted from the code since docs open and two-tier help landed. Documentation only — no source changes.

What was wrong

  • Error boundary — described as "four typed error classes"; it's nine. UpdateError, TabsInputError, ServeError, TabsPushError, and UsageError were all missing. Added the rule that a new class must be registered in the boundary's known list, since an unlisted one silently degrades to the generic message.
  • config.ts — claimed nothing else reads process.env for configuration. Not true: NO_COLOR (ui.ts), TABBREW_DEBUG (index.ts), and CLAUDE_CONFIG_DIR (agents.ts) are read at their use site. Named them as deliberate exceptions rather than weakening the rule.
  • tabs subsystem — called offline, "touches neither config nor the network." serve/push read config.serve. Reworded to "never talks to the TabBrew server," which is the invariant that actually matters.
  • docs open <id> — entirely undocumented. Added the list-and-find approach (there is no per-id endpoint), the shared viewUrl() local-vs-cloud split, and the relationship to docs list's OSC 8 clickable titles, for which docs open is the fallback.
  • registry.ts — no mention of two-tier help (help --all, hidden, COMMON_ENV/DEV_ENV). Also flagged that the env tables live in three places with no generator.
  • Configuration table — missing TABBREW_SERVE_PORT, TABBREW_TABS_PATH, CLAUDE_CONFIG_DIR.
  • Project layout — missing table.test.ts; docs.ts now split out with its subcommands.

Releasing, Build, and the cross-repo notes were checked and left alone — they still match reality (v0.5.3, Bun pinned at 1.3.5 in both workflows).

🤖 Generated with Claude Code

CLAUDE.md had drifted since `docs open` and two-tier help landed:

- error boundary listed four typed error classes; there are nine
- `config.ts` was described as the only reader of process.env, but
  NO_COLOR / TABBREW_DEBUG / CLAUDE_CONFIG_DIR are read at their use site
- `tabs` was called config-free, though serve/push read config.serve
- `docs open` and `docs list`'s OSC 8 clickable titles were undocumented
- registry.ts said nothing about `help --all`, `hidden`, or the env tables
- Configuration table missed TABBREW_SERVE_PORT / TABBREW_TABS_PATH /
  CLAUDE_CONFIG_DIR; layout missed table.test.ts

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@colevels
colevels merged commit d19a61d into main Jul 19, 2026
1 check passed
@colevels
colevels deleted the docs/refresh-claude-md branch July 19, 2026 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant