Skip to content

Document codedb hook setup#344

Merged
justrach merged 1 commit intorelease/0.2.579from
docs/hooks-labs
Apr 27, 2026
Merged

Document codedb hook setup#344
justrach merged 1 commit intorelease/0.2.579from
docs/hooks-labs

Conversation

@justrach
Copy link
Copy Markdown
Owner

Summary

  • Clarifies that codedb_remote uses api.wiki.codes as the only remote backend and updates the MCP tool description accordingly.
  • Adds docs/hooks-labs.md with Codex and Claude Code hook setup examples, including a guard for unbounded remote tree calls.
  • Makes installer output show the exact codedb mcp command and where Codex/Claude hook configs live; mirrors the copy into website source and tracked dist files.

Validation

  • bash -n install/install.sh && bash -n website/app/install_script.sh && bash -n website/dist/install.sh
  • zig build test
  • zig build
  • raw MCP tools/list smoke confirmed the updated codedb_remote description
  • raw MCP codedb_remote smoke against tigerbeetle/tigerbeetle returned the compact tree summary from api.wiki.codes

Note: zig build serve -- --prerender inside website/ is currently blocked by the website build script under local Zig 0.16 API changes, so the tracked dist copy was updated directly for this text-only change.

@github-actions
Copy link
Copy Markdown

Benchmark Regression Report

Thresholds: 10.00% and 50,000 ns absolute delta

NOISE means the percentage threshold was exceeded, but the absolute delta was too small to fail CI.

Tool Base (ns) Head (ns) Delta Abs Delta (ns) Status
codedb_bundle 321022 324925 +1.22% +3903 OK
codedb_changes 30731 34438 +12.06% +3707 NOISE
codedb_deps 5004 5111 +2.14% +107 OK
codedb_edit 4093 5211 +27.31% +1118 NOISE
codedb_find 45045 42936 -4.68% -2109 OK
codedb_hot 55209 55536 +0.59% +327 OK
codedb_outline 165493 169587 +2.47% +4094 OK
codedb_read 55385 57981 +4.69% +2596 OK
codedb_search 143360 139076 -2.99% -4284 OK
codedb_snapshot 185881 185285 -0.32% -596 OK
codedb_status 239710 235844 -1.61% -3866 OK
codedb_symbol 37244 38716 +3.95% +1472 OK
codedb_tree 27003 28791 +6.62% +1788 OK
codedb_word 44436 43749 -1.55% -687 OK

@justrach justrach merged commit 7782476 into release/0.2.579 Apr 27, 2026
1 check passed
@justrach justrach deleted the docs/hooks-labs branch April 27, 2026 11:33
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 1e2c094fc9

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread install/install.sh
printf " ${D}codex${N} enable [features].codex_hooks in ~/.codex/config.toml\n"
printf " ${D}codex paths${N} ~/.codex/hooks.json or <repo>/.codex/hooks.json\n"
printf " ${D}claude paths${N} ~/.claude/settings.json or <repo>/.claude/settings.json\n"
printf " ${D}examples${N} https://github.com/justrach/codedb/blob/release/0.2.579/docs/hooks-labs.md\n"
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Build hook-doc URL from the installed version

The installer computes version dynamically, but this note hard-codes release/0.2.579 for the hook examples. As soon as users install a newer release, the printed URL can become stale (or disappear), so the setup guidance no longer matches the binary they just installed. Please derive this link from $version (or use a stable docs URL); the same hard-coded line is mirrored in the website installer copies.

Useful? React with 👍 / 👎.

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