groxide 0.1.0

Query Rust crate documentation from the terminal
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

---
source: tests/cli_errors.rs
expression: stdout
---
Query Rust crate documentation from the terminal

Usage: grox [OPTIONS] [PATH]

Arguments:
  [PATH]
          Rust path to query (e.g., `tokio::sync::Mutex`, `serde@1.0`)

Options:
  -b, --brief
          Show only item names (compact output)

  -d, --docs
          Show full rendered documentation per item

  -s, --source
          Show source code with file path and line numbers

  -S, --search <QUERY>
          Full-text search across documentation

  -k, --kind <KIND>
          Filter by item kind

          Possible values:
          - fn:     Functions and methods
          - struct: Structs
          - enum:   Enums
          - trait:  Traits (includes `TraitAlias`)
          - type:   Type aliases (includes `AssocType`, `ForeignType`)
          - const:  Constants (includes `AssocConst`)
          - mod:    Modules
          - macro:  Macros (includes `ProcMacro`)

  -p, --private
          Include non-public items

  -j, --json
          JSON Lines output

  -i, --impls
          Show trait implementations

      --impls-of <TRAIT>
          Show only implementations of the named trait (e.g. `--impls-of Clone`)

  -r, --recursive
          List all public items recursively in a crate or module tree

      --readme
          Show the crate's README

      --manifest-path <MANIFEST_PATH>
          Path to Cargo.toml

      --features <FEATURES>
          Comma-separated list of features to activate

      --all-features
          Activate all available features

      --no-default-features
          Do not activate the `default` feature

      --clear-cache
          Clear the global documentation cache and exit

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

EXAMPLES:
    grox serde::Deserialize          Struct docs with methods
    grox tokio::sync::Mutex::lock    Full method documentation
    grox tokio -S "spawn"            Search across crate docs
    grox -s tokio::sync::Mutex::new  View source code
    grox -r tokio::sync              List all items recursively
    grox -r -b tokio                 Structural skeleton (names only)
    grox -r -d tokio                 Recursive with full docs
    grox -r -s mycrate               Dump entire crate with source
    grox --impls-of Clone wgpu::Device  Check if Device impl Clone
    grox std::collections::HashMap   Query standard library
    grox --json serde::Serialize     JSON output
    grox serde@1.0.210::Deserialize  Pin to specific version
    grox --clear-cache               Wipe documentation cache