diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml index 393f9e500e..3ba6496f18 100644 --- a/.github/workflows/cd.yml +++ b/.github/workflows/cd.yml @@ -79,7 +79,7 @@ jobs: exit 1 fi - echo "tag=$TAG" >> $GITHUB_OUTPUT + echo "tag=$TAG" >> "$GITHUB_OUTPUT" build-prerelease: name: Build pre-release diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 79b667c02c..142bf84599 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -180,7 +180,7 @@ jobs: if [ -z "$TAG" ]; then TAG="${{ github.event.release.tag_name }}" fi - echo "version=$TAG" >> $GITHUB_OUTPUT + echo "version=$TAG" >> "$GITHUB_OUTPUT" - name: Flatten artifacts run: | @@ -224,7 +224,7 @@ jobs: if [ -z "$TAG" ]; then TAG="${{ github.event.release.tag_name }}" fi - echo "tag=$TAG" >> $GITHUB_OUTPUT + echo "tag=$TAG" >> "$GITHUB_OUTPUT" - name: Send Discord notification env: @@ -259,8 +259,8 @@ jobs: TAG="${{ github.event.release.tag_name }}" fi VERSION="${TAG#v}" - echo "tag=$TAG" >> $GITHUB_OUTPUT - echo "version=$VERSION" >> $GITHUB_OUTPUT + echo "tag=$TAG" >> "$GITHUB_OUTPUT" + echo "version=$VERSION" >> "$GITHUB_OUTPUT" - name: Download checksums run: | @@ -273,10 +273,10 @@ jobs: - name: Parse checksums id: sha run: | - echo "mac_arm=$(grep aarch64-apple-darwin.tar.gz checksums.txt | head -1 | awk '{print $1}')" >> $GITHUB_OUTPUT - echo "mac_intel=$(grep x86_64-apple-darwin.tar.gz checksums.txt | head -1 | awk '{print $1}')" >> $GITHUB_OUTPUT - echo "linux_arm=$(grep aarch64-unknown-linux-gnu.tar.gz checksums.txt | head -1 | awk '{print $1}')" >> $GITHUB_OUTPUT - echo "linux_intel=$(grep x86_64-unknown-linux-musl.tar.gz checksums.txt | head -1 | awk '{print $1}')" >> $GITHUB_OUTPUT + echo "mac_arm=$(grep aarch64-apple-darwin.tar.gz checksums.txt | head -1 | awk '{print $1}')" >> "$GITHUB_OUTPUT" + echo "mac_intel=$(grep x86_64-apple-darwin.tar.gz checksums.txt | head -1 | awk '{print $1}')" >> "$GITHUB_OUTPUT" + echo "linux_arm=$(grep aarch64-unknown-linux-gnu.tar.gz checksums.txt | head -1 | awk '{print $1}')" >> "$GITHUB_OUTPUT" + echo "linux_intel=$(grep x86_64-unknown-linux-musl.tar.gz checksums.txt | head -1 | awk '{print $1}')" >> "$GITHUB_OUTPUT" - name: Generate formula run: | diff --git a/.gitignore b/.gitignore index fdba097836..2186e54d84 100644 --- a/.gitignore +++ b/.gitignore @@ -46,3 +46,5 @@ claudedocs # icm .fastembed_cache/ +.serena/ +excalidraw.log diff --git a/.project-hooks/pre-commit b/.project-hooks/pre-commit new file mode 100755 index 0000000000..f64cbca22b --- /dev/null +++ b/.project-hooks/pre-commit @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Force tracking tests to use a writable temp DB path during hook execution. +tmp_db="$(mktemp /tmp/rtk-precommit-db.XXXXXX.sqlite3)" +trap 'rm -f "$tmp_db"' EXIT + +RTK_DB_PATH="$tmp_db" cargo test diff --git a/.shipguard.yml b/.shipguard.yml new file mode 100644 index 0000000000..4ba8a67268 --- /dev/null +++ b/.shipguard.yml @@ -0,0 +1,40 @@ +# ShipGuard configuration +# Reviewed 2026-04-01 — celstnblacc/rtk fork of rtk-ai/rtk +# All findings here are pre-existing upstream issues, not introduced by this fork. + +severity_threshold: medium + +exclude_paths: + - "vendor/**" + - "node_modules/**" + - "**/fixtures/**" + - "**/__snapshots__/**" + # Installer and test/developer scripts — not production code + - "scripts/**" + # SHELL-005 false positive: ${GREEN}/${NC} ANSI color vars in printf format strings + # are flagged as JSON variable interpolation — they are not JSON + - "install.sh" + # Claude Code hook files — SHELL-002 false positives: $updated inside jq + # single-quoted filter strings is a jq variable, not a shell variable + - ".claude/**" + # Hook test harnesses — SHELL-005 false positives: echo "$input_json" | bash "$HOOK" + # pipes pre-constructed test fixtures, not user-controlled JSON being built via interpolation + - "hooks/*/test-*.sh" + +# Accepted risks (reviewed 2026-04-01) +disable_rules: + # GHA-002: Unpinned GitHub Actions — upstream workflow files, not owned by this fork + - GHA-002 + # GHA-005: PR head checkout — upstream CI pattern, no sensitive secrets in CI + - GHA-005 + # SC-004: .gitignore advisory — tracked separately in repo root .gitignore + - SC-004 + # SC-005: Docker image signing — dev-tool CLI, not a production pipeline + - SC-005 + # SC-003: No frozen lockfile — test scripts only, no production dependency resolution here + - SC-003 + # SHELL-002: Unquoted variable flagged in hooks/claude/rtk-rewrite.sh:83,95 + # FALSE POSITIVE — `$updated` appears inside single-quoted jq filter strings (e.g. '{...}'). + # Single quotes prevent shell expansion; `$updated` is a jq variable injected via + # --argjson, not a shell variable. The shell cannot expand it. Confirmed 2026-04-01. + - SHELL-002 diff --git a/.superharness/.gitignore b/.superharness/.gitignore new file mode 100644 index 0000000000..450ce45eeb --- /dev/null +++ b/.superharness/.gitignore @@ -0,0 +1,4 @@ +.dashboard_auth_token +trace.jsonl +session-progress.md +watcher.heartbeat diff --git a/.superharness/contract.yaml b/.superharness/contract.yaml new file mode 100644 index 0000000000..ceb1974c4c --- /dev/null +++ b/.superharness/contract.yaml @@ -0,0 +1,21 @@ +# Active contract for rtk +id: initial-setup +created: 2026-03-31 +created_by: owner +status: draft + +goal: "TBD — describe the current objective" + +tasks: [] + +decisions: [] + +failures: [] + +# Task schema (recommended): +# tasks: +# - id: "task-id" +# title: "Task title" +# status: "todo|in_progress|done" +# owner: "claude-code|codex-cli" +# project_path: "/Users/airm2max/DevOpsSec/rtk" diff --git a/.superharness/decisions.yaml b/.superharness/decisions.yaml new file mode 100644 index 0000000000..164953588f --- /dev/null +++ b/.superharness/decisions.yaml @@ -0,0 +1,11 @@ +# Cross-agent decision records (ADR-lite) +# Both Claude Code and Codex CLI read/write this file. +# Format: +# - id: "short-kebab-id" +# what: "decision title" +# why: "rationale" +# alternatives: ["alt1", "alt2"] +# date: YYYY-MM-DD +# by: claude-code | codex-cli | owner +# status: accepted | superseded | deprecated +decisions: [] diff --git a/.superharness/failures.yaml b/.superharness/failures.yaml new file mode 100644 index 0000000000..2898d5b832 --- /dev/null +++ b/.superharness/failures.yaml @@ -0,0 +1,11 @@ +# Cross-agent failure memory +# Both Claude Code and Codex CLI read/write this file. +# Format: +# - what: "brief description" +# why_failed: "root cause" +# date: YYYY-MM-DD +# agent: claude-code | codex-cli +# tech: "technology/library involved" +# severity: minor | major | critical +# promoted: false # set true when added to CLAUDE.md/AGENTS.md "Do Not" section +failures: [] diff --git a/.superharness/features.json b/.superharness/features.json new file mode 100644 index 0000000000..03bb786100 --- /dev/null +++ b/.superharness/features.json @@ -0,0 +1,34 @@ +{ + "features": [ + { + "id": "project-builds", + "category": "core", + "description": "Project builds without errors", + "steps": [ + "Run the build command", + "Verify no errors in output" + ], + "passes": false + }, + { + "id": "tests-pass", + "category": "core", + "description": "All tests pass", + "steps": [ + "Run the test suite", + "Verify all tests green" + ], + "passes": false + }, + { + "id": "cli-entry-point", + "category": "cli", + "description": "CLI entry point works", + "steps": [ + "Run the CLI with --help or --version", + "Verify output" + ], + "passes": false + } + ] +} diff --git a/.superharness/ledger.md b/.superharness/ledger.md new file mode 100644 index 0000000000..21454acb3d --- /dev/null +++ b/.superharness/ledger.md @@ -0,0 +1,188 @@ +# Ledger — rtk + +Append-only activity log. Never edit previous entries. +2026-03-31T12:42:54Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-03-31T12:43:40Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-03-31T12:44:08Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-03-31T12:46:04Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-03-31T12:46:39Z — claude-code — modified: benchmark.sh +- 2026-03-31T12:46:43Z — claude-code — modified: benchmark.sh +2026-03-31T12:48:45Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-03-31T13:05:43Z — claude-code — modified: CHANGELOG.md +2026-03-31T13:07:36Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-03-31T13:09:02Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-03-31T13:10:07Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-03-31T13:50:06Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-03-31T13:51:35Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-03-31T23:45:20Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-03-31T23:50:29Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-03-31T23:54:10Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-03-31T23:56:19Z — claude-code — modified: token-tools-comparison.md +2026-03-31T23:56:22Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T10:34:03Z — claude-code — modified: install-token-stack.sh +- 2026-04-01T10:34:37Z — claude-code — modified: Install-TokenStack.ps1 +- 2026-04-01T10:35:10Z — claude-code — modified: token-stack.ansible.yml +2026-04-01T10:36:08Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T10:37:36Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T10:38:43Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T10:39:41Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T10:40:38Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T10:41:56Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T10:42:44Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T10:43:22Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T10:43:56Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T10:44:56Z — claude-code — modified: README.md +- 2026-04-01T10:44:56Z — claude-code — modified: .gitignore +- 2026-04-01T10:45:02Z — claude-code — modified: serena-dedup.template.yml +- 2026-04-01T10:46:03Z — claude-code — modified: install.sh +- 2026-04-01T10:46:49Z — claude-code — modified: Install.ps1 +- 2026-04-01T10:47:26Z — claude-code — modified: playbook.yml +2026-04-01T10:47:48Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T10:48:50Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T10:49:46Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T10:50:59Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T10:51:45Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T10:53:37Z — claude-code — modified: .gitmodules +- 2026-04-01T10:53:37Z — claude-code — modified: README.md +- 2026-04-01T10:53:53Z — claude-code — modified: Dockerfile.serena +- 2026-04-01T10:53:58Z — claude-code — modified: compose.yml +- 2026-04-01T10:54:31Z — claude-code — modified: build.sh +- 2026-04-01T10:55:52Z — claude-code — modified: install.sh +- 2026-04-01T10:56:05Z — claude-code — modified: SBOM.template.json +- 2026-04-01T10:56:13Z — claude-code — modified: LICENSE-THIRD-PARTY.md +- 2026-04-01T10:56:33Z — claude-code — modified: security-audit.md +- 2026-04-01T10:57:10Z — claude-code — modified: README.md +- 2026-04-01T10:57:16Z — claude-code — modified: .gitignore +2026-04-01T10:57:43Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T10:59:52Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T11:04:42Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T11:08:30Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T11:11:19Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T11:13:28Z — claude-code — modified: .gitmodules +2026-04-01T11:13:37Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T11:13:53Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T11:20:10Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T11:20:34Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T11:22:10Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T11:22:46Z — claude-code — modified: feedback_model_routing.md +- 2026-04-01T11:22:54Z — claude-code — modified: MEMORY.md +2026-04-01T11:22:57Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T11:23:25Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T11:24:13Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T11:25:51Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T11:26:40Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T11:27:57Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T11:28:48Z — claude-code — modified: model-router.md +- 2026-04-01T11:28:52Z — claude-code — modified: model-router.md +2026-04-01T11:28:59Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T11:35:11Z — claude-code — modified: runner.rs +- 2026-04-01T11:35:23Z — claude-code — modified: Cargo.toml +- 2026-04-01T11:35:29Z — claude-code — modified: utils.rs +- 2026-04-01T11:35:37Z — claude-code — modified: runner.rs +- 2026-04-01T11:35:45Z — claude-code — modified: runner.rs +- 2026-04-01T11:35:50Z — claude-code — modified: runner.rs +- 2026-04-01T11:35:55Z — claude-code — modified: summary.rs +- 2026-04-01T11:36:00Z — claude-code — modified: summary.rs +- 2026-04-01T11:37:35Z — claude-code — modified: runner.rs +- 2026-04-01T11:37:46Z — claude-code — modified: runner.rs +- 2026-04-01T11:37:54Z — claude-code — modified: runner.rs +- 2026-04-01T11:37:59Z — claude-code — modified: runner.rs +- 2026-04-01T11:38:04Z — claude-code — modified: summary.rs +- 2026-04-01T11:38:09Z — claude-code — modified: summary.rs +- 2026-04-01T11:39:22Z — claude-code — modified: summary.rs +- 2026-04-01T11:40:19Z — claude-code — modified: cc_economics.rs +- 2026-04-01T11:40:24Z — claude-code — modified: git.rs +- 2026-04-01T11:42:15Z — claude-code — modified: config.rs +- 2026-04-01T11:42:20Z — claude-code — modified: utils.rs +- 2026-04-01T11:42:27Z — claude-code — modified: report.rs +- 2026-04-01T11:44:07Z — claude-code — modified: utils.rs +- 2026-04-01T11:44:29Z — claude-code — modified: gt_cmd.rs +- 2026-04-01T11:44:34Z — claude-code — modified: gt_cmd.rs +- 2026-04-01T11:44:39Z — claude-code — modified: gt_cmd.rs +- 2026-04-01T11:44:57Z — claude-code — modified: main.rs +- 2026-04-01T11:45:01Z — claude-code — modified: main.rs +- 2026-04-01T11:45:06Z — claude-code — modified: main.rs +- 2026-04-01T11:45:11Z — claude-code — modified: main.rs +- 2026-04-01T11:45:15Z — claude-code — modified: main.rs +- 2026-04-01T11:45:24Z — claude-code — modified: gh_cmd.rs +- 2026-04-01T11:45:34Z — claude-code — modified: gh_cmd.rs +- 2026-04-01T11:45:42Z — claude-code — modified: gh_cmd.rs +- 2026-04-01T11:45:48Z — claude-code — modified: gh_cmd.rs +- 2026-04-01T11:45:57Z — claude-code — modified: git.rs +- 2026-04-01T11:46:01Z — claude-code — modified: git.rs +- 2026-04-01T11:46:10Z — claude-code — modified: git.rs +- 2026-04-01T11:46:13Z — claude-code — modified: git.rs +- 2026-04-01T11:46:21Z — claude-code — modified: git.rs +- 2026-04-01T11:47:04Z — claude-code — modified: git.rs +2026-04-01T11:50:10Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T11:54:42Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T11:57:47Z — claude-code — modified: security.rs +- 2026-04-01T11:57:54Z — claude-code — modified: error.rs +- 2026-04-01T11:57:59Z — claude-code — modified: error.rs +- 2026-04-01T11:58:03Z — claude-code — modified: error.rs +- 2026-04-01T11:58:10Z — claude-code — modified: lib.rs +- 2026-04-01T11:58:26Z — claude-code — modified: security.rs +- 2026-04-01T11:58:32Z — claude-code — modified: test_security.py +- 2026-04-01T11:58:43Z — claude-code — modified: security.rs +- 2026-04-01T11:58:58Z — claude-code — modified: test_security.py +- 2026-04-01T11:59:02Z — claude-code — modified: mcp.rs +- 2026-04-01T11:59:06Z — claude-code — modified: mcp.rs +- 2026-04-01T11:59:14Z — claude-code — modified: project.py +- 2026-04-01T11:59:15Z — claude-code — modified: mcp.rs +- 2026-04-01T11:59:22Z — claude-code — modified: mcp.rs +- 2026-04-01T11:59:32Z — claude-code — modified: shell.py +- 2026-04-01T11:59:39Z — claude-code — modified: shell.py +- 2026-04-01T12:00:03Z — claude-code — modified: security.rs +- 2026-04-01T12:00:21Z — claude-code — modified: security.rs +- 2026-04-01T12:00:38Z — claude-code — modified: main.rs +2026-04-01T12:00:54Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T12:00:56Z — claude-code — modified: lib.rs +- 2026-04-01T12:01:24Z — claude-code — modified: security.rs +- 2026-04-01T12:01:45Z — claude-code — modified: security.rs +- 2026-04-01T12:02:08Z — claude-code — modified: security.rs +- 2026-04-01T12:02:15Z — claude-code — modified: security.rs +- 2026-04-01T12:02:21Z — claude-code — modified: security.rs +- 2026-04-01T12:02:30Z — claude-code — modified: security.rs +- 2026-04-01T12:02:36Z — claude-code — modified: security.rs +- 2026-04-01T12:02:56Z — claude-code — modified: security.rs +2026-04-01T12:03:58Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T12:11:02Z — claude-code — modified: README.md +- 2026-04-01T12:11:15Z — claude-code — modified: README.md +- 2026-04-01T12:11:41Z — claude-code — modified: README.md +- 2026-04-01T12:14:16Z — claude-code — modified: CLAUDE.md +- 2026-04-01T12:19:10Z — claude-code — modified: utils.rs +2026-04-01T12:25:11Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T12:57:03Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T12:58:32Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T12:59:58Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T13:00:38Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T13:01:28Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T13:03:04Z — claude-code — modified: install.sh +- 2026-04-01T13:03:10Z — claude-code — modified: install.sh +- 2026-04-01T13:03:16Z — claude-code — modified: install.sh +2026-04-01T13:41:04Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T14:08:09Z — claude-code — modified: .shipguard.yml +- 2026-04-01T14:08:16Z — claude-code — modified: .shipguard.yml +- 2026-04-01T14:08:24Z — claude-code — modified: .shipguard.yml +- 2026-04-01T14:09:25Z — claude-code — modified: .shipguard.yml +- 2026-04-01T14:11:11Z — claude-code — modified: .shipguard.yml +- 2026-04-01T14:11:19Z — claude-code — modified: .shipguard.yml +- 2026-04-01T14:12:21Z — claude-code — modified: .shipguard.yml +- 2026-04-01T14:12:29Z — claude-code — modified: .shipguard.yml +- 2026-04-01T14:14:31Z — claude-code — modified: security.rs +- 2026-04-01T14:15:24Z — claude-code — modified: .gitignore +2026-04-01T14:15:41Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +2026-04-01T15:04:43Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T15:09:58Z — claude-code — modified: .shipguard.yml +- 2026-04-01T15:10:25Z — claude-code — modified: .shipguard.yml +2026-04-01T15:10:50Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T15:13:54Z — claude-code — modified: test_security.py +- 2026-04-01T15:14:03Z — claude-code — modified: .shipguard.yml +- 2026-04-01T15:16:13Z — claude-code — modified: test_security.py +- 2026-04-01T15:16:29Z — claude-code — modified: test_security.py +- 2026-04-01T15:17:44Z — claude-code — modified: .shipguard.yml +2026-04-01T15:18:11Z session-stop: snapshot written to session-progress.md (branch: fix/all-security) +- 2026-04-01T15:23:18Z — claude-code — modified: hashed-dreaming-teacup.md +- 2026-04-02T09:30:18Z — claude-code — modified: CLAUDE.md +2026-04-02T09:33:02Z session-stop: snapshot written to session-progress.md (branch: chore/add-scaffold-files-gitignore) +2026-04-02T09:33:18Z session-stop: snapshot written to session-progress.md (branch: chore/add-scaffold-files-gitignore) diff --git a/.superharness/session-progress.md b/.superharness/session-progress.md new file mode 100644 index 0000000000..164aa87439 --- /dev/null +++ b/.superharness/session-progress.md @@ -0,0 +1,26 @@ +# Session Progress + + + +## Task Context +No tasks found in contract. + +## Branch +chore/add-scaffold-files-gitignore + +## Uncommitted Changes + M .superharness/ledger.md + M .superharness/session-progress.md + M .superharness/watcher.heartbeat + +## Recent Commits +66f2611 chore: add superharness scaffold, AGENTS.md, SOUL.md; ignore .serena/ +89e26e4 fix(ci): quote \$GITHUB_OUTPUT in workflows; tighten .shipguard.yml +46edfba chore: add .shipguard.yml — acknowledge accepted risks (reviewed 2026-04-01) +ff52520 fix(security): SAST audit — shell injection, exit codes, lazy regex, telemetry default +cc306f8 chore: bump version to 0.34.3 + +## Note +This file was written automatically when the previous Claude Code session ended. +If the session was long and context was compacted, some nuance may have been lost. +Read .superharness/handoffs/ for the most authoritative cross-session state. diff --git a/.superharness/watcher.heartbeat b/.superharness/watcher.heartbeat new file mode 100644 index 0000000000..5b9f7673ed --- /dev/null +++ b/.superharness/watcher.heartbeat @@ -0,0 +1 @@ +2026-04-02T10:27:41Z diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000000..589fe097cc --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,17 @@ +# rtk + +## Identity +You are working for the project owner. + +## This Project +- What: rtk +- Stack: TBD +- Status: greenfield + +## Cross-Agent Protocol +- Read `.superharness/contract.yaml` before starting work. +- Keep task status, ledger, and handoff updated before stopping. + +## Strict Installation Decoupling + +Once installed (e.g., to ~/.local/bin), the project binary must NEVER depend on the local repository path (~/DevOpsSec) for execution, configuration, or data. All paths must be relative to the installation root or use standard system config paths (~/.config). diff --git a/CHANGELOG.md b/CHANGELOG.md index 5ed7ca6ab7..a989072f95 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,19 @@ All notable changes to rtk (Rust Token Killer) will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.34.2-security.1] (2026-03-31) — celstnblacc/rtk fork + +### Security + +* **permissions:** enforce Claude Code allow list — commands not on allowlist now return Ask instead of Allow (#886) +* **subprocess:** global stdin null on all 130+ subprocess calls — prevents hook pipe inheritance and kernel panic (#897) +* **telemetry:** stripped entirely — no more phoning home (deleted telemetry.rs, removed ureq/hostname/getrandom deps) + +### Fixed + +* **codex:** anchor RTK.md and AGENTS.md to git worktree root instead of bare relative paths (#892) +* **benchmark:** replace eval with bash -c to resolve SHELL-001 SAST findings + ## [0.34.2](https://github.com/rtk-ai/rtk/compare/v0.34.1...v0.34.2) (2026-03-30) @@ -801,3 +814,28 @@ See upstream: https://github.com/pszymkowiak/rtk - **Repository**: https://github.com/rtk-ai/rtk (maintained by pszymkowiak) - **Issues**: https://github.com/rtk-ai/rtk/issues +## [Unreleased] + +### Added +- Add a project-specific `.project-hooks/pre-commit` scaffold that runs `cargo test`. + +### Changed +- Configure Codex global instructions during `rtk init -g` so one global setup covers both Claude Code and Codex. +- Extend `rtk init --show`, installer messaging, and installation checks to report Codex integration. +- Move installation and localized README docs under `docs/` and update cross-links. + +## [0.34.3-security.1] (2026-04-01) — celstnblacc/rtk fork + +### Security + +* **shell-injection (C-1):** replace `sh -c` exec path with `shell_words::split()` + `Command::new(bin).args(rest)` in `run_err`/`run_test` — shell metacharacters in command strings can no longer spawn extra processes +* **exit-code propagation (C-2):** `run_err`/`run_test` now call `std::process::exit(code)` on non-zero child exit using `exit_code_from_output()`; returns `128 + signal` for signal-killed processes per Unix convention +* **lazy-regex (H-1):** compile `summary.rs` regexes once at startup via `lazy_static!` — eliminates per-call `Regex::new()` overhead +* **float-arithmetic (H-2):** fix divide-by-zero panic in `cc_economics.rs` `savings_blended` calculation +* **stash-subcommand (H-3):** replace infallible `subcommand.unwrap()` with `Some(sub @ (...))` pattern in `git.rs` +* **telemetry-default (M-1):** `TelemetryConfig::default()` now sets `enabled: false` — no opt-in required +* **cwd-fallback (M-2):** `resolved_command` CWD fallback uses `"."` instead of empty path on `current_dir()` failure +* **learn-unwrap (M-3):** remove `grouped.get(&base_cmd).unwrap()` panic path in `report.rs` with `let Some(...) else { continue }` +* **exit-code-propagation (L-2):** migrate all remaining `status.code().unwrap_or(1)` calls in `gh_cmd.rs`, `gt_cmd.rs`, `git.rs`, `main.rs` to `exit_code_from_status()` +- feat(doctor): add `rtk doctor` health check command (hook, DB, PATH, config, failure rate; --json output for token-diet integration) +- chore: add .superharness/.gitignore, GEMINI.md; propagate Strict Installation Decoupling rule to AGENTS.md and CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md index 0dddf14e55..33da564397 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -16,7 +16,7 @@ This is a fork with critical fixes for git argument parsing and modern JavaScrip **Verify correct installation:** ```bash -rtk --version # Should show "rtk 0.28.2" (or newer) +rtk --version # Should show "rtk 0.34.3" (or newer) rtk gain # Should show token savings stats (NOT "command not found") ``` @@ -167,3 +167,7 @@ When user provides a numbered plan (QW1-QW4, Phase 1-5, sprint tasks, etc.): 3. **Never skip or reorder**: If a step is blocked, report it and ask before proceeding 4. **Track progress**: Use task list (TaskCreate/TaskUpdate) for plans with 3+ steps 5. **Validate assumptions**: Before starting, verify all referenced file paths exist and working directory is correct + +## Strict Installation Decoupling + +Once installed (e.g., to ~/.local/bin), the project binary must NEVER depend on the local repository path (~/DevOpsSec) for execution, configuration, or data. All paths must be relative to the installation root or use standard system config paths (~/.config). diff --git a/Cargo.lock b/Cargo.lock index 49b7c1aef0..92e7476086 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -100,12 +100,6 @@ version = "1.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8" -[[package]] -name = "base64" -version = "0.22.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" - [[package]] name = "bitflags" version = "2.11.0" @@ -312,17 +306,6 @@ dependencies = [ "windows-sys 0.48.0", ] -[[package]] -name = "displaydoc" -version = "0.2.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "97369cbbc041bc366949bc74d34658d6cda5621039731c6310521892a3a20ae0" -dependencies = [ - "proc-macro2", - "quote", - "syn", -] - [[package]] name = "env_home" version = "0.1.0" @@ -385,15 +368,6 @@ version = "0.1.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d9c4f5dac5e15c24eb999c26181a6ca40b39fe946cbe4c263c7209467bc83af2" -[[package]] -name = "form_urlencoded" -version = "1.2.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cb4cb245038516f5f85277875cdaa4f7d2c9a0fa0468de06ed190163b1581fcf" -dependencies = [ - "percent-encoding", -] - [[package]] name = "generic-array" version = "0.14.7" @@ -480,17 +454,6 @@ version = "0.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea" -[[package]] -name = "hostname" -version = "0.4.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "617aaa3557aef3810a6369d0a99fac8a080891b68bd9f9812a1eeda0c0730cbd" -dependencies = [ - "cfg-if", - "libc", - "windows-link", -] - [[package]] name = "iana-time-zone" version = "0.1.65" @@ -515,114 +478,12 @@ dependencies = [ "cc", ] -[[package]] -name = "icu_collections" -version = "2.1.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4c6b649701667bbe825c3b7e6388cb521c23d88644678e83c0c4d0a621a34b43" -dependencies = [ - "displaydoc", - "potential_utf", - "yoke", - "zerofrom", - "zerovec", -] - -[[package]] -name = "icu_locale_core" -version = "2.1.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "edba7861004dd3714265b4db54a3c390e880ab658fec5f7db895fae2046b5bb6" -dependencies = [ - "displaydoc", - "litemap", - "tinystr", - "writeable", - "zerovec", -] - -[[package]] -name = "icu_normalizer" -version = "2.1.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5f6c8828b67bf8908d82127b2054ea1b4427ff0230ee9141c54251934ab1b599" -dependencies = [ - "icu_collections", - "icu_normalizer_data", - "icu_properties", - "icu_provider", - "smallvec", - "zerovec", -] - -[[package]] -name = "icu_normalizer_data" -version = "2.1.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7aedcccd01fc5fe81e6b489c15b247b8b0690feb23304303a9e560f37efc560a" - -[[package]] -name = "icu_properties" -version = "2.1.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "020bfc02fe870ec3a66d93e677ccca0562506e5872c650f893269e08615d74ec" -dependencies = [ - "icu_collections", - "icu_locale_core", - "icu_properties_data", - "icu_provider", - "zerotrie", - "zerovec", -] - -[[package]] -name = "icu_properties_data" -version = "2.1.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "616c294cf8d725c6afcd8f55abc17c56464ef6211f9ed59cccffe534129c77af" - -[[package]] -name = "icu_provider" -version = "2.1.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "85962cf0ce02e1e0a629cc34e7ca3e373ce20dda4c4d7294bbd0bf1fdb59e614" -dependencies = [ - "displaydoc", - "icu_locale_core", - "writeable", - "yoke", - "zerofrom", - "zerotrie", - "zerovec", -] - [[package]] name = "id-arena" version = "2.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3d3067d79b975e8844ca9eb072e16b31c3c1c36928edf9c6789548c524d0d954" -[[package]] -name = "idna" -version = "1.1.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3b0875f23caa03898994f6ddc501886a45c7d3d62d04d2d90788d47be1b1e4de" -dependencies = [ - "idna_adapter", - "smallvec", - "utf8_iter", -] - -[[package]] -name = "idna_adapter" -version = "1.2.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3acae9609540aa318d1bc588455225fb2085b9ed0c4f6bd0d9d5bcd86f1a0344" -dependencies = [ - "icu_normalizer", - "icu_properties", -] - [[package]] name = "ignore" version = "0.4.25" @@ -717,12 +578,6 @@ version = "0.12.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "32a66949e030da00e8c7d4434b251670a91556f4144941d37452769c25d58a53" -[[package]] -name = "litemap" -version = "0.8.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6373607a59f0be73a39b6fe456b8192fcc3585f602af20751600e974dd455e77" - [[package]] name = "log" version = "0.4.29" @@ -772,27 +627,12 @@ version = "0.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d" -[[package]] -name = "percent-encoding" -version = "2.3.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220" - [[package]] name = "pkg-config" version = "0.3.32" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7edddbd0b52d732b21ad9a5fab5c704c14cd949e5e9a1ec5929a24fded1b904c" -[[package]] -name = "potential_utf" -version = "0.1.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b73949432f5e2a09657003c25bca5e19a0e9c84f8058ca374f49e0ebe605af77" -dependencies = [ - "zerovec", -] - [[package]] name = "prettyplease" version = "0.2.37" @@ -876,23 +716,9 @@ version = "0.8.10" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "dc897dd8d9e8bd1ed8cdad82b5966c3e0ecae09fb1907d58efaa013543185d0a" -[[package]] -name = "ring" -version = "0.17.14" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a4689e6c2294d81e88dc6261c768b63bc4fcdb852be6d1352498b114f61383b7" -dependencies = [ - "cc", - "cfg-if", - "getrandom 0.2.17", - "libc", - "untrusted", - "windows-sys 0.52.0", -] - [[package]] name = "rtk" -version = "0.34.2" +version = "0.34.3" dependencies = [ "anyhow", "chrono", @@ -900,8 +726,6 @@ dependencies = [ "colored", "dirs", "flate2", - "getrandom 0.4.2", - "hostname", "ignore", "lazy_static", "quick-xml", @@ -910,10 +734,10 @@ dependencies = [ "serde", "serde_json", "sha2", + "shell-words", "tempfile", "thiserror", "toml", - "ureq", "walkdir", "which", ] @@ -945,41 +769,6 @@ dependencies = [ "windows-sys 0.61.2", ] -[[package]] -name = "rustls" -version = "0.23.37" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "758025cb5fccfd3bc2fd74708fd4682be41d99e5dff73c377c0646c6012c73a4" -dependencies = [ - "log", - "once_cell", - "ring", - "rustls-pki-types", - "rustls-webpki", - "subtle", - "zeroize", -] - -[[package]] -name = "rustls-pki-types" -version = "1.14.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "be040f8b0a225e40375822a563fa9524378b9d63112f53e19ffff34df5d33fdd" -dependencies = [ - "zeroize", -] - -[[package]] -name = "rustls-webpki" -version = "0.103.9" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d7df23109aa6c1567d1c575b9952556388da57401e4ace1d15f79eedad0d8f53" -dependencies = [ - "ring", - "rustls-pki-types", - "untrusted", -] - [[package]] name = "rustversion" version = "1.0.22" @@ -1065,6 +854,12 @@ dependencies = [ "digest", ] +[[package]] +name = "shell-words" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc6fe69c597f9c37bfeeeeeb33da3530379845f10be461a66d16d03eca2ded77" + [[package]] name = "shlex" version = "1.3.0" @@ -1083,24 +878,12 @@ version = "1.15.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "67b1b7a3b5fe4f1376887184045fcf45c69e92af734b7aaddc05fb777b6fbd03" -[[package]] -name = "stable_deref_trait" -version = "1.2.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6ce2be8dc25455e1f91df71bfa12ad37d7af1092ae736f3a6cd0e37bc7810596" - [[package]] name = "strsim" version = "0.11.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" -[[package]] -name = "subtle" -version = "2.6.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "13c2bddecc57b384dee18652358fb23172facb8a2c51ccc10d74c157bdea3292" - [[package]] name = "syn" version = "2.0.117" @@ -1112,17 +895,6 @@ dependencies = [ "unicode-ident", ] -[[package]] -name = "synstructure" -version = "0.13.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "728a70f3dbaf5bab7f0c4b1ac8d7ae5ea60a4b5549c8a5914361c99147a709d2" -dependencies = [ - "proc-macro2", - "quote", - "syn", -] - [[package]] name = "tempfile" version = "3.26.0" @@ -1156,16 +928,6 @@ dependencies = [ "syn", ] -[[package]] -name = "tinystr" -version = "0.8.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "42d3e9c45c09de15d06dd8acf5f4e0e399e85927b7f00711024eb7ae10fa4869" -dependencies = [ - "displaydoc", - "zerovec", -] - [[package]] name = "toml" version = "0.8.23" @@ -1225,46 +987,6 @@ version = "0.2.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ebc1c04c71510c7f702b52b7c350734c9ff1295c464a03335b00bb84fc54f853" -[[package]] -name = "untrusted" -version = "0.9.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8ecb6da28b8a351d773b68d5825ac39017e680750f980f3a1a85cd8dd28a47c1" - -[[package]] -name = "ureq" -version = "2.12.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "02d1a66277ed75f640d608235660df48c8e3c19f3b4edb6a263315626cc3c01d" -dependencies = [ - "base64", - "flate2", - "log", - "once_cell", - "rustls", - "rustls-pki-types", - "url", - "webpki-roots 0.26.11", -] - -[[package]] -name = "url" -version = "2.5.8" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ff67a8a4397373c3ef660812acab3268222035010ab8680ec4215f38ba3d0eed" -dependencies = [ - "form_urlencoded", - "idna", - "percent-encoding", - "serde", -] - -[[package]] -name = "utf8_iter" -version = "1.0.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b6c140620e7ffbb22c2dee59cafe6084a59b5ffc27a8859a5f0d494b5d52b6be" - [[package]] name = "utf8parse" version = "0.2.2" @@ -1396,24 +1118,6 @@ dependencies = [ "semver", ] -[[package]] -name = "webpki-roots" -version = "0.26.11" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "521bc38abb08001b01866da9f51eb7c5d647a19260e00054a8c7fd5f9e57f7a9" -dependencies = [ - "webpki-roots 1.0.6", -] - -[[package]] -name = "webpki-roots" -version = "1.0.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "22cfaf3c063993ff62e73cb4311efde4db1efb31ab78a3e5c457939ad5cc0bed" -dependencies = [ - "rustls-pki-types", -] - [[package]] name = "which" version = "8.0.1" @@ -1502,15 +1206,6 @@ dependencies = [ "windows-targets 0.48.5", ] -[[package]] -name = "windows-sys" -version = "0.52.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" -dependencies = [ - "windows-targets 0.52.6", -] - [[package]] name = "windows-sys" version = "0.59.0" @@ -1753,35 +1448,6 @@ dependencies = [ "wasmparser", ] -[[package]] -name = "writeable" -version = "0.6.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9edde0db4769d2dc68579893f2306b26c6ecfbe0ef499b013d731b7b9247e0b9" - -[[package]] -name = "yoke" -version = "0.8.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "72d6e5c6afb84d73944e5cedb052c4680d5657337201555f9f2a16b7406d4954" -dependencies = [ - "stable_deref_trait", - "yoke-derive", - "zerofrom", -] - -[[package]] -name = "yoke-derive" -version = "0.8.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b659052874eb698efe5b9e8cf382204678a0086ebf46982b79d6ca3182927e5d" -dependencies = [ - "proc-macro2", - "quote", - "syn", - "synstructure", -] - [[package]] name = "zerocopy" version = "0.8.40" @@ -1802,66 +1468,6 @@ dependencies = [ "syn", ] -[[package]] -name = "zerofrom" -version = "0.1.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "50cc42e0333e05660c3587f3bf9d0478688e15d870fab3346451ce7f8c9fbea5" -dependencies = [ - "zerofrom-derive", -] - -[[package]] -name = "zerofrom-derive" -version = "0.1.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d71e5d6e06ab090c67b5e44993ec16b72dcbaabc526db883a360057678b48502" -dependencies = [ - "proc-macro2", - "quote", - "syn", - "synstructure", -] - -[[package]] -name = "zeroize" -version = "1.8.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b97154e67e32c85465826e8bcc1c59429aaaf107c1e4a9e53c8d8ccd5eff88d0" - -[[package]] -name = "zerotrie" -version = "0.2.3" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2a59c17a5562d507e4b54960e8569ebee33bee890c70aa3fe7b97e85a9fd7851" -dependencies = [ - "displaydoc", - "yoke", - "zerofrom", -] - -[[package]] -name = "zerovec" -version = "0.11.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6c28719294829477f525be0186d13efa9a3c602f7ec202ca9e353d310fb9a002" -dependencies = [ - "yoke", - "zerofrom", - "zerovec-derive", -] - -[[package]] -name = "zerovec-derive" -version = "0.11.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "eadce39539ca5cb3985590102671f2567e659fca9666581ad3411d59207951f3" -dependencies = [ - "proc-macro2", - "quote", - "syn", -] - [[package]] name = "zmij" version = "1.0.21" diff --git a/Cargo.toml b/Cargo.toml index 2c672aef34..6aa0d2db28 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "rtk" -version = "0.34.2" +version = "0.34.3" edition = "2021" authors = ["Patrick Szymkowiak"] description = "Rust Token Killer - High-performance CLI proxy to minimize LLM token consumption" @@ -28,12 +28,10 @@ chrono = "0.4" thiserror = "1.0" tempfile = "3" sha2 = "0.10" -ureq = "2" -hostname = "0.4" -getrandom = "0.4" flate2 = "1.0" quick-xml = "0.37" which = "8" +shell-words = "1" [build-dependencies] toml = "0.8" diff --git a/GEMINI.md b/GEMINI.md new file mode 100644 index 0000000000..b4ec5e1243 --- /dev/null +++ b/GEMINI.md @@ -0,0 +1,38 @@ +# rtk — Gemini Context + +rtk (Rust Token Killer) is a high-performance CLI proxy that minimizes LLM token consumption by filtering and compressing command outputs. + +## 🎯 Project Overview +- **Purpose:** Minimize token usage for development commands (git, cargo, npm, etc.). +- **Architecture:** Command proxy with specialized filter modules. +- **Stack:** Rust. + +## 🛠 Building and Running + +### Build Commands +- **Build:** `cargo build` +- **Release Build:** `cargo build --release` +- **Install Locally:** `cargo install --path .` + +### Quality & Testing +- **Test:** `cargo test` +- **Lint:** `cargo clippy --all-targets` +- **Format:** `cargo fmt` +- **Check:** `cargo check` + +### Pre-commit Gate +```bash +cargo fmt --all && cargo clippy --all-targets && cargo test --all +``` + +## 📏 Operational Rules +- **Error Handling:** Use `anyhow::Result` everywhere with `.context()`. +- **Safety:** No `unwrap()` in production code. +- **Performance:** Maintain <10ms startup and <5MB memory usage. +- **Decoupling:** Binary must not depend on local repo path once installed. + +## 🤝 Workspace Conventions +- **CHANGELOG.md:** Append-only, required per commit. +- **Task Lifecycle:** todo → plan_proposed → plan_approved → in_progress → report_ready → review_requested → review_passed → done. +- **Task Management:** Use `shux` for all task coordination. +- **Handoffs:** Write via `shux handoff-write`. diff --git a/README.md b/README.md index 05f77de1a8..481c6251ef 100644 --- a/README.md +++ b/README.md @@ -24,15 +24,39 @@

English • - Francais • - 中文 • - 日本語 • - 한국어 • - Espanol + Francais • + 中文 • + 日本語 • + 한국어 • + Espanol

--- +## This Fork + +**Upstream:** [rtk-ai/rtk](https://github.com/rtk-ai/rtk) — forked as [celstnblacc/rtk](https://github.com/celstnblacc/rtk) for use in the [token-diet](https://github.com/celstnblacc/token-diet) stack. + +**Why we forked:** The upstream binary is used as a Claude Code hook that proxies every shell command. Any security issue in the proxy affects every command the agent runs. We found CRITICAL/HIGH findings on first audit. + +**Security fixes applied (v0.34.3+):** + +| Severity | ID | Fix | +|----------|----|-----| +| CRITICAL | C-1 | **Shell injection** — `run-err`, `run-test`, and `summary` used `sh -c `. Replaced with `shell-words::split()` + `Command::new(bin).args(rest)`. Metacharacters (`;`, `&&`, `\|`) are no longer interpreted by a shell. | +| CRITICAL | C-2 | **Exit code lost** — all three commands returned `Ok(())` regardless of child exit code. CI/CD pipelines saw success even on failure. Fixed with `std::process::exit(exit_code)`. | +| HIGH | H-1 | **Non-lazy regex** — `Regex::new()` inside `extract_number()` recompiled on every call. Replaced with four `lazy_static!` statics. | +| HIGH | H-2 | **Production `unwrap()`** in `cc_economics.rs` — rewrote to extract local variable. | +| HIGH | H-3 | **Production `unwrap()`** in `git.rs` stash match arm — rewrote as `Some(sub @ ("pop" \| ...))` binding. | +| MEDIUM | M-1 | **Telemetry default `true`** — `TelemetryConfig::default()` shipped with `enabled: true`; telemetry is stripped in this fork so the default is now `false`. | +| MEDIUM | M-2 | **CWD fallback empty path** — `unwrap_or_default()` on `current_dir()` returns `""` on failure. Changed to `unwrap_or_else(\|_\| PathBuf::from("."))`. | +| MEDIUM | M-3 | **`unwrap()` in `learn/report.rs`** — `grouped.get(&base_cmd).unwrap()` replaced with `let Some(...) else { continue }`. | +| LOW | L-2 | **Signal exit codes** — `status.code().unwrap_or(1)` returns 1 for signal-killed processes, masking the real cause. Migrated all ~40 call sites to `exit_code_from_output/status()` which returns `128 + signal`. | + +All fixes include TDD tests (RED → GREEN → REFACTOR). Run `cargo test --all` to verify. + +--- + rtk filters and compresses command outputs before they reach your LLM context. Single Rust binary, 100+ supported commands, <10ms overhead. ## Token Savings (30-min Claude Code Session) @@ -100,9 +124,9 @@ rtk gain # Should show token savings stats ```bash # 1. Install for your AI tool -rtk init -g # Claude Code / Copilot (default) +rtk init -g # Claude Code + Codex (default) rtk init -g --gemini # Gemini CLI -rtk init -g --codex # Codex (OpenAI) +rtk init -g --codex # Codex only / repair Codex setup rtk init -g --agent cursor # Cursor rtk init --agent windsurf # Windsurf rtk init --agent cline # Cline / Roo Code @@ -353,10 +377,11 @@ Creates `~/.gemini/hooks/rtk-hook-gemini.sh` + patches `~/.gemini/settings.json` ### Codex (OpenAI) ```bash -rtk init -g --codex +rtk init -g # default: Claude hook + Codex instructions +rtk init -g --codex # Codex only / repair Codex setup ``` -Creates `~/.codex/RTK.md` + `~/.codex/AGENTS.md` with `@RTK.md` reference. Codex reads these as global instructions. +`rtk init -g` now also creates `~/.codex/RTK.md` + `~/.codex/AGENTS.md` with `@RTK.md` reference, so a normal global install configures both Claude and Codex in one step. Codex reads these as global instructions. ### Windsurf @@ -465,7 +490,7 @@ brew uninstall rtk # If installed via Homebrew ## Documentation - **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - Fix common issues -- **[INSTALL.md](INSTALL.md)** - Detailed installation guide +- **[INSTALL.md](docs/INSTALL.md)** - Detailed installation guide - **[ARCHITECTURE.md](ARCHITECTURE.md)** - Technical architecture - **[SECURITY.md](SECURITY.md)** - Security policy and PR review process - **[AUDIT_GUIDE.md](docs/AUDIT_GUIDE.md)** - Token savings analytics guide diff --git a/SOUL.md b/SOUL.md new file mode 100644 index 0000000000..fb1f3d057c --- /dev/null +++ b/SOUL.md @@ -0,0 +1,10 @@ +# Soul — rtk + +## Operating Constraints +- Ship > plan. One focused task per session. +- Keep changes within the current contract scope. + +## Guardrails +- Never edit .env, credentials, or secrets. +- Never push directly to main without human review. +- Run required checks before handoff or commit. diff --git a/INSTALL.md b/docs/INSTALL.md similarity index 99% rename from INSTALL.md rename to docs/INSTALL.md index 98457d09a9..e0685c3c9a 100644 --- a/INSTALL.md +++ b/docs/INSTALL.md @@ -96,6 +96,7 @@ rtk init -g # → Installs hook to ~/.claude/hooks/rtk-rewrite.sh # → Creates ~/.claude/RTK.md (10 lines, meta commands only) # → Adds @RTK.md reference to ~/.claude/CLAUDE.md +# → Creates ~/.codex/RTK.md + adds @RTK.md to ~/.codex/AGENTS.md # → Prompts: "Patch settings.json? [y/N]" # → If yes: patches + creates backup (~/.claude/settings.json.bak) diff --git a/README_es.md b/docs/README_es.md similarity index 93% rename from README_es.md rename to docs/README_es.md index c099d6649b..828c437ab6 100644 --- a/README_es.md +++ b/docs/README_es.md @@ -17,13 +17,13 @@

Sitio web • Instalar • - Solucion de problemas • - Arquitectura • + Solucion de problemas • + Arquitectura • Discord

- English • + English • Francais • 中文 • 日本語 • @@ -144,9 +144,9 @@ rtk discover # Descubrir ahorros perdidos ## Documentacion -- **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - Resolver problemas comunes +- **[TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - Resolver problemas comunes - **[INSTALL.md](INSTALL.md)** - Guia de instalacion detallada -- **[ARCHITECTURE.md](ARCHITECTURE.md)** - Arquitectura tecnica +- **[ARCHITECTURE.md](../ARCHITECTURE.md)** - Arquitectura tecnica ## Contribuir @@ -156,4 +156,4 @@ Unete a la comunidad en [Discord](https://discord.gg/RySmvNF5kF). ## Licencia -Licencia MIT - ver [LICENSE](LICENSE) para detalles. +Licencia MIT - ver [LICENSE](../LICENSE) para detalles. diff --git a/README_fr.md b/docs/README_fr.md similarity index 94% rename from README_fr.md rename to docs/README_fr.md index 4c5e749dac..fe803f9a6d 100644 --- a/README_fr.md +++ b/docs/README_fr.md @@ -17,13 +17,13 @@

Site web • Installer • - Depannage • - Architecture • + Depannage • + Architecture • Discord

- English • + English • Francais • 中文 • 日本語 • @@ -182,9 +182,9 @@ mode = "failures" ## Documentation -- **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - Resoudre les problemes courants +- **[TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - Resoudre les problemes courants - **[INSTALL.md](INSTALL.md)** - Guide d'installation detaille -- **[ARCHITECTURE.md](ARCHITECTURE.md)** - Architecture technique +- **[ARCHITECTURE.md](../ARCHITECTURE.md)** - Architecture technique ## Contribuer @@ -194,4 +194,4 @@ Rejoignez la communaute sur [Discord](https://discord.gg/RySmvNF5kF). ## Licence -Licence MIT - voir [LICENSE](LICENSE) pour les details. +Licence MIT - voir [LICENSE](../LICENSE) pour les details. diff --git a/README_ja.md b/docs/README_ja.md similarity index 92% rename from README_ja.md rename to docs/README_ja.md index 6c690affa5..ad1b5dcd70 100644 --- a/README_ja.md +++ b/docs/README_ja.md @@ -17,13 +17,13 @@

ウェブサイト • インストール • - トラブルシューティング • - アーキテクチャ • + トラブルシューティング • + アーキテクチャ • Discord

- English • + English • Francais • 中文 • 日本語 • @@ -144,9 +144,9 @@ rtk discover # 見逃した節約機会を発見 ## ドキュメント -- **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - よくある問題の解決 +- **[TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - よくある問題の解決 - **[INSTALL.md](INSTALL.md)** - 詳細インストールガイド -- **[ARCHITECTURE.md](ARCHITECTURE.md)** - 技術アーキテクチャ +- **[ARCHITECTURE.md](../ARCHITECTURE.md)** - 技術アーキテクチャ ## コントリビュート @@ -156,4 +156,4 @@ rtk discover # 見逃した節約機会を発見 ## ライセンス -MIT ライセンス - 詳細は [LICENSE](LICENSE) を参照。 +MIT ライセンス - 詳細は [LICENSE](../LICENSE) を参照。 diff --git a/README_ko.md b/docs/README_ko.md similarity index 92% rename from README_ko.md rename to docs/README_ko.md index 5d3b1a0b2c..35eae23eca 100644 --- a/README_ko.md +++ b/docs/README_ko.md @@ -17,13 +17,13 @@

웹사이트 • 설치 • - 문제 해결 • - 아키텍처 • + 문제 해결 • + 아키텍처 • Discord

- English • + English • Francais • 中文 • 日本語 • @@ -144,9 +144,9 @@ rtk discover # 놓친 절약 기회 발견 ## 문서 -- **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - 일반적인 문제 해결 +- **[TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - 일반적인 문제 해결 - **[INSTALL.md](INSTALL.md)** - 상세 설치 가이드 -- **[ARCHITECTURE.md](ARCHITECTURE.md)** - 기술 아키텍처 +- **[ARCHITECTURE.md](../ARCHITECTURE.md)** - 기술 아키텍처 ## 기여 @@ -156,4 +156,4 @@ rtk discover # 놓친 절약 기회 발견 ## 라이선스 -MIT 라이선스 - 자세한 내용은 [LICENSE](LICENSE)를 참조하세요. +MIT 라이선스 - 자세한 내용은 [LICENSE](../LICENSE)를 참조하세요. diff --git a/README_zh.md b/docs/README_zh.md similarity index 93% rename from README_zh.md rename to docs/README_zh.md index 00b9c001f0..a3117612c3 100644 --- a/README_zh.md +++ b/docs/README_zh.md @@ -17,13 +17,13 @@

官网 • 安装 • - 故障排除 • - 架构 • + 故障排除 • + 架构 • Discord

- English • + English • Francais • 中文 • 日本語 • @@ -152,9 +152,9 @@ rtk discover # 发现遗漏的节省机会 ## 文档 -- **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - 解决常见问题 +- **[TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - 解决常见问题 - **[INSTALL.md](INSTALL.md)** - 详细安装指南 -- **[ARCHITECTURE.md](ARCHITECTURE.md)** - 技术架构 +- **[ARCHITECTURE.md](../ARCHITECTURE.md)** - 技术架构 ## 贡献 @@ -164,4 +164,4 @@ rtk discover # 发现遗漏的节省机会 ## 许可证 -MIT 许可证 - 详见 [LICENSE](LICENSE)。 +MIT 许可证 - 详见 [LICENSE](../LICENSE)。 diff --git a/ROADMAP.md b/docs/ROADMAP.md similarity index 100% rename from ROADMAP.md rename to docs/ROADMAP.md diff --git a/docs/rtk-improvements-summary.md b/docs/rtk-improvements-summary.md new file mode 100644 index 0000000000..8526a840be --- /dev/null +++ b/docs/rtk-improvements-summary.md @@ -0,0 +1,36 @@ +# RTK Improvements Summary + +Based on a quick product and integration review, the best improvements for `rtk` are: + +## Role Under Token-Diet + +- If `token-diet` is the primary installer for new users, `rtk` should not be the main owner of cross-tool onboarding. +- `rtk` should instead expose a strong runtime contract: stable CLI behavior, machine-readable health/status, accurate hook diagnostics, and safe execution boundaries. +- `token-diet` can then orchestrate install, repair, and compatibility checks on top of those primitives. + +- Automate adoption. Strengthen hooks and post-install checks so users do not have to remember `rtk ` manually. +- Improve command routing. Make `rtk` the default for noisy shell commands, while keeping file navigation and symbol work with tools like `tilth` and Serena. +- Add `rtk doctor` and machine-readable self-checks so `token-diet` can detect broken hooks, stale registrations, PATH issues, and config drift. +- Add `--json` output for health, gain, and diagnostics so dashboards and other tools can consume RTK state. +- Improve tracking. Add per-project views, better cost attribution, and clearer “you should have used RTK here” feedback. +- Improve idempotency. Re-running setup should converge cleanly without duplicate hook/config mutations. +- Add stronger post-install smoke checks for each supported agent so the user knows the rewrite path is actually active. + +## Security Improvements + +- Keep the rewrite boundary strict. Never fall back to shell interpretation for rewritten commands. +- Validate environment inputs such as `PATH`, pager/editor variables, and any hook-controlled command strings before execution. +- Preserve child exit codes and signal semantics on every wrapper path so failures are never reported as success. +- Add atomic writes and backups for all config and hook mutations. +- Verify install sources with pinned versions, checksums, or signed artifacts where possible. +- Harden tracking storage with safer file permissions, WAL/concurrency strategy, and corruption recovery paths. +- Add regression tests for shell metacharacters, hostile environment variables, malformed command output, signal exits, and concurrent database writes. +- Add an audit/debug mode that shows raw command, rewritten command, applied filter, and trust boundary for troubleshooting. + +## Highest-Leverage Next Steps + +1. Build `rtk doctor`. +2. Add `--json` health and rewrite-state diagnostics for `token-diet` to consume. +3. Harden hook rewrite and environment validation. +4. Add per-project tracking and exportable metrics. +5. Expand install and runtime smoke tests across supported agents. diff --git a/install.sh b/install.sh index 1654245d9a..66cc08013c 100644 --- a/install.sh +++ b/install.sh @@ -119,6 +119,7 @@ main() { echo "" info "Installation complete! Run '$BINARY_NAME --help' to get started." + info "Recommended next step: '$BINARY_NAME init -g' to configure Claude Code and Codex." } main diff --git a/scripts/benchmark.sh b/scripts/benchmark.sh index a1e616bcc0..8121f9f556 100755 --- a/scripts/benchmark.sh +++ b/scripts/benchmark.sh @@ -44,8 +44,8 @@ bench() { local unix_cmd="$2" local rtk_cmd="$3" - unix_out=$(eval "$unix_cmd" 2>/dev/null || true) - rtk_out=$(eval "$rtk_cmd" 2>/dev/null || true) + unix_out=$(bash -c "$unix_cmd" 2>/dev/null || true) + rtk_out=$(bash -c "$rtk_cmd" 2>/dev/null || true) unix_tokens=$(count_tokens "$unix_out") rtk_tokens=$(count_tokens "$rtk_out") @@ -537,7 +537,7 @@ bench_rewrite() { local cmd="$2" local expected="$3" - result=$(eval "$cmd" 2>&1 || true) + result=$(bash -c "$cmd" 2>&1 || true) TOTAL_TESTS=$((TOTAL_TESTS + 1)) diff --git a/scripts/check-installation.sh b/scripts/check-installation.sh index e7a56fb7ad..ff18ac5010 100755 --- a/scripts/check-installation.sh +++ b/scripts/check-installation.sh @@ -111,6 +111,16 @@ else fi echo "" +# Check 5b: Codex initialization +echo "5b. Checking Codex integration..." +if [ -f "$HOME/.codex/RTK.md" ] && [ -f "$HOME/.codex/AGENTS.md" ] && grep -q "@RTK.md" "$HOME/.codex/AGENTS.md"; then + echo -e " ${GREEN}✅${NC} Global Codex config initialized (~/.codex/AGENTS.md + ~/.codex/RTK.md)" +else + echo -e " ${YELLOW}⚠️${NC} Global Codex config not initialized" + echo " Run: rtk init --global" +fi +echo "" + # Check 6: Auto-rewrite hook echo "6. Checking auto-rewrite hook (optional but recommended)..." if [ -f "$HOME/.claude/hooks/rtk-rewrite.sh" ]; then diff --git a/src/analytics/cc_economics.rs b/src/analytics/cc_economics.rs index 693dc61e2d..aaa73f3248 100644 --- a/src/analytics/cc_economics.rs +++ b/src/analytics/cc_economics.rs @@ -387,12 +387,14 @@ fn compute_totals(periods: &[PeriodEconomics]) -> Totals { // Compute global dual metrics (legacy) if totals.cc_total_tokens > 0 { - totals.blended_cpt = Some(totals.cc_cost / totals.cc_total_tokens as f64); - totals.savings_blended = Some(totals.rtk_saved_tokens as f64 * totals.blended_cpt.unwrap()); + let blended_cpt = totals.cc_cost / totals.cc_total_tokens as f64; + totals.blended_cpt = Some(blended_cpt); + totals.savings_blended = Some(totals.rtk_saved_tokens as f64 * blended_cpt); } if totals.cc_active_tokens > 0 { - totals.active_cpt = Some(totals.cc_cost / totals.cc_active_tokens as f64); - totals.savings_active = Some(totals.rtk_saved_tokens as f64 * totals.active_cpt.unwrap()); + let active_cpt = totals.cc_cost / totals.cc_active_tokens as f64; + totals.active_cpt = Some(active_cpt); + totals.savings_active = Some(totals.rtk_saved_tokens as f64 * active_cpt); } totals diff --git a/src/cmds/git/gh_cmd.rs b/src/cmds/git/gh_cmd.rs index e008a2f19e..d3e8605c33 100644 --- a/src/cmds/git/gh_cmd.rs +++ b/src/cmds/git/gh_cmd.rs @@ -4,7 +4,9 @@ //! Focuses on extracting essential information from JSON outputs. use crate::core::tracking; -use crate::core::utils::{ok_confirmation, resolved_command, truncate}; +use crate::core::utils::{ + exit_code_from_output, exit_code_from_status, ok_confirmation, resolved_command, truncate, +}; use crate::git; use anyhow::{Context, Result}; use lazy_static::lazy_static; @@ -222,7 +224,7 @@ fn list_prs(args: &[String], _verbose: u8, ultra_compact: bool) -> Result<()> { let stderr = String::from_utf8_lossy(&output.stderr).to_string(); timer.track("gh pr list", "rtk gh pr list", &stderr, &stderr); eprintln!("{}", stderr.trim()); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "gh")); } let json: Value = @@ -333,7 +335,7 @@ fn view_pr(args: &[String], _verbose: u8, ultra_compact: bool) -> Result<()> { &stderr, ); eprintln!("{}", stderr.trim()); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "gh")); } let json: Value = @@ -498,7 +500,7 @@ fn pr_checks(args: &[String], _verbose: u8, _ultra_compact: bool) -> Result<()> &stderr, ); eprintln!("{}", stderr.trim()); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "gh")); } let stdout = String::from_utf8_lossy(&output.stdout); @@ -578,7 +580,7 @@ fn pr_status(_verbose: u8, _ultra_compact: bool) -> Result<()> { let stderr = String::from_utf8_lossy(&output.stderr).to_string(); timer.track("gh pr status", "rtk gh pr status", &stderr, &stderr); eprintln!("{}", stderr.trim()); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "gh")); } let json: Value = @@ -633,7 +635,7 @@ fn list_issues(args: &[String], _verbose: u8, ultra_compact: bool) -> Result<()> let stderr = String::from_utf8_lossy(&output.stderr).to_string(); timer.track("gh issue list", "rtk gh issue list", &stderr, &stderr); eprintln!("{}", stderr.trim()); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "gh")); } let json: Value = @@ -717,7 +719,7 @@ fn view_issue(args: &[String], _verbose: u8) -> Result<()> { &stderr, ); eprintln!("{}", stderr.trim()); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "gh")); } let json: Value = @@ -813,7 +815,7 @@ fn list_runs(args: &[String], _verbose: u8, ultra_compact: bool) -> Result<()> { let stderr = String::from_utf8_lossy(&output.stderr).to_string(); timer.track("gh run list", "rtk gh run list", &stderr, &stderr); eprintln!("{}", stderr.trim()); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "gh")); } let json: Value = @@ -913,7 +915,7 @@ fn view_run(args: &[String], _verbose: u8) -> Result<()> { &stderr, ); eprintln!("{}", stderr.trim()); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "gh")); } // Parse output and show only failures @@ -990,7 +992,7 @@ fn run_repo(args: &[String], _verbose: u8, _ultra_compact: bool) -> Result<()> { let stderr = String::from_utf8_lossy(&output.stderr).to_string(); timer.track("gh repo view", "rtk gh repo view", &stderr, &stderr); eprintln!("{}", stderr.trim()); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "gh")); } let json: Value = @@ -1050,7 +1052,7 @@ fn pr_create(args: &[String], _verbose: u8) -> Result<()> { if !output.status.success() { timer.track("gh pr create", "rtk gh pr create", &stderr, &stderr); eprintln!("{}", stderr.trim()); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "gh")); } // gh pr create outputs the URL on success @@ -1088,7 +1090,7 @@ fn pr_merge(args: &[String], _verbose: u8) -> Result<()> { if !output.status.success() { timer.track("gh pr merge", "rtk gh pr merge", &stderr, &stderr); eprintln!("{}", stderr.trim()); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "gh")); } // Extract PR number from args (first non-flag arg) @@ -1160,7 +1162,7 @@ fn pr_diff(args: &[String], _verbose: u8) -> Result<()> { let stderr = String::from_utf8_lossy(&output.stderr).to_string(); timer.track("gh pr diff", "rtk gh pr diff", &stderr, &stderr); eprintln!("{}", stderr.trim()); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "gh")); } let filtered = if raw.trim().is_empty() { @@ -1202,7 +1204,7 @@ fn pr_action(action: &str, args: &[String], _verbose: u8) -> Result<()> { &stderr, ); eprintln!("{}", stderr.trim()); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "gh")); } // Extract PR number from args (skip args[0] which is the subcommand) @@ -1264,7 +1266,7 @@ fn run_passthrough_with_extra(cmd: &str, base_args: &[&str], extra_args: &[Strin timer.track_passthrough(&full_cmd, &format!("rtk {} (passthrough)", full_cmd)); if !status.success() { - std::process::exit(status.code().unwrap_or(1)); + std::process::exit(exit_code_from_status(&status, &full_cmd)); } Ok(()) @@ -1284,13 +1286,11 @@ fn run_passthrough(cmd: &str, subcommand: &str, args: &[String]) -> Result<()> { .context(format!("Failed to run {} {}", cmd, subcommand))?; let args_str = tracking::args_display(&args.iter().map(|s| s.into()).collect::>()); - timer.track_passthrough( - &format!("{} {} {}", cmd, subcommand, args_str), - &format!("rtk {} {} {} (passthrough)", cmd, subcommand, args_str), - ); + let label = format!("{} {} {}", cmd, subcommand, args_str); + timer.track_passthrough(&label, &format!("rtk {} (passthrough)", label)); if !status.success() { - std::process::exit(status.code().unwrap_or(1)); + std::process::exit(exit_code_from_status(&status, &label)); } Ok(()) diff --git a/src/cmds/git/git.rs b/src/cmds/git/git.rs index 1ed848d631..1567fe7d81 100644 --- a/src/cmds/git/git.rs +++ b/src/cmds/git/git.rs @@ -2,7 +2,7 @@ use crate::core::config; use crate::core::tracking; -use crate::core::utils::resolved_command; +use crate::core::utils::{exit_code_from_output, exit_code_from_status, resolved_command}; use anyhow::{Context, Result}; use std::ffi::OsString; use std::process::Command; @@ -90,7 +90,7 @@ fn run_diff( if !output.status.success() { let stderr = String::from_utf8_lossy(&output.stderr); eprintln!("{}", stderr); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } let stdout = String::from_utf8_lossy(&output.stdout); @@ -129,7 +129,7 @@ fn run_diff( &raw, &raw, ); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } if verbose > 0 { @@ -199,7 +199,7 @@ fn run_show( if !output.status.success() { let stderr = String::from_utf8_lossy(&output.stderr); eprintln!("{}", stderr); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } let stdout = String::from_utf8_lossy(&output.stdout); if wants_blob_show { @@ -239,7 +239,7 @@ fn run_show( if !summary_output.status.success() { let stderr = String::from_utf8_lossy(&summary_output.stderr); eprintln!("{}", stderr); - std::process::exit(summary_output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&summary_output, "git show")); } let summary = String::from_utf8_lossy(&summary_output.stdout); println!("{}", summary.trim()); @@ -445,7 +445,7 @@ fn run_log( let stderr = String::from_utf8_lossy(&output.stderr); eprintln!("{}", stderr); // Propagate git's exit code - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } let stdout = String::from_utf8_lossy(&output.stdout); @@ -765,7 +765,7 @@ fn run_status(args: &[String], verbose: u8, global_args: &[String]) -> Result<() &raw, &raw, ); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } if verbose > 0 || !stderr.is_empty() { @@ -806,7 +806,7 @@ fn run_status(args: &[String], verbose: u8, global_args: &[String]) -> Result<() let message = "Not a git repository".to_string(); eprintln!("{}", message); timer.track("git status", "rtk git status", &raw_output, &message); - std::process::exit(output.status.code().unwrap_or(128)); + std::process::exit(exit_code_from_output(&output, "git status")); } let formatted = format_status_output(&stdout); @@ -885,7 +885,7 @@ fn run_add(args: &[String], verbose: u8, global_args: &[String]) -> Result<()> { eprintln!("{}", stdout); } // Propagate git's exit code - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } Ok(()) @@ -954,7 +954,7 @@ fn run_commit(args: &[String], verbose: u8, global_args: &[String]) -> Result<() eprint!("{}", stdout); } timer.track(&original_cmd, "rtk git commit", &raw_output, &raw_output); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } } @@ -1017,7 +1017,7 @@ fn run_push(args: &[String], verbose: u8, global_args: &[String]) -> Result<()> if !stdout.trim().is_empty() { eprintln!("{}", stdout); } - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } Ok(()) @@ -1103,7 +1103,7 @@ fn run_pull(args: &[String], verbose: u8, global_args: &[String]) -> Result<()> if !stdout.trim().is_empty() { eprintln!("{}", stdout); } - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } Ok(()) @@ -1183,7 +1183,7 @@ fn run_branch(args: &[String], verbose: u8, global_args: &[String]) -> Result<() if !stderr.trim().is_empty() { eprintln!("{}", stderr); } - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } return Ok(()); } @@ -1223,7 +1223,7 @@ fn run_branch(args: &[String], verbose: u8, global_args: &[String]) -> Result<() if !stdout.trim().is_empty() { eprintln!("{}", stdout); } - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } return Ok(()); } @@ -1254,7 +1254,7 @@ fn run_branch(args: &[String], verbose: u8, global_args: &[String]) -> Result<() &raw, &raw, ); - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } let filtered = filter_branch_output(&stdout); @@ -1347,7 +1347,7 @@ fn run_fetch(args: &[String], verbose: u8, global_args: &[String]) -> Result<()> if !stderr.trim().is_empty() { eprintln!("{}", stderr); } - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } // Count new refs from stderr (git fetch outputs to stderr) @@ -1422,8 +1422,7 @@ fn run_stash( timer.track("git stash show", "rtk git stash show", &raw, &filtered); } - Some("pop") | Some("apply") | Some("drop") | Some("push") => { - let sub = subcommand.unwrap(); + Some(sub @ ("pop" | "apply" | "drop" | "push")) => { let mut cmd = git_cmd(global_args); cmd.args(["stash", sub]); for arg in args { @@ -1454,7 +1453,7 @@ fn run_stash( ); if !output.status.success() { - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } } Some(sub) => { @@ -1489,7 +1488,7 @@ fn run_stash( ); if !output.status.success() { - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } } None => { @@ -1525,7 +1524,7 @@ fn run_stash( timer.track("git stash", "rtk git stash", &combined, &msg); if !output.status.success() { - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } } } @@ -1597,7 +1596,7 @@ fn run_worktree(args: &[String], verbose: u8, global_args: &[String]) -> Result< if !stderr.trim().is_empty() { eprintln!("{}", stderr); } - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(exit_code_from_output(&output, "git")); } return Ok(()); } @@ -1658,13 +1657,11 @@ pub fn run_passthrough(args: &[OsString], global_args: &[String], verbose: u8) - .context("Failed to run git")?; let args_str = tracking::args_display(args); - timer.track_passthrough( - &format!("git {}", args_str), - &format!("rtk git {} (passthrough)", args_str), - ); + let label = format!("git {}", args_str); + timer.track_passthrough(&label, &format!("rtk {} (passthrough)", label)); if !status.success() { - std::process::exit(status.code().unwrap_or(1)); + std::process::exit(exit_code_from_status(&status, &label)); } Ok(()) } diff --git a/src/cmds/git/gt_cmd.rs b/src/cmds/git/gt_cmd.rs index 580778ff14..d2e0faa9b1 100644 --- a/src/cmds/git/gt_cmd.rs +++ b/src/cmds/git/gt_cmd.rs @@ -1,7 +1,10 @@ //! Filters Graphite (gt) CLI output for stacking workflows. use crate::core::tracking; -use crate::core::utils::{ok_confirmation, resolved_command, strip_ansi, truncate}; +use crate::core::utils::{ + exit_code_from_output, exit_code_from_status, ok_confirmation, resolved_command, strip_ansi, + truncate, +}; use anyhow::{Context, Result}; use lazy_static::lazy_static; use regex::Regex; @@ -52,7 +55,7 @@ fn run_gt_filtered( let stderr = String::from_utf8_lossy(&cmd_output.stderr); let raw = format!("{}\n{}", stdout, stderr); - let exit_code = cmd_output.status.code().unwrap_or(1); + let exit_code = exit_code_from_output(&cmd_output, &format!("gt {}", subcmd_str)); let clean = strip_ansi(stdout.trim()); let output = if verbose > 0 { @@ -197,7 +200,7 @@ fn passthrough_gt(subcommand: &str, args: &[String], verbose: u8) -> Result<()> ); if !status.success() { - std::process::exit(status.code().unwrap_or(1)); + std::process::exit(exit_code_from_status(&status, &format!("gt {}", args_str))); } Ok(()) diff --git a/src/cmds/rust/runner.rs b/src/cmds/rust/runner.rs index 8c3f352706..2050004481 100644 --- a/src/cmds/rust/runner.rs +++ b/src/cmds/rust/runner.rs @@ -1,6 +1,7 @@ //! Runs arbitrary commands and captures only stderr or test failures. use crate::core::tracking; +use crate::core::utils::{exit_code_from_output, split_command}; use anyhow::{Context, Result}; use regex::Regex; use std::process::{Command, Stdio}; @@ -19,14 +20,17 @@ pub fn run_err(command: &str, verbose: u8) -> Result<()> { .stdout(Stdio::piped()) .stderr(Stdio::piped()) .output() + .context("Failed to execute command")? } else { - Command::new("sh") - .args(["-c", command]) + let parts = split_command(command) + .with_context(|| format!("Failed to parse command: {}", command))?; + Command::new(&parts[0]) + .args(&parts[1..]) .stdout(Stdio::piped()) .stderr(Stdio::piped()) .output() - } - .context("Failed to execute command")?; + .context("Failed to execute command")? + }; let stdout = String::from_utf8_lossy(&output.stdout); let stderr = String::from_utf8_lossy(&output.stderr); @@ -51,16 +55,16 @@ pub fn run_err(command: &str, verbose: u8) -> Result<()> { rtk.push_str(&filtered); } - let exit_code = output - .status - .code() - .unwrap_or(if output.status.success() { 0 } else { 1 }); + let exit_code = exit_code_from_output(&output, "run-err"); if let Some(hint) = crate::core::tee::tee_and_hint(&raw, "err", exit_code) { println!("{}\n{}", rtk, hint); } else { println!("{}", rtk); } timer.track(command, "rtk run-err", &raw, &rtk); + if exit_code != 0 { + std::process::exit(exit_code); + } Ok(()) } @@ -78,23 +82,23 @@ pub fn run_test(command: &str, verbose: u8) -> Result<()> { .stdout(Stdio::piped()) .stderr(Stdio::piped()) .output() + .context("Failed to execute test command")? } else { - Command::new("sh") - .args(["-c", command]) + let parts = split_command(command) + .with_context(|| format!("Failed to parse command: {}", command))?; + Command::new(&parts[0]) + .args(&parts[1..]) .stdout(Stdio::piped()) .stderr(Stdio::piped()) .output() - } - .context("Failed to execute test command")?; + .context("Failed to execute test command")? + }; let stdout = String::from_utf8_lossy(&output.stdout); let stderr = String::from_utf8_lossy(&output.stderr); let raw = format!("{}\n{}", stdout, stderr); - let exit_code = output - .status - .code() - .unwrap_or(if output.status.success() { 0 } else { 1 }); + let exit_code = exit_code_from_output(&output, "run-test"); let summary = extract_test_summary(&raw, command); if let Some(hint) = crate::core::tee::tee_and_hint(&raw, "test", exit_code) { println!("{}\n{}", summary, hint); @@ -102,6 +106,9 @@ pub fn run_test(command: &str, verbose: u8) -> Result<()> { println!("{}", summary); } timer.track(command, "rtk run-test", &raw, &summary); + if exit_code != 0 { + std::process::exit(exit_code); + } Ok(()) } @@ -262,6 +269,7 @@ fn extract_test_summary(output: &str, command: &str) -> String { #[cfg(test)] mod tests { use super::*; + use crate::core::utils::split_command; #[test] fn test_filter_errors() { @@ -270,4 +278,88 @@ mod tests { assert!(filtered.contains("error")); assert!(!filtered.contains("info")); } + + // C-2: exit code must be propagated from the underlying command + /// Before fix: run_err / run_test return Ok(()) even when child exits non-zero. + /// After fix: std::process::exit(code) is called with the child's exit code. + #[test] + #[ignore] // integration — requires rtk binary on PATH + fn test_run_err_propagates_exit_code() { + let status = std::process::Command::new("rtk") + .args(["run-err", "false"]) + .status() + .expect("rtk binary not found — run `cargo install --path .` first"); + assert_ne!( + status.code().unwrap_or(0), + 0, + "run-err must exit non-zero when the wrapped command fails" + ); + } + + #[test] + #[ignore] + fn test_run_test_propagates_exit_code() { + let status = std::process::Command::new("rtk") + .args(["run-test", "false"]) + .status() + .expect("rtk binary not found"); + assert_ne!( + status.code().unwrap_or(0), + 0, + "run-test must exit non-zero when the wrapped command fails" + ); + } + + // C-1: split_command must exist and treat ; as a literal token, not a separator + #[test] + fn test_split_command_semicolon_is_literal() { + let parts = split_command("echo safe ; echo INJECTED").unwrap(); + assert_eq!(parts[0], "echo"); + // ; must be present as a token, not strip it or interpret it as a separator + assert!( + parts.iter().any(|t| t == ";"), + "semicolon was not preserved as a literal token" + ); + // All 5 tokens present + assert_eq!(parts.len(), 5); + } + + #[test] + fn test_split_command_empty_fails() { + assert!(split_command("").is_err()); + assert!(split_command(" ").is_err()); + } + + #[test] + fn test_split_command_quoted_preserves_space() { + let parts = split_command(r#"git log --format="%H %s""#).unwrap(); + assert_eq!(parts[0], "git"); + assert_eq!(parts[1], "log"); + // Quoted string with space becomes one token + assert_eq!(parts[2], "--format=%H %s"); + } + + #[test] + #[cfg(unix)] + fn test_split_exec_blocks_semicolon_injection() { + use std::process::Stdio; + let marker = "/tmp/rtk_split_exec_injection_test"; + let _ = std::fs::remove_file(marker); + + // With sh -c "echo safe ; touch ", the marker would be created + // With split exec, touch is just an arg to echo — marker must NOT appear + let cmd = format!("echo safe ; touch {}", marker); + let parts = split_command(&cmd).unwrap(); + let _status = std::process::Command::new(&parts[0]) + .args(&parts[1..]) + .stdout(Stdio::null()) + .status() + .unwrap(); + + assert!( + !std::path::Path::new(marker).exists(), + "Shell injection: touch ran as a separate command" + ); + let _ = std::fs::remove_file(marker); + } } diff --git a/src/cmds/system/doctor.rs b/src/cmds/system/doctor.rs new file mode 100644 index 0000000000..8f7db254a2 --- /dev/null +++ b/src/cmds/system/doctor.rs @@ -0,0 +1,373 @@ +//! `rtk doctor` — health check for the rtk installation. +//! +//! Checks: +//! 1. Hook status (Ok / Outdated / Missing) +//! 2. Tracking DB accessible +//! 3. `rtk` on PATH and resolves to itself +//! 4. Config file validity +//! 5. Parse-failure rate (last 7 days from DB) + +use crate::{ + core::{config, tracking::Tracker}, + hooks::hook_check::{self, HookStatus}, +}; +use serde::Serialize; +use std::fmt; + +// ── Types ────────────────────────────────────────────────────────────────── + +#[derive(Debug, Clone, PartialEq, Serialize)] +#[serde(rename_all = "lowercase")] +pub enum CheckStatus { + Pass, + Warn, + Fail, +} + +impl fmt::Display for CheckStatus { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + CheckStatus::Pass => write!(f, "pass"), + CheckStatus::Warn => write!(f, "warn"), + CheckStatus::Fail => write!(f, "fail"), + } + } +} + +#[derive(Debug, Clone, Serialize)] +pub struct DoctorCheck { + pub name: &'static str, + pub status: CheckStatus, + pub detail: String, +} + +#[derive(Debug, Serialize)] +pub struct DoctorReport { + pub overall: CheckStatus, + pub checks: Vec, +} + +// ── Individual checks ────────────────────────────────────────────────────── + +pub fn check_hook() -> DoctorCheck { + match hook_check::status() { + HookStatus::Ok => DoctorCheck { + name: "hook", + status: CheckStatus::Pass, + detail: "hook installed and up to date".to_string(), + }, + HookStatus::Outdated => DoctorCheck { + name: "hook", + status: CheckStatus::Warn, + detail: "hook is outdated — run `rtk init -g` to update".to_string(), + }, + HookStatus::Missing => DoctorCheck { + name: "hook", + status: CheckStatus::Warn, + detail: "hook not installed — run `rtk init -g` for automatic token savings" + .to_string(), + }, + } +} + +pub fn check_db() -> DoctorCheck { + match Tracker::new() { + Ok(_) => DoctorCheck { + name: "tracking_db", + status: CheckStatus::Pass, + detail: "tracking database accessible".to_string(), + }, + Err(e) => DoctorCheck { + name: "tracking_db", + status: CheckStatus::Fail, + detail: format!("cannot open tracking database: {e}"), + }, + } +} + +pub fn check_path() -> DoctorCheck { + match which::which("rtk") { + Ok(path) => DoctorCheck { + name: "path", + status: CheckStatus::Pass, + detail: format!("`rtk` found at {}", path.display()), + }, + Err(_) => DoctorCheck { + name: "path", + status: CheckStatus::Fail, + detail: "`rtk` not found on PATH — add ~/.local/bin to PATH".to_string(), + }, + } +} + +pub fn check_config() -> DoctorCheck { + match config::Config::load() { + Ok(_) => DoctorCheck { + name: "config", + status: CheckStatus::Pass, + detail: "config valid".to_string(), + }, + Err(e) => { + // No config file is normal — not a failure + let msg = e.to_string(); + if msg.contains("No such file") || msg.contains("not found") { + DoctorCheck { + name: "config", + status: CheckStatus::Pass, + detail: "no config file (using defaults)".to_string(), + } + } else { + DoctorCheck { + name: "config", + status: CheckStatus::Warn, + detail: format!("config parse error: {msg}"), + } + } + } + } +} + +pub fn check_failure_rate() -> DoctorCheck { + let tracker = match Tracker::new() { + Ok(t) => t, + Err(_) => { + return DoctorCheck { + name: "failure_rate", + status: CheckStatus::Warn, + detail: "cannot check failure rate — DB inaccessible".to_string(), + }; + } + }; + + match tracker.get_failure_rate_7d() { + Ok(rate) => { + let status = if rate >= 0.20 { + CheckStatus::Warn + } else { + CheckStatus::Pass + }; + let pct = (rate * 100.0) as u32; + DoctorCheck { + name: "failure_rate", + status, + detail: format!("{pct}% parse failure rate (last 7 days)"), + } + } + Err(_) => DoctorCheck { + name: "failure_rate", + status: CheckStatus::Pass, + detail: "no command history yet".to_string(), + }, + } +} + +// ── Report assembly ──────────────────────────────────────────────────────── + +pub fn build_report() -> DoctorReport { + let checks = vec![ + check_hook(), + check_db(), + check_path(), + check_config(), + check_failure_rate(), + ]; + + let overall = if checks.iter().any(|c| c.status == CheckStatus::Fail) { + CheckStatus::Fail + } else if checks.iter().any(|c| c.status == CheckStatus::Warn) { + CheckStatus::Warn + } else { + CheckStatus::Pass + }; + + DoctorReport { overall, checks } +} + +// ── Entry point ──────────────────────────────────────────────────────────── + +pub fn run(json: bool) -> anyhow::Result<()> { + let report = build_report(); + + if json { + println!("{}", serde_json::to_string_pretty(&report)?); + return Ok(()); + } + + // Text output + let overall_icon = match report.overall { + CheckStatus::Pass => "✓", + CheckStatus::Warn => "!", + CheckStatus::Fail => "✗", + }; + println!("rtk doctor [{overall_icon}]"); + println!(); + + for check in &report.checks { + let icon = match check.status { + CheckStatus::Pass => "✓", + CheckStatus::Warn => "!", + CheckStatus::Fail => "✗", + }; + println!(" [{icon}] {:<16} {}", check.name, check.detail); + } + println!(); + + match report.overall { + CheckStatus::Pass => println!("All checks passed."), + CheckStatus::Warn => println!("Warnings found — see above."), + CheckStatus::Fail => { + println!("Failures found — see above."); + std::process::exit(1); + } + } + + Ok(()) +} + +// ── Tests ────────────────────────────────────────────────────────────────── + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn check_status_display() { + assert_eq!(CheckStatus::Pass.to_string(), "pass"); + assert_eq!(CheckStatus::Warn.to_string(), "warn"); + assert_eq!(CheckStatus::Fail.to_string(), "fail"); + } + + #[test] + fn check_status_serialize() { + let json = serde_json::to_string(&CheckStatus::Pass).unwrap(); + assert_eq!(json, "\"pass\""); + let json = serde_json::to_string(&CheckStatus::Fail).unwrap(); + assert_eq!(json, "\"fail\""); + } + + #[test] + fn doctor_check_serialize() { + let c = DoctorCheck { + name: "hook", + status: CheckStatus::Pass, + detail: "ok".to_string(), + }; + let json = serde_json::to_string(&c).unwrap(); + assert!(json.contains("\"hook\"")); + assert!(json.contains("\"pass\"")); + assert!(json.contains("\"ok\"")); + } + + #[test] + fn overall_fail_when_any_fail() { + let checks = vec![ + DoctorCheck { + name: "a", + status: CheckStatus::Pass, + detail: String::new(), + }, + DoctorCheck { + name: "b", + status: CheckStatus::Fail, + detail: String::new(), + }, + ]; + let overall = if checks.iter().any(|c| c.status == CheckStatus::Fail) { + CheckStatus::Fail + } else if checks.iter().any(|c| c.status == CheckStatus::Warn) { + CheckStatus::Warn + } else { + CheckStatus::Pass + }; + assert_eq!(overall, CheckStatus::Fail); + } + + #[test] + fn overall_warn_when_no_fail_but_warn() { + let checks = vec![ + DoctorCheck { + name: "a", + status: CheckStatus::Pass, + detail: String::new(), + }, + DoctorCheck { + name: "b", + status: CheckStatus::Warn, + detail: String::new(), + }, + ]; + let overall = if checks.iter().any(|c| c.status == CheckStatus::Fail) { + CheckStatus::Fail + } else if checks.iter().any(|c| c.status == CheckStatus::Warn) { + CheckStatus::Warn + } else { + CheckStatus::Pass + }; + assert_eq!(overall, CheckStatus::Warn); + } + + #[test] + fn overall_pass_when_all_pass() { + let checks = vec![DoctorCheck { + name: "a", + status: CheckStatus::Pass, + detail: String::new(), + }]; + let overall = if checks.iter().any(|c| c.status == CheckStatus::Fail) { + CheckStatus::Fail + } else if checks.iter().any(|c| c.status == CheckStatus::Warn) { + CheckStatus::Warn + } else { + CheckStatus::Pass + }; + assert_eq!(overall, CheckStatus::Pass); + } + + #[test] + fn check_db_returns_valid_check() { + let c = check_db(); + assert_eq!(c.name, "tracking_db"); + // Status is Pass or Fail depending on env — both are valid + assert!(c.status == CheckStatus::Pass || c.status == CheckStatus::Fail); + } + + #[test] + fn check_path_returns_valid_check() { + let c = check_path(); + assert_eq!(c.name, "path"); + assert!(c.status == CheckStatus::Pass || c.status == CheckStatus::Fail); + } + + #[test] + fn check_config_returns_valid_check() { + let c = check_config(); + assert_eq!(c.name, "config"); + assert!(c.status == CheckStatus::Pass || c.status == CheckStatus::Warn); + } + + #[test] + fn check_hook_returns_valid_check() { + let c = check_hook(); + assert_eq!(c.name, "hook"); + assert!( + c.status == CheckStatus::Pass + || c.status == CheckStatus::Warn + || c.status == CheckStatus::Fail + ); + } + + #[test] + fn build_report_has_five_checks() { + let report = build_report(); + assert_eq!(report.checks.len(), 5); + } + + #[test] + fn report_json_roundtrip() { + let report = build_report(); + let json = serde_json::to_string(&report).unwrap(); + assert!(json.contains("\"overall\"")); + assert!(json.contains("\"checks\"")); + assert!(json.contains("\"hook\"")); + } +} diff --git a/src/cmds/system/grep_cmd.rs b/src/cmds/system/grep_cmd.rs index 4550e87747..670173b1f4 100644 --- a/src/cmds/system/grep_cmd.rs +++ b/src/cmds/system/grep_cmd.rs @@ -6,6 +6,7 @@ use crate::core::utils::resolved_command; use anyhow::{Context, Result}; use regex::Regex; use std::collections::HashMap; +use std::process::Stdio; #[allow(clippy::too_many_arguments)] pub fn run( @@ -28,7 +29,9 @@ pub fn run( let rg_pattern = pattern.replace(r"\|", "|"); let mut rg_cmd = resolved_command("rg"); - rg_cmd.args(["-n", "--no-heading", &rg_pattern, path]); + rg_cmd + .args(["-n", "--no-heading", &rg_pattern, path]) + .stdin(Stdio::null()); // fix #897: prevent stdin inheritance from hook pipe if let Some(ft) = file_type { rg_cmd.arg("--type").arg(ft); @@ -47,6 +50,7 @@ pub fn run( .or_else(|_| { resolved_command("grep") .args(["-rn", pattern, path]) + .stdin(Stdio::null()) // fix #897: prevent stdin inheritance .output() }) .context("grep/rg failed")?; diff --git a/src/cmds/system/mod.rs b/src/cmds/system/mod.rs index a7686922b3..96bff180ef 100644 --- a/src/cmds/system/mod.rs +++ b/src/cmds/system/mod.rs @@ -1,6 +1,7 @@ //! General-purpose system command filters. pub mod deps; +pub mod doctor; pub mod env_cmd; pub mod find_cmd; pub mod format_cmd; diff --git a/src/cmds/system/summary.rs b/src/cmds/system/summary.rs index be44f883c6..1f7095c5b2 100644 --- a/src/cmds/system/summary.rs +++ b/src/cmds/system/summary.rs @@ -1,7 +1,7 @@ //! Runs a command and produces a heuristic summary of its output. use crate::core::tracking; -use crate::core::utils::truncate; +use crate::core::utils::{exit_code_from_output, split_command, truncate}; use anyhow::{Context, Result}; use regex::Regex; use std::process::{Command, Stdio}; @@ -20,22 +20,29 @@ pub fn run(command: &str, verbose: u8) -> Result<()> { .stdout(Stdio::piped()) .stderr(Stdio::piped()) .output() + .context("Failed to execute command")? } else { - Command::new("sh") - .args(["-c", command]) + let parts = split_command(command) + .with_context(|| format!("Failed to parse command: {}", command))?; + Command::new(&parts[0]) + .args(&parts[1..]) .stdout(Stdio::piped()) .stderr(Stdio::piped()) .output() - } - .context("Failed to execute command")?; + .context("Failed to execute command")? + }; let stdout = String::from_utf8_lossy(&output.stdout); let stderr = String::from_utf8_lossy(&output.stderr); let raw = format!("{}\n{}", stdout, stderr); + let exit_code = exit_code_from_output(&output, "summary"); let summary = summarize_output(&raw, command, output.status.success()); println!("{}", summary); timer.track(command, "rtk summary", &raw, &summary); + if exit_code != 0 { + std::process::exit(exit_code); + } Ok(()) } @@ -292,9 +299,61 @@ fn summarize_generic(output: &str, result: &mut Vec) { } } +lazy_static::lazy_static! { + // H-1: Pre-compiled regexes — never recompile on each call to extract_number. + // The `after` argument is always one of these four fixed strings. + static ref RE_PASSED: Regex = Regex::new(r"(\d+)\s*passed").unwrap(); + static ref RE_FAILED: Regex = Regex::new(r"(\d+)\s*failed").unwrap(); + static ref RE_SKIPPED: Regex = Regex::new(r"(\d+)\s*skipped").unwrap(); + static ref RE_IGNORED: Regex = Regex::new(r"(\d+)\s*ignored").unwrap(); +} + fn extract_number(text: &str, after: &str) -> Option { - let re = Regex::new(&format!(r"(\d+)\s*{}", after)).ok()?; + let re = match after { + "passed" => &*RE_PASSED, + "failed" => &*RE_FAILED, + "skipped" => &*RE_SKIPPED, + "ignored" => &*RE_IGNORED, + _ => return None, + }; re.captures(text) .and_then(|c| c.get(1)) .and_then(|m| m.as_str().parse().ok()) } + +#[cfg(test)] +mod tests { + use super::*; + + // H-1: extract_number must use pre-compiled regexes (no Regex::new inside function) + #[test] + fn test_extract_number_passed() { + assert_eq!(extract_number("42 passed, 0 failed", "passed"), Some(42)); + } + + #[test] + fn test_extract_number_failed() { + assert_eq!(extract_number("3 failed, 10 passed", "failed"), Some(3)); + } + + #[test] + fn test_extract_number_skipped() { + assert_eq!(extract_number("5 skipped", "skipped"), Some(5)); + } + + #[test] + fn test_extract_number_ignored() { + assert_eq!(extract_number("2 ignored", "ignored"), Some(2)); + } + + #[test] + fn test_extract_number_unknown_returns_none() { + // Unknown keyword — must not panic, must return None + assert_eq!(extract_number("10 tests", "tests"), None); + } + + #[test] + fn test_extract_number_no_match() { + assert_eq!(extract_number("no results here", "passed"), None); + } +} diff --git a/src/core/config.rs b/src/core/config.rs index 99e28c2135..f67c50e2be 100644 --- a/src/core/config.rs +++ b/src/core/config.rs @@ -94,7 +94,8 @@ pub struct TelemetryConfig { impl Default for TelemetryConfig { fn default() -> Self { - Self { enabled: true } + // M-1: disabled by default in this fork — telemetry functionality has been stripped. + Self { enabled: false } } } @@ -129,11 +130,6 @@ pub fn limits() -> LimitsConfig { Config::load().map(|c| c.limits).unwrap_or_default() } -/// Check if telemetry is enabled in config. Returns None if config can't be loaded. -pub fn telemetry_enabled() -> Option { - Config::load().ok().map(|c| c.telemetry.enabled) -} - impl Config { pub fn load() -> Result { let path = get_config_path()?; diff --git a/src/core/mod.rs b/src/core/mod.rs index 0a490aad32..e06f1ede6f 100644 --- a/src/core/mod.rs +++ b/src/core/mod.rs @@ -4,7 +4,6 @@ pub mod config; pub mod display_helpers; pub mod filter; pub mod tee; -pub mod telemetry; pub mod toml_filter; pub mod tracking; pub mod utils; diff --git a/src/core/telemetry.rs b/src/core/telemetry.rs deleted file mode 100644 index 3b9729555d..0000000000 --- a/src/core/telemetry.rs +++ /dev/null @@ -1,338 +0,0 @@ -//! Optional usage ping so we know which commands people run most. - -use crate::core::config; -use crate::core::tracking; -use sha2::{Digest, Sha256}; -use std::io::Write; -use std::path::PathBuf; -use std::sync::OnceLock; - -static CACHED_SALT: OnceLock = OnceLock::new(); - -const TELEMETRY_URL: Option<&str> = option_env!("RTK_TELEMETRY_URL"); -const TELEMETRY_TOKEN: Option<&str> = option_env!("RTK_TELEMETRY_TOKEN"); -const PING_INTERVAL_SECS: u64 = 23 * 3600; // 23 hours - -/// Send a telemetry ping if enabled and not already sent today. -/// Fire-and-forget: errors are silently ignored. -pub fn maybe_ping() { - // No URL compiled in → telemetry disabled - if TELEMETRY_URL.is_none() { - return; - } - - // Check opt-out: env var - if std::env::var("RTK_TELEMETRY_DISABLED").unwrap_or_default() == "1" { - return; - } - - // Check opt-out: config.toml - if let Some(false) = config::telemetry_enabled() { - return; - } - - // Check last ping time - let marker = telemetry_marker_path(); - if let Ok(metadata) = std::fs::metadata(&marker) { - if let Ok(modified) = metadata.modified() { - if let Ok(elapsed) = modified.elapsed() { - if elapsed.as_secs() < PING_INTERVAL_SECS { - return; - } - } - } - } - - // Touch marker file immediately (before sending) to avoid double-ping - touch_marker(&marker); - - // Spawn thread so we never block the CLI - std::thread::spawn(|| { - let _ = send_ping(); - }); -} - -fn send_ping() -> Result<(), Box> { - let url = TELEMETRY_URL.ok_or("no telemetry URL")?; - let device_hash = generate_device_hash(); - let version = env!("CARGO_PKG_VERSION").to_string(); - let os = std::env::consts::OS.to_string(); - let arch = std::env::consts::ARCH.to_string(); - let install_method = detect_install_method(); - - // Get stats from tracking DB - let (commands_24h, top_commands, savings_pct, tokens_saved_24h, tokens_saved_total) = - get_stats(); - - let payload = serde_json::json!({ - "device_hash": device_hash, - "version": version, - "os": os, - "arch": arch, - "install_method": install_method, - "commands_24h": commands_24h, - "top_commands": top_commands, - "savings_pct": savings_pct, - "tokens_saved_24h": tokens_saved_24h, - "tokens_saved_total": tokens_saved_total, - }); - - let mut req = ureq::post(url).set("Content-Type", "application/json"); - - if let Some(token) = TELEMETRY_TOKEN { - req = req.set("X-RTK-Token", token); - } - - // 2 second timeout — if server is down, we move on - req.timeout(std::time::Duration::from_secs(2)) - .send_string(&payload.to_string())?; - - Ok(()) -} - -fn generate_device_hash() -> String { - let salt = get_or_create_salt(); - let hostname = hostname::get() - .map(|h| h.to_string_lossy().to_string()) - .unwrap_or_default(); - let username = std::env::var("USER") - .or_else(|_| std::env::var("USERNAME")) - .unwrap_or_default(); - - let mut hasher = Sha256::new(); - hasher.update(salt.as_bytes()); - hasher.update(b":"); - hasher.update(hostname.as_bytes()); - hasher.update(b":"); - hasher.update(username.as_bytes()); - format!("{:x}", hasher.finalize()) -} - -fn get_or_create_salt() -> String { - CACHED_SALT - .get_or_init(|| { - let salt_path = salt_file_path(); - - if let Ok(contents) = std::fs::read_to_string(&salt_path) { - let trimmed = contents.trim().to_string(); - if trimmed.len() == 64 && trimmed.chars().all(|c| c.is_ascii_hexdigit()) { - return trimmed; - } - } - - let salt = random_salt(); - if let Some(parent) = salt_path.parent() { - let _ = std::fs::create_dir_all(parent); - } - if let Ok(mut f) = std::fs::File::create(&salt_path) { - let _ = f.write_all(salt.as_bytes()); - #[cfg(unix)] - { - use std::os::unix::fs::PermissionsExt; - let _ = std::fs::set_permissions( - &salt_path, - std::fs::Permissions::from_mode(0o600), - ); - } - } - salt - }) - .clone() -} - -fn random_salt() -> String { - let mut buf = [0u8; 32]; - if getrandom::fill(&mut buf).is_err() { - let fallback = format!("{:?}:{}", std::time::SystemTime::now(), std::process::id()); - let mut hasher = Sha256::new(); - hasher.update(fallback.as_bytes()); - return format!("{:x}", hasher.finalize()); - } - buf.iter().map(|b| format!("{:02x}", b)).collect() -} - -fn salt_file_path() -> PathBuf { - dirs::data_local_dir() - .unwrap_or_else(|| PathBuf::from("/tmp")) - .join("rtk") - .join(".device_salt") -} - -fn get_stats() -> (i64, Vec, Option, i64, i64) { - let tracker = match tracking::Tracker::new() { - Ok(t) => t, - Err(_) => return (0, vec![], None, 0, 0), - }; - - let since_24h = chrono::Utc::now() - chrono::Duration::hours(24); - - // Get 24h command count and top commands from tracking DB - let commands_24h = tracker.count_commands_since(since_24h).unwrap_or(0); - - let top_commands = tracker.top_commands(5).unwrap_or_default(); - - let savings_pct = tracker.overall_savings_pct().ok(); - - let tokens_saved_24h = tracker.tokens_saved_24h(since_24h).unwrap_or(0); - - let tokens_saved_total = tracker.total_tokens_saved().unwrap_or(0); - - ( - commands_24h, - top_commands, - savings_pct, - tokens_saved_24h, - tokens_saved_total, - ) -} - -fn detect_install_method() -> &'static str { - let exe = match std::env::current_exe() { - Ok(p) => p, - Err(_) => return "unknown", - }; - let real_path = std::fs::canonicalize(&exe) - .unwrap_or(exe) - .to_string_lossy() - .to_string(); - install_method_from_path(&real_path) -} - -fn install_method_from_path(path: &str) -> &'static str { - if path.contains("/Cellar/rtk/") || path.contains("/homebrew/") { - "homebrew" - } else if path.contains("/.cargo/bin/") || path.contains("\\.cargo\\bin\\") { - "cargo" - } else if path.contains("/.local/bin/") || path.contains("\\.local\\bin\\") { - "script" - } else if path.contains("/nix/store/") { - "nix" - } else { - "other" - } -} - -fn telemetry_marker_path() -> PathBuf { - let data_dir = dirs::data_local_dir() - .unwrap_or_else(|| PathBuf::from("/tmp")) - .join("rtk"); - let _ = std::fs::create_dir_all(&data_dir); - data_dir.join(".telemetry_last_ping") -} - -fn touch_marker(path: &PathBuf) { - let _ = std::fs::write(path, b""); -} - -#[cfg(test)] -mod tests { - use super::*; - - #[test] - fn test_device_hash_is_stable() { - let h1 = generate_device_hash(); - let h2 = generate_device_hash(); - assert_eq!(h1, h2); - assert_eq!(h1.len(), 64); - } - - #[test] - fn test_device_hash_is_valid_hex() { - let hash = generate_device_hash(); - assert!(hash.chars().all(|c| c.is_ascii_hexdigit())); - } - - #[test] - fn test_salt_is_persisted() { - let s1 = get_or_create_salt(); - let s2 = get_or_create_salt(); - assert_eq!(s1, s2); - assert_eq!(s1.len(), 64); - assert!(s1.chars().all(|c| c.is_ascii_hexdigit())); - } - - #[test] - fn test_random_salt_uniqueness() { - let s1 = random_salt(); - let s2 = random_salt(); - assert_ne!(s1, s2); - assert_eq!(s1.len(), 64); - assert_eq!(s2.len(), 64); - } - - #[test] - fn test_salt_file_path_is_in_rtk_dir() { - let path = salt_file_path(); - assert!(path.to_string_lossy().contains("rtk")); - assert!(path.to_string_lossy().contains(".device_salt")); - } - - #[test] - fn test_marker_path_exists() { - let path = telemetry_marker_path(); - assert!(path.to_string_lossy().contains("rtk")); - } - - #[test] - fn test_install_method_unix_paths() { - assert_eq!( - install_method_from_path("/opt/homebrew/Cellar/rtk/0.28.0/bin/rtk"), - "homebrew" - ); - assert_eq!( - install_method_from_path("/usr/local/homebrew/bin/rtk"), - "homebrew" - ); - assert_eq!( - install_method_from_path("/home/user/.cargo/bin/rtk"), - "cargo" - ); - assert_eq!( - install_method_from_path("/home/user/.local/bin/rtk"), - "script" - ); - assert_eq!( - install_method_from_path("/nix/store/abc123-rtk/bin/rtk"), - "nix" - ); - assert_eq!(install_method_from_path("/usr/bin/rtk"), "other"); - } - - #[test] - fn test_install_method_windows_paths() { - assert_eq!( - install_method_from_path("C:\\Users\\user\\.cargo\\bin\\rtk.exe"), - "cargo" - ); - assert_eq!( - install_method_from_path("C:\\Users\\user\\.local\\bin\\rtk.exe"), - "script" - ); - assert_eq!( - install_method_from_path("C:\\Program Files\\rtk\\rtk.exe"), - "other" - ); - } - - #[test] - fn test_detect_install_method_returns_known_value() { - let method = detect_install_method(); - assert!( - ["homebrew", "cargo", "script", "nix", "other", "unknown"].contains(&method), - "Unexpected install method: {}", - method - ); - } - - #[test] - fn test_get_stats_returns_tuple() { - let (cmds, top, pct, saved_24h, saved_total) = get_stats(); - assert!(cmds >= 0); - assert!(top.len() <= 5); - assert!(saved_24h >= 0); - assert!(saved_total >= 0); - if let Some(p) = pct { - assert!((0.0..=100.0).contains(&p)); - } - } -} diff --git a/src/core/tracking.rs b/src/core/tracking.rs index 1cba65fd14..53acc4b01a 100644 --- a/src/core/tracking.rs +++ b/src/core/tracking.rs @@ -478,6 +478,35 @@ impl Tracker { }) } + /// Failure rate (0.0–1.0) for commands in the last 7 days. + /// + /// Returns the fraction of parse failures relative to total commands. + /// Returns `Err` if there is no command history at all. + pub fn get_failure_rate_7d(&self) -> Result { + let cutoff = chrono::Utc::now() + .checked_sub_signed(chrono::Duration::days(7)) + .unwrap_or(chrono::Utc::now()); + let cutoff_str = cutoff.to_rfc3339(); + + let total_cmds: i64 = self.conn.query_row( + "SELECT COUNT(*) FROM commands WHERE timestamp >= ?1", + rusqlite::params![cutoff_str], + |row| row.get(0), + )?; + + if total_cmds == 0 { + return Err(anyhow::anyhow!("no command history")); + } + + let failures: i64 = self.conn.query_row( + "SELECT COUNT(*) FROM parse_failures WHERE timestamp >= ?1", + rusqlite::params![cutoff_str], + |row| row.get(0), + )?; + + Ok(failures as f64 / total_cmds as f64) + } + /// Get overall summary statistics across all recorded commands. /// /// Returns aggregated metrics including: @@ -897,66 +926,6 @@ impl Tracker { Ok(rows.collect::, _>>()?) } - - /// Count commands since a given timestamp (for telemetry). - pub fn count_commands_since(&self, since: chrono::DateTime) -> Result { - let ts = since.format("%Y-%m-%dT%H:%M:%S").to_string(); - let count: i64 = self.conn.query_row( - "SELECT COUNT(*) FROM commands WHERE timestamp >= ?1", - params![ts], - |row| row.get(0), - )?; - Ok(count) - } - - /// Get top N commands by frequency (for telemetry). - pub fn top_commands(&self, limit: usize) -> Result> { - let mut stmt = self.conn.prepare( - "SELECT rtk_cmd, COUNT(*) as cnt FROM commands - GROUP BY rtk_cmd ORDER BY cnt DESC LIMIT ?1", - )?; - let rows = stmt.query_map(params![limit as i64], |row| { - let cmd: String = row.get(0)?; - // Extract just the command name (e.g. "rtk git status" → "git") - Ok(cmd.split_whitespace().nth(1).unwrap_or(&cmd).to_string()) - })?; - Ok(rows.filter_map(|r| r.ok()).collect()) - } - - /// Get overall savings percentage (for telemetry). - pub fn overall_savings_pct(&self) -> Result { - let (total_input, total_saved): (i64, i64) = self.conn.query_row( - "SELECT COALESCE(SUM(input_tokens), 0), COALESCE(SUM(saved_tokens), 0) FROM commands", - [], - |row| Ok((row.get(0)?, row.get(1)?)), - )?; - if total_input > 0 { - Ok((total_saved as f64 / total_input as f64) * 100.0) - } else { - Ok(0.0) - } - } - - /// Get total tokens saved across all tracked commands (for telemetry). - pub fn total_tokens_saved(&self) -> Result { - let saved: i64 = self.conn.query_row( - "SELECT COALESCE(SUM(saved_tokens), 0) FROM commands", - [], - |row| row.get(0), - )?; - Ok(saved) - } - - /// Get tokens saved in the last 24 hours (for telemetry). - pub fn tokens_saved_24h(&self, since: chrono::DateTime) -> Result { - let ts = since.format("%Y-%m-%dT%H:%M:%S").to_string(); - let saved: i64 = self.conn.query_row( - "SELECT COALESCE(SUM(saved_tokens), 0) FROM commands WHERE timestamp >= ?1", - params![ts], - |row| row.get(0), - )?; - Ok(saved) - } } fn get_db_path() -> Result { diff --git a/src/core/utils.rs b/src/core/utils.rs index c1882fa81b..d5cf676c5d 100644 --- a/src/core/utils.rs +++ b/src/core/utils.rs @@ -207,6 +207,20 @@ pub fn ok_confirmation(action: &str, detail: &str) -> String { } } +/// Split a shell command string into binary + arguments using POSIX word splitting. +/// +/// Unlike `sh -c`, this does NOT interpret shell metacharacters (`;`, `&&`, `||`, `|`). +/// Each token is passed as a literal argument to the subprocess — no shell injection possible. +/// +/// # Errors +/// Returns an error if the command string is empty or has unmatched quotes. +pub fn split_command(command: &str) -> Result> { + if command.trim().is_empty() { + anyhow::bail!("Empty command string"); + } + shell_words::split(command).with_context(|| format!("Failed to parse command: {}", command)) +} + /// Extract exit code from a process output. Returns the actual exit code, or /// `128 + signal` per Unix convention when terminated by a signal (no exit code /// available). Falls back to 1 on non-Unix platforms. @@ -228,6 +242,26 @@ pub fn exit_code_from_output(output: &std::process::Output, label: &str) -> i32 } } +/// Extract exit code from an ExitStatus. Returns the actual exit code, or +/// `128 + signal` per Unix convention when terminated by a signal. +pub fn exit_code_from_status(status: &std::process::ExitStatus, label: &str) -> i32 { + match status.code() { + Some(code) => code, + None => { + #[cfg(unix)] + { + use std::os::unix::process::ExitStatusExt; + if let Some(sig) = status.signal() { + eprintln!("[rtk] {}: process terminated by signal {}", label, sig); + return 128 + sig; + } + } + eprintln!("[rtk] {}: process terminated by signal", label); + 1 + } + } +} + /// Return the last `n` lines of output with a label, for use as a fallback /// when filter parsing fails. Logs a diagnostic to stderr. pub fn fallback_tail(output: &str, label: &str, n: usize) -> String { @@ -337,28 +371,33 @@ pub fn resolve_binary(name: &str) -> Result { /// # Returns /// A `Command` configured with the resolved binary path. pub fn resolved_command(name: &str) -> Command { - match resolve_binary(name) { + let mut cmd = match resolve_binary(name) { Ok(path) => Command::new(path), - Err(e) => { + Err(_e) => { // On Windows, resolution failure likely means a .CMD/.BAT wrapper // wasn't found — always warn so users have a signal. // On Unix, this is less common; only log in debug builds. #[cfg(target_os = "windows")] eprintln!( "rtk: Failed to resolve '{}' via PATH, falling back to direct exec: {}", - name, e + name, _e ); #[cfg(not(target_os = "windows"))] { #[cfg(debug_assertions)] eprintln!( "rtk: Failed to resolve '{}' via PATH, falling back to direct exec: {}", - name, e + name, _e ); } Command::new(name) } - } + }; + // fix #897 (global): prevent all subprocesses from inheriting the hook pipe's + // stdin. Without this, children block on EOF and leak memory. Commands that + // need stdin can override with .stdin(Stdio::piped()) after this call. + cmd.stdin(std::process::Stdio::null()); + cmd } /// Check if a tool exists on PATH (PATHEXT-aware on Windows). @@ -368,6 +407,26 @@ pub fn tool_exists(name: &str) -> bool { which::which(name).is_ok() } +/// Return the git worktree root for the current directory, or fall back to CWD. +/// +/// Uses `git rev-parse --show-toplevel` which returns the worktree root (not the +/// main repo root), making this safe for use inside git worktrees. +/// +/// Used by `rtk init --codex` to anchor RTK.md and AGENTS.md to the repo root +/// rather than the process CWD — fixes #892. +pub fn git_worktree_root() -> std::path::PathBuf { + std::process::Command::new("git") + .args(["rev-parse", "--show-toplevel"]) + .stdin(std::process::Stdio::null()) + .output() + .ok() + .filter(|o| o.status.success()) + .and_then(|o| String::from_utf8(o.stdout).ok()) + .map(|s| std::path::PathBuf::from(s.trim())) + // M-2: unwrap_or_default() returns an empty path on failure; use "." instead. + .unwrap_or_else(|| std::env::current_dir().unwrap_or_else(|_| PathBuf::from("."))) +} + #[cfg(test)] mod tests { use super::*; diff --git a/src/hooks/init.rs b/src/hooks/init.rs index 438aca7a07..6920b646db 100644 --- a/src/hooks/init.rs +++ b/src/hooks/init.rs @@ -7,7 +7,6 @@ use std::path::{Path, PathBuf}; use tempfile::NamedTempFile; use super::integrity; -use crate::core::config; // Embedded hook script (guards before set -euo pipefail) const REWRITE_HOOK: &str = include_str!("../../hooks/claude/rtk-rewrite.sh"); @@ -283,14 +282,6 @@ pub fn run( } println!(); - let env_disabled = std::env::var("RTK_TELEMETRY_DISABLED").unwrap_or_default() == "1"; - let config_disabled = matches!(config::telemetry_enabled(), Some(false)); - if env_disabled || config_disabled { - println!(" [info] Anonymous telemetry is disabled"); - } else { - println!(" [info] Anonymous telemetry is enabled by default (opt-out: RTK_TELEMETRY_DISABLED=1)"); - } - println!(" [info] See: https://github.com/rtk-ai/rtk#privacy--telemetry"); Ok(()) } @@ -630,7 +621,12 @@ pub fn uninstall(global: bool, gemini: bool, codex: bool, cursor: bool, verbose: removed.push(format!("OpenCode plugin: {}", path.display())); } - // 6. Remove Cursor hooks + // 6. Remove Codex global instructions + if let Ok(codex_dir) = resolve_codex_dir() { + removed.extend(uninstall_codex_at(&codex_dir, verbose)?); + } + + // 7. Remove Cursor hooks let cursor_removed = remove_cursor_hooks(verbose)?; removed.extend(cursor_removed); @@ -919,7 +915,10 @@ fn run_default_mode( // 3. Patch CLAUDE.md (add @RTK.md, migrate if needed) let migrated = patch_claude_md(&claude_md_path, verbose)?; - // 4. Print success message + // 4. Also configure Codex so one global init covers both CLIs. + let codex_added_ref = install_codex_instructions(true, verbose)?; + + // 5. Print success message let hook_status = if hook_changed { "installed/updated" } else { @@ -932,13 +931,18 @@ fn run_default_mode( println!(" OpenCode: {}", path.display()); } println!(" CLAUDE.md: @RTK.md reference added"); + if codex_added_ref { + println!(" Codex: ~/.codex/AGENTS.md + ~/.codex/RTK.md configured"); + } else { + println!(" Codex: ~/.codex/AGENTS.md already references @RTK.md"); + } if migrated { println!("\n [ok] Migrated: removed 137-line RTK block from CLAUDE.md"); println!(" replaced with @RTK.md (10 lines)"); } - // 5. Patch settings.json + // 6. Patch settings.json let patch_result = patch_settings_json(&hook_path, patch_mode, verbose, install_opencode)?; // Report result @@ -959,7 +963,7 @@ fn run_default_mode( } } - // 6. Generate user-global filters template (~/.config/rtk/filters.toml) + // 7. Generate user-global filters template (~/.config/rtk/filters.toml) generate_global_filters_template(verbose)?; println!(); // Final newline @@ -1246,27 +1250,16 @@ fn run_windsurf_mode(verbose: u8) -> Result<()> { } fn run_codex_mode(global: bool, verbose: u8) -> Result<()> { + let added_ref = install_codex_instructions(global, verbose)?; + let (agents_md_path, rtk_md_path) = if global { let codex_dir = resolve_codex_dir()?; (codex_dir.join("AGENTS.md"), codex_dir.join("RTK.md")) } else { - (PathBuf::from("AGENTS.md"), PathBuf::from("RTK.md")) + let root = crate::core::utils::git_worktree_root(); + (root.join("AGENTS.md"), root.join("RTK.md")) }; - if global { - if let Some(parent) = agents_md_path.parent() { - fs::create_dir_all(parent).with_context(|| { - format!( - "Failed to create Codex config directory: {}", - parent.display() - ) - })?; - } - } - - write_if_changed(&rtk_md_path, RTK_SLIM_CODEX, "RTK.md", verbose)?; - let added_ref = patch_agents_md(&agents_md_path, verbose)?; - println!("\nRTK configured for Codex CLI.\n"); println!(" RTK.md: {}", rtk_md_path.display()); if added_ref { @@ -1289,6 +1282,30 @@ fn run_codex_mode(global: bool, verbose: u8) -> Result<()> { Ok(()) } +fn install_codex_instructions(global: bool, verbose: u8) -> Result { + let (agents_md_path, rtk_md_path) = if global { + let codex_dir = resolve_codex_dir()?; + (codex_dir.join("AGENTS.md"), codex_dir.join("RTK.md")) + } else { + // fix #892: anchor to git worktree root so the files are found when + // Codex is run from any worktree, not just the directory where rtk init ran. + let root = crate::core::utils::git_worktree_root(); + (root.join("AGENTS.md"), root.join("RTK.md")) + }; + + if let Some(parent) = agents_md_path.parent() { + fs::create_dir_all(parent).with_context(|| { + format!( + "Failed to create Codex config directory: {}", + parent.display() + ) + })?; + } + + write_if_changed(&rtk_md_path, RTK_SLIM_CODEX, "RTK.md", verbose)?; + patch_agents_md(&agents_md_path, verbose) +} + // --- upsert_rtk_block: idempotent RTK block management --- #[derive(Debug, Clone, Copy, PartialEq)] @@ -2023,9 +2040,34 @@ fn show_claude_config() -> Result<()> { println!("[--] Cursor: home dir not found"); } + // Check Codex global instructions + if let Ok(codex_dir) = resolve_codex_dir() { + let codex_rtk_md = codex_dir.join("RTK.md"); + let codex_agents_md = codex_dir.join("AGENTS.md"); + + if codex_rtk_md.exists() { + println!("[ok] Codex RTK.md: {}", codex_rtk_md.display()); + } else { + println!("[--] Codex RTK.md: not found"); + } + + if codex_agents_md.exists() { + let content = fs::read_to_string(&codex_agents_md)?; + if content.contains("@RTK.md") { + println!("[ok] Codex AGENTS.md: @RTK.md reference"); + } else { + println!("[--] Codex AGENTS.md: exists but rtk not configured"); + } + } else { + println!("[--] Codex AGENTS.md: not found"); + } + } else { + println!("[--] Codex: home dir not found"); + } + println!("\nUsage:"); println!(" rtk init # Full injection into local CLAUDE.md"); - println!(" rtk init -g # Hook + RTK.md + @RTK.md + settings.json (recommended)"); + println!(" rtk init -g # Claude hook + Codex instructions (recommended)"); println!(" rtk init -g --auto-patch # Same as above but no prompt"); println!(" rtk init -g --no-patch # Skip settings.json (manual setup)"); println!(" rtk init -g --uninstall # Remove all RTK artifacts"); @@ -2686,6 +2728,23 @@ More notes assert_eq!(content.matches("@RTK.md").count(), 1); } + #[test] + fn test_install_codex_instructions_creates_both_files() { + let temp = TempDir::new().unwrap(); + let cwd = std::env::current_dir().unwrap(); + std::env::set_current_dir(temp.path()).unwrap(); + + let added = install_codex_instructions(false, 0).unwrap(); + + let agents_md = temp.path().join("AGENTS.md"); + let rtk_md = temp.path().join("RTK.md"); + assert!(added); + assert_eq!(fs::read_to_string(&agents_md).unwrap(), "@RTK.md\n"); + assert_eq!(fs::read_to_string(&rtk_md).unwrap(), RTK_SLIM_CODEX); + + std::env::set_current_dir(cwd).unwrap(); + } + #[test] fn test_uninstall_codex_at_is_idempotent() { let temp = TempDir::new().unwrap(); diff --git a/src/hooks/permissions.rs b/src/hooks/permissions.rs index 52fad6a486..37aef7beef 100644 --- a/src/hooks/permissions.rs +++ b/src/hooks/permissions.rs @@ -12,14 +12,34 @@ pub enum PermissionVerdict { Ask, } -/// Check `cmd` against Claude Code's deny/ask permission rules. +/// Check `cmd` against Claude Code's deny/ask/allow permission rules. /// -/// Returns `Allow` when no rules match (preserves existing behavior), -/// `Deny` when a deny rule matches, or `Ask` when an ask rule matches. +/// Returns `Allow` when no rules match and no allow list is configured, +/// `Deny` when a deny rule matches, `Ask` when an ask rule matches or when +/// an allow list is configured and the command is not on it. /// Deny takes priority over Ask if both match the same command. pub fn check_command(cmd: &str) -> PermissionVerdict { let (deny_rules, ask_rules) = load_deny_ask_rules(); - check_command_with_rules(cmd, &deny_rules, &ask_rules) + let verdict = check_command_with_rules(cmd, &deny_rules, &ask_rules); + + // fix #886: if the user has configured an explicit allow list, enforce it. + // Any command not on the allow list falls through to Ask (requires confirmation), + // matching Claude Code's documented whitelist-by-default behaviour. + // Backward-compatible: no allow list configured → existing Allow behaviour preserved. + if verdict == PermissionVerdict::Allow { + if let Some(allow_rules) = load_allow_rules() { + let segments = split_compound_command(cmd); + let all_allowed = segments.iter().all(|seg| { + let seg = seg.trim(); + seg.is_empty() || allow_rules.iter().any(|p| command_matches_pattern(seg, p)) + }); + if !all_allowed { + return PermissionVerdict::Ask; + } + } + } + + verdict } /// Internal implementation allowing tests to inject rules without file I/O. @@ -91,6 +111,35 @@ fn load_deny_ask_rules() -> (Vec, Vec) { (deny_rules, ask_rules) } +/// Load the allow list from Claude Code settings files. +/// +/// Returns `None` when no allow list is configured — preserving existing behaviour +/// where RTK auto-allows any command not explicitly denied. +/// Returns `Some(patterns)` when an allow list is present; callers must confirm +/// the command matches at least one pattern before auto-allowing. +fn load_allow_rules() -> Option> { + let mut allow_rules = Vec::new(); + + for path in get_settings_paths() { + let Ok(content) = std::fs::read_to_string(&path) else { + continue; + }; + let Ok(json) = serde_json::from_str::(&content) else { + continue; + }; + let Some(permissions) = json.get("permissions") else { + continue; + }; + append_bash_rules(permissions.get("allow"), &mut allow_rules); + } + + if allow_rules.is_empty() { + None + } else { + Some(allow_rules) + } +} + /// Extract Bash-scoped patterns from a JSON array and append them to `target`. /// /// Only rules with a `Bash(...)` prefix are kept. Non-Bash rules (e.g. `Read(...)`) are ignored. @@ -458,4 +507,52 @@ mod tests { PermissionVerdict::Deny ); } + + // fix #886: allow list enforcement via check_command_with_rules + // (tests the logic layer; file I/O is skipped by using the internal fn directly) + + #[test] + fn test_no_allow_list_preserves_allow_verdict() { + // When load_allow_rules returns None (no allow list configured), + // commands not matching deny/ask return Allow — backward-compatible. + assert_eq!( + check_command_with_rules("ls -la", &[], &[]), + PermissionVerdict::Allow + ); + } + + #[test] + fn test_allow_list_logic_match() { + // Simulate the allow-list gate: command IS on the allow list → Allow. + let allow_rules = vec!["ls".to_string(), "git status".to_string()]; + let matched = allow_rules + .iter() + .any(|p| command_matches_pattern("ls -la", p)); + assert!(matched, "ls -la should match allow pattern 'ls'"); + } + + #[test] + fn test_allow_list_logic_no_match() { + // Command is NOT on the allow list → should become Ask (not Allow). + let allow_rules = vec!["git status".to_string()]; + let matched = allow_rules + .iter() + .any(|p| command_matches_pattern("rm -rf /tmp/foo", p)); + assert!( + !matched, + "rm should not match allow list containing only 'git status'" + ); + } + + #[test] + fn test_allow_list_wildcard() { + // Wildcard allow rules work correctly. + let allow_rules = vec!["git *".to_string()]; + assert!(allow_rules + .iter() + .any(|p| command_matches_pattern("git log -10", p))); + assert!(!allow_rules + .iter() + .any(|p| command_matches_pattern("rm -rf /", p))); + } } diff --git a/src/learn/report.rs b/src/learn/report.rs index 6ec0b442cd..897b9cdc02 100644 --- a/src/learn/report.rs +++ b/src/learn/report.rs @@ -83,7 +83,11 @@ pub fn write_rules_file(rules: &[CorrectionRule], path: &str) -> Result<()> { base_commands.sort(); for base_cmd in base_commands { - let rules_for_cmd = grouped.get(&base_cmd).unwrap(); + // M-3: base_cmd is derived from grouped.keys() so it is always present; + // skip defensively rather than panic on a logic error. + let Some(rules_for_cmd) = grouped.get(&base_cmd) else { + continue; + }; // Capitalize first letter for section header let section_header = capitalize_first(&base_cmd); diff --git a/src/main.rs b/src/main.rs index e43f92676d..856ecc1444 100644 --- a/src/main.rs +++ b/src/main.rs @@ -19,8 +19,8 @@ use cmds::python::{mypy_cmd, pip_cmd, pytest_cmd, ruff_cmd}; use cmds::ruby::{rake_cmd, rspec_cmd, rubocop_cmd}; use cmds::rust::{cargo_cmd, runner}; use cmds::system::{ - deps, env_cmd, find_cmd, format_cmd, grep_cmd, json_cmd, local_llm, log_cmd, ls, read, summary, - tree, wc_cmd, + deps, doctor, env_cmd, find_cmd, format_cmd, grep_cmd, json_cmd, local_llm, log_cmd, ls, read, + summary, tree, wc_cmd, }; use anyhow::{Context, Result}; @@ -431,6 +431,13 @@ enum Commands { create: bool, }, + /// Health check: hook status, DB, PATH, config, failure rate + Doctor { + /// Output as JSON (for token-diet integration) + #[arg(long)] + json: bool, + }, + /// Vitest commands with compact output Vitest { #[command(subcommand)] @@ -1106,7 +1113,7 @@ fn run_fallback(parse_error: clap::Error) -> Result<()> { core::tee::tee_and_hint( &stdout_raw, &raw_command, - output.status.code().unwrap_or(1), + core::utils::exit_code_from_output(&output, &raw_command), ) } else { None @@ -1127,7 +1134,7 @@ fn run_fallback(parse_error: clap::Error) -> Result<()> { core::tracking::record_parse_failure_silent(&raw_command, &error_message, true); if !output.status.success() { - std::process::exit(output.status.code().unwrap_or(1)); + std::process::exit(core::utils::exit_code_from_output(&output, &raw_command)); } } Err(e) => { @@ -1233,9 +1240,6 @@ fn shell_split(input: &str) -> Vec { } fn main() -> Result<()> { - // Fire-and-forget telemetry ping (1/day, non-blocking) - core::telemetry::maybe_ping(); - let cli = match Cli::try_parse() { Ok(cli) => cli, Err(e) => { @@ -1247,8 +1251,11 @@ fn main() -> Result<()> { }; // Warn if installed hook is outdated/missing (1/day, non-blocking). - // Skip for Gain — it shows its own inline hook warning. - if !matches!(cli.command, Commands::Gain { .. }) { + // Skip for Gain (shows its own inline warning) and Doctor (reports hook status itself). + if !matches!( + cli.command, + Commands::Gain { .. } | Commands::Doctor { .. } + ) { hooks::hook_check::maybe_warn(); } @@ -1767,6 +1774,10 @@ fn main() -> Result<()> { } } + Commands::Doctor { json } => { + doctor::run(json)?; + } + Commands::Vitest { command } => match command { VitestCommands::Run { args } => { vitest_cmd::run(vitest_cmd::VitestCommand::Run, &args, cli.verbose)?; @@ -1947,7 +1958,10 @@ fn main() -> Result<()> { &format!("rtk npx {} (passthrough)", args_str), ); if !status.success() { - std::process::exit(status.code().unwrap_or(1)); + std::process::exit(core::utils::exit_code_from_status( + &status, + &format!("npx {}", args_str), + )); } } } @@ -1959,7 +1973,10 @@ fn main() -> Result<()> { .context("Failed to run npx prisma")?; timer.track_passthrough("npx prisma", "rtk npx prisma (passthrough)"); if !status.success() { - std::process::exit(status.code().unwrap_or(1)); + std::process::exit(core::utils::exit_code_from_status( + &status, + "npx prisma", + )); } } } @@ -2185,7 +2202,7 @@ fn main() -> Result<()> { // Exit with same code as child process if !status.success() { - std::process::exit(status.code().unwrap_or(1)); + std::process::exit(core::utils::exit_code_from_status(&status, "proxy")); } }