You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update SKILL.md with local crate exploration workflows for agents
Add "Exploring Your Own Crate" section with key patterns (-rps, -rpb,
-rp -k mod) and guidance on semantic scoping vs file reads. Steer
agents toward -s over -d since source includes doc comments. Add note
on parallel subagent module exploration for large codebases.
Copy file name to clipboardExpand all lines: skills/groxide/SKILL.md
+34-9Lines changed: 34 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
name: groxide
3
3
description: >
4
4
Query Rust crate documentation from the terminal using groxide (grox).
5
-
Use when you need to look up Rust API docs, check type signatures, explore
6
-
module contents, find methods on a type, or search crate documentation —
7
-
without leaving the terminal or browsing docs.rs. Ideal for LLM coding agents
8
-
working on Rust projects. Do NOT use for general Rust language questions,
9
-
reading local source files, or managing Cargo dependencies.
5
+
Use when you need to explore your own crate's structure and source, look up
6
+
dependency APIs, check type signatures, find methods on a type, or search
7
+
crate documentation — without leaving the terminal or browsing docs.rs.
8
+
Ideal for LLM coding agents working on Rust projects. Do NOT use for general
9
+
Rust language questions, reading arbitrary files, or managing Cargo dependencies.
10
10
license: MIT OR Apache-2.0
11
11
compatibility: Requires Rust nightly toolchain and cargo
12
12
allowed-tools: Bash(grox:*)
@@ -28,7 +28,29 @@ Agents should capture stdout only. Exit codes: 0 = success, 1 = not found, 2 = e
28
28
29
29
**Outside a Rust project**: query the standard library (`grox std::collections::HashMap`) or auto-fetch any crate from crates.io (`grox axum::Router`). No Cargo.toml needed for these.
30
30
31
-
## Common Patterns
31
+
## Exploring Your Own Crate
32
+
33
+
groxide gives you **semantically-scoped views** of code — query by item path, not
34
+
file path. You get exactly the struct, function, or module you ask for, with doc
35
+
comments included in the source. No need to know which file something lives in.
36
+
37
+
```sh
38
+
grox # crate overview (run with no args)
39
+
grox -rp -k mod # discover all modules (public + private)
40
+
grox -rp # full API surface with signatures
41
+
grox -rpb # structural skeleton (names only)
42
+
grox -s mycrate::some::Type # source for one item (includes doc comments)
43
+
grox -rps mycrate::render # full source of a module tree
44
+
```
45
+
46
+
Use `-s` instead of `-d` — source code already contains `///` doc comments, so
47
+
`-s` gives you docs and implementation in one view without duplication.
48
+
49
+
**Scaling to large codebases:** Use `grox -rp -k mod` to discover modules, then
50
+
query individual modules with `grox -rps <module>`. Subagents can each take a
51
+
module in parallel to quickly map out the codebase.
52
+
53
+
## Looking Up Dependencies
32
54
33
55
The examples below assume you are inside a Rust project that depends on the queried crates (e.g., `serde`, `tokio`). For stdlib and auto-fetch, see the dedicated sections below — those work anywhere.
34
56
@@ -169,8 +191,8 @@ dependency resolution.
169
191
| Flag | Short | Purpose |
170
192
|------|-------|---------|
171
193
|`--brief`|`-b`| Show only item names (compact output) |
172
-
|`--docs`|`-d`| Show full rendered documentation per item|
173
-
|`--source`|`-s`| Show source code (composable with `-d` for source + docs)|
194
+
|`--docs`|`-d`| Show rendered documentation (without source). Agents: prefer `-s` instead|
195
+
|`--source`|`-s`| Show source code with doc comments, file path, and line numbers|
174
196
|`--search <Q>`|`-S`| Full-text search (`\|` for OR, space for AND) |
0 commit comments