mirror of
https://codeberg.org/JasterV/granc.git
synced 2026-04-26 18:40:05 +00:00
chore: update README
This commit is contained in:
parent
ae9e1f265e
commit
69305f72a2
1 changed files with 29 additions and 0 deletions
29
README.md
29
README.md
|
|
@ -22,6 +22,7 @@ It is heavily inspired by tools like `grpcurl` but built to leverage the safety
|
||||||
* **Server Reflection**: Can fetch schemas directly from the server, removing the need to pass a local file descriptor set file (`.bin` or `.pb`).
|
* **Server Reflection**: Can fetch schemas directly from the server, removing the need to pass a local file descriptor set file (`.bin` or `.pb`).
|
||||||
* **Introspection Tools**: Commands to list services and describe services, messages, and enums.
|
* **Introspection Tools**: Commands to list services and describe services, messages, and enums.
|
||||||
* **Local Introspection**: In addition to making network requests, Granc can also be used as a local introspection tool for file descriptor binary files. You can load a local `.bin` file to inspect services, messages, and enums without needing to fetch the schema from a server.
|
* **Local Introspection**: In addition to making network requests, Granc can also be used as a local introspection tool for file descriptor binary files. You can load a local `.bin` file to inspect services, messages, and enums without needing to fetch the schema from a server.
|
||||||
|
* **Documentation Generator**: Generate static, cross-linked Markdown documentation for your services and types directly from the schema.
|
||||||
* **Zero Compilation Dependencies**: Does not require generating Rust code for your protos. Just point to a descriptor file.
|
* **Zero Compilation Dependencies**: Does not require generating Rust code for your protos. Just point to a descriptor file.
|
||||||
* **Tonic 0.14**: Built on the latest stable Rust gRPC stack.
|
* **Tonic 0.14**: Built on the latest stable Rust gRPC stack.
|
||||||
|
|
||||||
|
|
@ -204,6 +205,34 @@ enum Status {
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### 4. `doc` (Documentation Generator)
|
||||||
|
|
||||||
|
Generates static Markdown documentation for a specific service and its dependencies. This is useful for creating browseable documentation for your gRPC APIs.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
granc doc <SYMBOL> --output <DIR> [OPTIONS]
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
| Argument/Flag | Short | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `<SYMBOL>` | | Fully qualified name of the Service (e.g., `my.package.Service`). |
|
||||||
|
| `--output` | `-o` | Directory where the markdown files will be generated. |
|
||||||
|
| `--uri` | `-u` | Use Server Reflection to resolve the schema. |
|
||||||
|
| `--file-descriptor-set` | `-f` | Use a local file to resolve the schema (offline). |
|
||||||
|
|
||||||
|
**Generating docs via Reflection:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
granc doc helloworld.Greeter --uri http://localhost:50051 --output ./docs
|
||||||
|
```
|
||||||
|
|
||||||
|
**Generating docs from a file:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
granc doc helloworld.Greeter --file-descriptor-set ./descriptors.bin --output ./docs
|
||||||
|
```
|
||||||
|
|
||||||
## 🔮 Roadmap
|
## 🔮 Roadmap
|
||||||
|
|
||||||
* **Interactive Mode**: A REPL for streaming requests interactively.
|
* **Interactive Mode**: A REPL for streaming requests interactively.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue