Thanks to visit codestin.com
Credit goes to github.com

Skip to content

CLAUDE.md

Latest commit

 

History

History
42 lines (32 loc) · 2.88 KB

CLAUDE.md

File metadata and controls

42 lines (32 loc) · 2.88 KB

Kaku

Kaku is a macOS-native terminal emulator derived from WezTerm and tuned for AI-assisted terminal work.

Agent Entry Points

  • Read AGENTS.md first for the repository map, subsystem guides, risk areas, and verification matrix.
  • Read the nearest crate-level AGENTS.md before changing code inside a crate.
  • Use .claude/skills/maintainer-sweep/SKILL.md for GitHub issue/PR sweeps, CI-gated pushes, public replies, and closure decisions.
  • Keep private release credentials, local keychain setup, and machine-specific runbooks out of tracked documentation.

Common Commands

make fmt-check
make check
make test
make app
./scripts/build.sh
./scripts/check_release_notes.sh
./scripts/check_release_config.sh
./scripts/check_config_release_readiness.sh

make fmt requires nightly Rust. Use make app when the change touches GUI, rendering, windowing, input, or AI overlay behavior.

Project-Specific Rules

  • AI chat and shell flows are core product surfaces. Before changing kaku-gui/src/ai_*, ai_chat_engine/, cli_chat/, or overlay/ai_chat/, read kaku-gui/AGENTS.md.
  • Config release work currently uses config_version: 22. Schema changes must update bundled defaults, docs, release checks, and migration behavior together. v21 adds smart_tab_mode, introduces the optional SmartPrompt value for window_close_confirmation (default stays NeverPrompt), and accepts the removed language option as a deprecated field for backward compat. v22 adds a precmd guard so the dark-theme comment color override still applies when the user pre-loads fast-syntax-highlighting or zsh-syntax-highlighting in their own .zshrc.
  • Startup performance depends on shell user-var caching, Lua bytecode, early appearance queries, GLSL version detection, and bundled font caching. Measure before invalidating those paths.
  • Notification actions that call back into Kaku must resolve bundled executables relative to the running app.
  • macOS menu and window changes need runtime validation in the app bundle, not only a successful compile.
  • Review scorecards and diagnostic snapshots should be distilled into stable rules or verification gates before commit; do not keep dated reports as source-of-truth docs.
  • Maintainability cleanups must not silently add default-on UI, config, or workflow behavior. Split those changes or get explicit maintainer approval.

Git and Maintainer Flow

  • When the maintainer asks to commit or push, finish the requested git operation after the checks that match the change.
  • For multiple unrelated bugs, prefer one commit per issue or behavior. Use subjects such as fix(scope): #123 short summary when an issue number exists.
  • Public issue and PR replies should be drafted first unless the maintainer has already approved the wording, closure decision, and CI gate.
  • After pushing a fix to main, wait for the new GitHub Actions run to pass before posting fixed/closed replies.