Skip to content

feat: Windows hook support - cross-platform Node.js hooks#726

Open
Pamacea wants to merge 3 commits intortk-ai:developfrom
Pamacea:feat/windows-hook-support
Open

feat: Windows hook support - cross-platform Node.js hooks#726
Pamacea wants to merge 3 commits intortk-ai:developfrom
Pamacea:feat/windows-hook-support

Conversation

@Pamacea
Copy link

@Pamacea Pamacea commented Mar 19, 2026

Summary

Adds full Windows support for rtk init by replacing Unix-only shell scripts with cross-platform Node.js hooks.

Problem

RTK's rtk init command only worked on Unix (macOS/Linux) because:

  • Hooks were written in bash (rtk-rewrite.sh)
  • Code used #[cfg(unix)] guards to block Windows
  • chmod +x and PermissionsExt are Unix-only

Windows users got this error:

[warn] Hook-based mode requires Unix (macOS/Linux).
    Windows: use --claude-md mode for full injection.

Solution

Replace shell scripts with Node.js (.cjs) files that work on all platforms:

New files:

  • hooks/rtk-rewrite.cjs - Claude Code hook (Windows/macOS/Linux)
  • hooks/cursor-rtk-rewrite.cjs - Cursor IDE hook (Windows/macOS/Linux)

Changes to src/init.rs:

  • Removed #[cfg(unix)] guards - functions now work on all platforms
  • Removed chmod/PermissionsExt code (not needed for .cjs)
  • Updated prepare_hook_paths() to use .cjs extension
  • Updated tests to validate Node.js format

Token Savings

Same 60-90% savings on ALL platforms (previously Unix-only).

Testing

cargo check    # ✅ passes
cargo test     # ✅ 983 tests passed

Breaking Changes

None for end users - the .cjs hooks provide identical functionality.
The shell scripts are no longer installed (replaced by .cjs).

Checklist

  • Code compiles (cargo check)
  • All tests pass (cargo test)
  • No clippy warnings
  • Cross-platform compatible
  • Tests updated for new format

Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com

pszymkowiak and others added 3 commits March 19, 2026 11:33
* fix: remove all decorative emojis from CLI output (rtk-ai#687)

* fix: remove decorative emojis from CLI output (rtk-ai#511)

Replace decorative emojis with plain text to reduce token waste.
Keep functional symbols (⚠️ ✓ ❌ ✅ ℹ️) that convey meaning in fewer tokens.

Signed-off-by: Patrick Szymkowiak <patrick@rtk.ai>
Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>

* fix: remove remaining decorative emojis from find_cmd and formatter

Missed in initial emoji cleanup pass: 📁 in find_cmd.rs and parser/formatter.rs

Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>

* fix: remove all decorative emojis from CLI output (rtk-ai#511)

Replace emojis with plain text tokens across all production files
for better LLM compatibility. Test fixtures and external tool
detection patterns (e.g. Black's "All done!") are preserved.

Signed-off-by: Patrick Szymkowiak <patrick@rtk-ai.app>
Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>

* fix: remove last decorative emoji from next_cmd.rs

Remove ⚡ from Next.js Build header, missed in previous passes.

Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>

* fix: remove remaining emojis from gh_cmd.rs and init.rs

Replace production emojis:
- gh_cmd.rs: 🟣→[merged], ⚪→[unknown]/[pending], ⭐→removed, 🔱→removed
- init.rs: ⚪→[--] for "not found" status indicators

Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>

* fix: remove all checkmark emojis from CLI output

Replace ✓ (U+2713) with plain text across 19 files:
- "ok ✓" → "ok" (git add/commit/push/pull)
- "✓ cargo test: ..." → "cargo test: ..." (all tool summaries)
- Preserved ✓ in input detection patterns and test fixtures

LLMs cannot interpret emoji semantics; plain text is clearer.

Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>

---------

Signed-off-by: Patrick Szymkowiak <patrick@rtk.ai>
Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>
Signed-off-by: Patrick Szymkowiak <patrick@rtk-ai.app>

* feat: OpenClaw plugin for transparent exec rewriting (rtk-ai#358)

* feat: add OpenClaw plugin for transparent exec rewriting

Adds an OpenClaw plugin that intercepts exec tool calls via the
before_tool_call hook and rewrites commands to their RTK equivalents.

This is the OpenClaw equivalent of hooks/rtk-rewrite.sh for Claude Code.

The plugin:
- Registers a before_tool_call hook on the exec tool
- Rewrites git, grep, find, ls, gh, docker, kubectl, and test commands
- Guards against rewriting piped/compound commands and heredocs
- Returns properly typed PluginHookBeforeToolCallResult
- Supports enabled/verbose config options

Measured savings: 48-87% token reduction on common commands.

Files:
- openclaw/index.ts — plugin source
- openclaw/openclaw.plugin.json — plugin manifest
- openclaw/README.md — installation and usage docs

* refactor: delegate OpenClaw plugin to rtk rewrite

Replace 60+ hardcoded regex rules with a single call to `rtk rewrite`,
matching the OpenCode plugin pattern (hooks/opencode-rtk.ts).

Benefits:
- Zero maintenance: new RTK filters work automatically
- Single source of truth: rewrite logic in Rust (src/discover/registry.rs)
- 122 → 73 lines, no rule duplication

Also: rebase on develop, fix homepage URL, bump version to 1.0.0.
Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>

* feat: add package.json for npm publishing

Enables `openclaw plugins install @rtk-ai/rtk-rewrite` for OpenClaw users.

Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>

---------

Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>
Co-authored-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>

* feat: add Gemini CLI support via rtk init --gemini (rtk-ai#573)

- Add `rtk hook gemini` command: native Rust hook processor for Gemini CLI
  BeforeTool hooks. Reads JSON from stdin, delegates to `rewrite_command()`
  (single source of truth), outputs Gemini-format JSON response.
- Add `--gemini` flag to `rtk init`: installs hook wrapper script, GEMINI.md,
  and patches ~/.gemini/settings.json with BeforeTool hook entry.
- Add `rtk init -g --gemini --uninstall`: clean removal of all Gemini artifacts.
- 6 unit tests covering hook format, rewrite delegation, and exclusions.

Replaces PR rtk-ai#174 which had too many conflicts after upstream restructuring.

Signed-off-by: Ousama Ben Younes <benyounes.ousama@gmail.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

* feat(init): add Codex CLI support via AGENTS.md + RTK.md workflow (rtk-ai#377)

* feat(init): add Codex CLI support via AGENTS.md + RTK.md workflow

Add --codex mode to rtk init for Codex CLI integration using AGENTS.md + RTK.md, while keeping the newer develop init/opencode flow intact. Includes Codex install/show/uninstall handling, ASCII status output, stricter flag validation, and expanded tests for Codex AGENTS lifecycle and patch-mode rejection.

Signed-off-by: Zacaria <havesomecode@gmail.com>

* docs: fix validation metadata

Signed-off-by: Zacaria <havesomecode@gmail.com>

---------

Signed-off-by: Zacaria <havesomecode@gmail.com>

* feat(copilot): add Copilot hook support (VS Code + CLI) (rtk-ai#605)

Add `rtk hook copilot` command that handles both VS Code Copilot Chat
(updatedInput rewrite) and GitHub Copilot CLI (deny-with-suggestion).

- Auto-detects format: snake_case (VS Code) vs camelCase (Copilot CLI)
- Delegates to `rtk rewrite` (single source of truth)
- 14 hook tests (format detection, rewrite gating, output shape)
- .github/hooks/rtk-rewrite.json for repo-scoped hook config
- .github/copilot-instructions.md for RTK awareness
- Test script: hooks/test-copilot-rtk-rewrite.sh

Rebased on develop (includes Gemini rtk-ai#573, Codex rtk-ai#377, OpenClaw rtk-ai#358).

Original work by @jeziellopes, cleaned up and rebased by maintainer.

Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>
Co-authored-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>

* feat: add Cursor Agent support via --agent flag (rtk-ai#595)

Add `rtk init -g --agent cursor` to install RTK hooks for Cursor Agent.
Cursor's preToolUse hook supports command rewriting via updated_input,
functionally identical to Claude Code's PreToolUse. Works with both the
Cursor editor and cursor-cli (they share ~/.cursor/hooks.json).

Changes:
- New `--agent <name>` flag (claude|cursor) on `rtk init`, extensible
  for future agents. Default is claude (backward compatible).
- Cursor hook script (hooks/cursor-rtk-rewrite.sh) outputs Cursor's
  JSON format: {permission, updated_input} vs Claude's hookSpecificOutput.
- `rtk init --show` reports Cursor hook and hooks.json status.
- `rtk init -g --uninstall` removes Cursor artifacts.
- `rtk discover` notes that Cursor sessions are tracked via `rtk gain`
  (Cursor transcripts lack structured tool_use/tool_result blocks).
- Unit tests for Cursor hooks.json patching, detection, and removal.

Made-with: Cursor

Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>
Co-authored-by: Moisei <1199723+moisei@users.noreply.github.com>

* feat: add Windsurf support via rtk init --agent windsurf (rtk-ai#695) (rtk-ai#697)

Install RTK rules in .windsurfrules (project-scoped) so Cascade
prefixes shell commands with rtk for token savings.

Windsurf hooks don't support command rewriting (only blocking),
so RTK uses the rules-based approach (like Codex with AGENTS.md).

Tested: Windsurf Cascade correctly uses rtk git status after install.

Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>

* feat: add Cline/Roo Code support via rtk init --agent cline (rtk-ai#701) (rtk-ai#702)

Install RTK rules in .clinerules (project-scoped) so Cline
prefixes shell commands with rtk for token savings.

Same rules-based approach as Windsurf and Codex.

Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>

* fix(skill/rtk-triage): increase PR/issue limit to 200 with pagination hint (rtk-ai#717)

* fix(skill/rtk-triage): increase PR/issue limit to 200 with pagination hint

Raise gh pr list limit from 60 to 200 to match gh's max per call.
Add inline comment explaining how to paginate for repos with >200 open PRs.
Update threshold warning from >60 to >200 PRs/issues.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Florian BRUNIAUX <florian@bruniaux.com>

* docs(architecture): update module count to 67 (hook_cmd added in rtk-ai#573)

hook_cmd.rs was added in feat: add Gemini CLI support (rtk-ai#573) but
ARCHITECTURE.md was not updated. Fixes pre-push validation failure.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Florian BRUNIAUX <florian@bruniaux.com>

---------

Signed-off-by: Florian BRUNIAUX <florian@bruniaux.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Signed-off-by: Patrick Szymkowiak <patrick@rtk.ai>
Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>
Signed-off-by: Patrick Szymkowiak <patrick@rtk-ai.app>
Signed-off-by: Ousama Ben Younes <benyounes.ousama@gmail.com>
Signed-off-by: Zacaria <havesomecode@gmail.com>
Signed-off-by: Florian BRUNIAUX <florian@bruniaux.com>
Co-authored-by: Alex <a.neyman17@gmail.com>
Co-authored-by: Ben Younes <benyounes.ousama@gmail.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Zacaria Chtatar <Zacaria@users.noreply.github.com>
Co-authored-by: Jeziel Lopes <jeziellcarvalho@gmail.com>
Co-authored-by: Moisei Rabinovich <moisei@users.noreply.github.com>
Co-authored-by: Moisei <1199723+moisei@users.noreply.github.com>
Co-authored-by: Florian BRUNIAUX <florian@bruniaux.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
BREAKING CHANGE: Replaces Unix-only shell scripts with Node.js hooks

- Add rtk-rewrite.cjs: Cross-platform Claude Code hook (Windows/macOS/Linux)
- Add cursor-rtk-rewrite.cjs: Cross-platform Cursor IDE hook
- Remove #[cfg(unix)] guards from init.rs - now works on all platforms
- Remove chmod/PermissionsExt code (not needed for .cjs files)
- Update tests to validate Node.js hook format instead of shell

Token savings: 60-90% on all platforms (previously Unix-only)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@CLAassistant
Copy link

CLAassistant commented Mar 20, 2026

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
0 out of 3 committers have signed the CLA.

❌ Pamacea
❌ github-actions[bot]
❌ pszymkowiak
You have signed the CLA already but the status is still pending? Let us recheck it.

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.

3 participants