Skip to content

Commit 1bb5409

Browse files
committed
Remove stale --all/-a flag from README and SKILL.md
The --all flag was removed in b94e574 but the documentation wasn't updated. This caused agents using the skill to fail 38% of grox calls by repeatedly trying -a → --all → fallback on every lookup. Also adds --recursive/-r flag and other missing flags to both files.
1 parent 7bdeddb commit 1bb5409

2 files changed

Lines changed: 7 additions & 8 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ A [hash map] implemented with quadratic probing and SIMD lookup.
7474
By default, HashMap uses a hashing algorithm selected to provide
7575
resistance against HashDoS attacks. ...
7676
77-
Methods: (showing 15 of 38, use --all to expand)
77+
Methods:
7878
pub fn capacity(&self) -> usize Returns the number of elements the map can hold ...
7979
pub fn clear(&mut self) Clears the map, removing all key-value pairs.
8080
pub fn contains_key<Q>(&self, k: &Q) -> bool Returns `true` if the map contains a value for ...
@@ -92,7 +92,7 @@ LLM coding agents and humans both need fast, token-efficient access to crate doc
9292
- **Path is the query.** `grox serde::Deserialize` — no subcommands.
9393
- **Smart defaults.** Output adapts by item kind (struct, module, function, etc.).
9494
- **Progressive disclosure.** Crate -> module -> type -> method drill-down.
95-
- **Token-efficient.** Truncation by default, `--all` to expand.
95+
- **Token-efficient.** Output adapted per item kind for concise results.
9696
- **Zero setup.** Auto-builds and caches index on first use.
9797
- **Auto-fetch.** Unknown crates are fetched from crates.io automatically — works outside a project.
9898
- **Standard library.** Query `std`, `core`, and `alloc` directly — works anywhere.
@@ -193,12 +193,12 @@ grox [OPTIONS] [PATH]
193193
|------|-------|-------------|
194194
| `--source` | `-s` | Show source code instead of docs |
195195
| `--list` | `-l` | List children only (names + one-line summaries) |
196-
| `--all` | `-a` | Expand everything (full docs, no truncation) |
197196
| `--search <QUERY>` | `-S` | Full-text search across documentation |
198197
| `--kind <KIND>` | `-k` | Filter by item kind: `fn`, `struct`, `enum`, `trait`, `type`, `const`, `mod`, `macro` |
199198
| `--private` | `-p` | Include non-public items |
200199
| `--json` | `-j` | JSON Lines output |
201200
| `--impls` | `-i` | Show trait implementations (on types) or implementors (on traits) |
201+
| `--recursive` | `-r` | List all public items recursively in a crate or module tree |
202202
| `--readme` | | Show the crate's README |
203203
| `--manifest-path <PATH>` | | Path to Cargo.toml |
204204
| `--features <FEATURES>` | | Comma-separated list of features to activate |

skills/groxide/SKILL.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ grox serde::Deserialize
3939
```
4040

4141
Shows the type signature, doc comments, methods, and trait implementations.
42-
Truncated by default (~200-800 tokens). Use `--all` to expand everything.
4342

4443
### Look up a method
4544

@@ -130,17 +129,19 @@ dependency resolution.
130129

131130
| Flag | Short | Purpose |
132131
|------|-------|---------|
133-
| `--all` | `-a` | Disable truncation, expand everything |
134132
| `--list` | `-l` | List children (names + one-line summaries) |
135133
| `--source` | `-s` | Show source code |
136134
| `--search <Q>` | `-S` | Full-text search |
137135
| `--json` | `-j` | JSON Lines output |
138136
| `--kind <K>` | `-k` | Filter by kind: `fn`, `struct`, `enum`, `trait`, `type`, `const`, `mod`, `macro` |
139137
| `--impls` | `-i` | Show trait implementations or implementors |
138+
| `--recursive` | `-r` | List all public items recursively in a crate or module tree |
140139
| `--private` | `-p` | Include non-public items |
141140
| `--readme` | | Show crate README |
142-
| `--features` | | Activate specific features |
141+
| `--features <F>` | | Comma-separated list of features to activate |
143142
| `--all-features` | | Activate all features |
143+
| `--no-default-features` | | Do not activate the `default` feature |
144+
| `--manifest-path <P>` | | Path to Cargo.toml |
144145

145146
## Example Workflows
146147

@@ -174,8 +175,6 @@ User asks: "How do I read a file asynchronously with tokio?"
174175
`grox crate_name -S "keyword"` finds items by documentation content.
175176
- **Check exit codes.** Exit 1 means the item doesn't exist — don't retry, try
176177
a different path or use search. Exit 2 means a tooling error.
177-
- **Don't use `--all` by default.** The truncated output is designed to fit
178-
agent context windows. Only expand when you need the full picture.
179178
- **Run from a Rust project directory** when possible. This gives groxide access
180179
to the full dependency graph and enables queries like `grox` (current crate)
181180
with no arguments.

0 commit comments

Comments
 (0)