2e401ac38f
fix(docs): add missing docs for exclude commands patterns
2026-04-19 13:59:03 +02:00
4c9b528206
docs: Adrien review — hierarchy, counts, consistency, gaps
...
Hierarchy:
- Move troubleshooting.md and what-rtk-covers.md to guide/resources/
- Add guide/resources/telemetry.md (adapted from docs/TELEMETRY.md,
user-facing: consent, opt-out, GDPR rights — without internal sections)
Content fixes:
- Remove all hardcoded counts (9 ecosystems, 12 agents, 60+, 7 more)
replaced with qualitative language throughout
- Unify DB filename: tracking.db → history.db everywhere
(canonical: src/core/constants.rs HISTORY_DB)
- installation.md: replace bare `cargo install rtk` with warning +
explicit git URL to avoid Rust Type Kit name collision
- supported-agents.md: remove hardcoded agent count
- quick-start.md: remove hardcoded ecosystem list, link to what-rtk-covers
New content:
- gain.md: add --quota section explaining pro/5x/20x tier meanings
- gain.md: add callout linking to discover.md (find missed savings)
- index.md: add "Analyze your usage" section (rtk discover, rtk session)
- configuration.md: clarify ignore_dirs/ignore_files scope, add prose
link to telemetry.md
- what-rtk-covers.md: clarify --ultra-compact vs git -u short flag conflict
Cross-references:
- All internal links updated for new resources/ paths
- index.md: link to troubleshooting, telemetry, what-rtk-covers, analytics
- discover.md: updated relative link to troubleshooting
README:
- Add Core team section (Patrick Szymkowiak, Florian Bruniaux, Adrien Eppling)
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com >
2026-04-14 14:17:58 +02:00
9e96caa0a1
Merge pull request #355 from KuSh/pnpx+dlx
...
feat(discover): handle more npm/npx/pnpm/pnpx patterns
2026-04-13 20:31:12 +02:00
4093d5c13d
Merge pull request #1094 from rtk-ai/docs/windows-instructions
2026-04-13 09:26:05 +02:00
45938b2a4d
feat(js): distinguish between jest and vitest and don't rewrite npm test commands as we don't know which test framework is used under the hood
...
Signed-off-by: Nicolas Le Cam <niko.lecam@gmail.com >
2026-04-12 22:03:39 +02:00
cce04811c7
Update troubleshooting.md
2026-04-10 14:22:19 +02:00
b73506867e
docs: add Windows setup instructions and troubleshooting
...
Windows users downloading the pre-built binary had no guidance —
double-clicking rtk.exe flashes a terminal and exits immediately.
- README: add warning under Windows binary link, add full Windows section
with WSL vs native comparison table
- installation.md: add pre-built binaries section with Windows note
- supported-agents.md: add Windows support section (CLAUDE.md fallback)
- troubleshooting.md: add "double-click does nothing" and "hook not working"
entries for Windows users
Prompted by Discord user report (PedroLyra).
Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu >
2026-04-09 09:30:58 +02:00
d0a3797ec5
feat(init): add native support for Kilo Code and Google Antigravity
...
Add rtk init --agent kilocode and rtk init --agent antigravity commands.
Kilo Code: installs .kilocode/rules/rtk-rules.md (project-scoped)
Google Antigravity: installs .agents/rules/antigravity-rtk-rules.md (project-scoped)
Both follow the same prompt-level guidance pattern as Cline and Windsurf,
using rules files that instruct the agent to prefix shell commands with rtk.
2026-04-08 15:37:29 -05:00
6e55f8984c
docs: address Adrien's review — structure, missing content, agents
...
Structure:
- Move docs/README.md → .github/docs-pipeline-contract.md (interface
contract is not user-facing content)
- Rewrite docs/guide/index.md as a proper landing page with RTK intro,
flow diagram, and navigation (replaces empty nav stub)
- Move configuration.md → getting-started/configuration.md (sidebar order 4,
after supported-agents per Adrien's suggestion)
Missing content:
- Add docs/guide/analytics/discover.md: rtk discover (missed savings analysis)
and rtk session (adoption tracking across sessions)
- Add uninstall instructions to installation.md (rtk init -g --uninstall,
cargo uninstall, brew uninstall)
- Add global flags section to what-rtk-covers.md (-u/--ultra-compact,
-v/--verbose)
- Add rtk smart command to what-rtk-covers.md Files section
Agents:
- Update supported-agents.md: 10 agents (was 9)
- Add OpenClaw (TypeScript plugin, before_tool_call)
- Add Mistral Vibe (planned, issue #800 )
- Fix GitHub Copilot: VS Code = transparent rewrite via PreToolUse,
Copilot CLI = deny-with-suggestion (upstream limitation)
Signed-off-by: Florian BRUNIAUX <florian@bruniaux.com >
2026-04-06 11:16:24 +02:00
a94e9493b3
docs: consolidate to user-facing guide, remove duplicates and legacy flat docs
...
- Remove docs/reference/ (10 files): duplicates CONTRIBUTING.md, SECURITY.md,
ARCHITECTURE.md, src/*/README.md (distributed pattern from PR #869 )
- Remove docs/architecture/ (5 files): duplicates ARCHITECTURE.md ADRs and diagrams
- Remove docs/guide/commands/ (12 files): showed rtk <cmd> syntax users never type
(hooks rewrite transparently); content was derived from FEATURES.md
- Remove docs/guide/filters/ (2 files): contributor content, belongs with src/filters/
- Remove docs/guide/analytics/discover.md, economics.md: implementation details
- Remove legacy flat docs/ (6 files): FEATURES.md (FR), TECHNICAL.md, TROUBLESHOOTING.md,
AUDIT_GUIDE.md, tracking.md, filter-workflow.md — all superseded by guide/ rewrites
or codebase distributed docs
- Add docs/guide/what-rtk-covers.md: replaces 12 command pages with one user-facing
overview of 60+ commands by ecosystem, no rtk <cmd> syntax
- Enrich docs/guide/analytics/gain.md: absorb advanced workflows from AUDIT_GUIDE.md
(CI integration, pandas analysis, cron snapshots)
- Adapt docs/guide/getting-started/quick-start.md: remove rtk <cmd> examples,
explain hook transparency instead
- Update docs/README.md: single-tab contract, pointer to codebase for technical docs
- Update docs/guide/index.md: clean navigation matching final structure
- Add Mermaid diagrams to src/filters/README.md: build pipeline + filter lookup
(preserves content from filter-workflow.md in its natural home)
Result: 9 files in docs/guide/ (was 39), zero legacy flat docs, zero duplicates.
Codebase distributed docs (ARCHITECTURE.md, CONTRIBUTING.md, src/*/README.md)
remain the source of truth for technical and contributor content.
Signed-off-by: Florian BRUNIAUX <florian@bruniaux.com >
2026-04-05 21:26:07 +02:00
974db2ff0b
docs(phase-4): complete reference, architecture tabs and remaining commands
...
Guide — 10 new command and analytics pages:
- commands/go.md: go test (NDJSON), golangci-lint
- commands/ruby.md: rspec, rubocop, rake
- commands/dotnet.md: dotnet build/test, binlog, format
- commands/containers.md: docker ps/images/logs/compose, kubectl pods/services/logs
- commands/github-cli.md: gh pr/issue/run, Graphite gt commands
- commands/data.md: json, env, log, curl, wget, aws, psql, summary
- commands/utilities.md: proxy passthrough, global flags, RTK_DISABLED
- filters/creating-filters.md: TOML DSL guide, field reference, inline tests
- analytics/discover.md: rtk discover — missed savings analysis
- analytics/economics.md: rtk cc-economics — dollar savings vs ccusage
Reference tab (9 pages):
- contributing/guide.md: design philosophy, PR process, TOML vs Rust decision
- contributing/security.md: vulnerability reporting, dangerous patterns, dep criteria
- contributing/coding-standards.md: Rust rules, error handling, lazy_static, fallback pattern
- contributing/testing.md: snapshot tests, token accuracy, cross-platform, benchmarks
- internals/command-routing.md: 6-phase lifecycle, exit codes, verbosity, module map
- internals/filter-pipeline.md: 12 filtering strategies, TOML stages, savings by ecosystem
- internals/tracking-system.md: SQLite schema, data flow, token estimation, Tracker API
- internals/hook-engine.md: rewrite registry, compound commands, exit code contract, rtk init
- toml-dsl/specification.md: complete field reference, pipeline order, build compilation
Architecture tab (4 pages):
- diagrams/command-flow.md: end-to-end Mermaid — hook → RTK → LLM
- diagrams/filter-pipeline.md: build pipeline + 8-stage runtime Mermaid
- decisions/why-no-async.md: ADR — single-threaded, <10ms startup constraint
- decisions/proxy-architecture.md: ADR — why CLI proxy over aliases/LD_PRELOAD/hooks-only
All pages carry valid frontmatter (title, description, sidebar.order).
No existing files modified.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com >
Signed-off-by: Florian BRUNIAUX <florian@bruniaux.com >
2026-04-05 00:18:59 +02:00
25438b29ae
docs(guide): add 11 Phase 1 guide pages — full MVP content
...
Creates the complete user-facing guide for the docs website:
Getting started:
- quick-start.md: 5-minute walkthrough (init, first commands, rtk gain)
- supported-agents.md: Claude Code, Cursor, Copilot, Gemini, Cline, Windsurf,
Codex, OpenCode — integration tiers, install commands, graceful degradation
Commands (adapted from FEATURES.md, English, --help-first format):
- git.md: status/log/diff/show/add/commit/push/pull/branch + gh CLI
- cargo.md: test/nextest/build/check/clippy/install + generic test/err wrappers
- files.md: ls/read/grep/find/diff/wc/smart with before/after examples
- javascript.md: vitest/playwright/tsc/eslint/prettier/next/pnpm/npm/npx/prisma
- python.md: pytest/ruff/mypy/pip/deps
Reference:
- filters/using-filters.md: 8-stage pipeline, lookup priority, TOML DSL reference,
Mermaid diagram (adapted from docs/filter-workflow.md)
- analytics/gain.md: rtk gain flags, daily/weekly/monthly breakdowns, export
formats, token estimation, database management (from docs/AUDIT_GUIDE.md)
- configuration.md: full config.toml reference, env vars, tee system, telemetry
- troubleshooting.md: common issues and fixes (from docs/TROUBLESHOOTING.md)
All pages carry valid frontmatter (title, description, sidebar.order).
No existing files modified.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com >
Signed-off-by: Florian BRUNIAUX <florian@bruniaux.com >
2026-04-05 00:09:14 +02:00
9c9879c2da
docs: add interface contract and Phase 0 stubs for docs reorganization
...
Creates docs/README.md (interface contract defining 3-tab structure,
required frontmatter, and conventions) and 4 stub pages with valid
frontmatter for docs/guide/, docs/reference/, and docs/architecture/.
These are the prerequisites for the prepare-docs.mjs pipeline (Plan B)
and for Adrien's Phase 1 content work.
No existing files modified.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com >
Signed-off-by: Florian BRUNIAUX <florian@bruniaux.com >
2026-04-04 23:54:16 +02:00
aesoft