https://github.com/cortesi/ruskel
Ruskel generates skeletonized outlines of Rust crates.
https://github.com/cortesi/ruskel
ai documentation terminal
Last synced: about 1 year ago
JSON representation
Ruskel generates skeletonized outlines of Rust crates.
- Host: GitHub
- URL: https://github.com/cortesi/ruskel
- Owner: cortesi
- License: mit
- Created: 2024-07-07T08:25:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-24T21:28:03.000Z (over 1 year ago)
- Last Synced: 2025-04-12T18:13:55.652Z (about 1 year ago)
- Topics: ai, documentation, terminal
- Language: Rust
- Homepage:
- Size: 340 KB
- Stars: 18
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ruskel
[](https://crates.io/crates/libruskel)
[](https://docs.rs/libruskel)
[](https://opensource.org/licenses/MIT)
Ruskel produces a syntactically correct, single-page skeleton of a crate's
public API. If the crate is not found in the local workspace, it is fetched
from [crates.io](https://crates.io).
Ruskel is great for:
- Quick access to Rust documentation from the command line.
- Exporting the full public API of a crate as a single file to pass to LLMs and
other tools.
For example, here is the skeleton of the very tiny `termsize` crate. Note that
the entire public API is included, but all implementation is omitted.
````rust
pub mod termsize {
//! Termsize is a tiny crate that provides a simple
//! interface for retrieving the current
//! [terminal interface](http://www.manpagez.com/man/4/tty/) size
//!
//! ```rust
//! extern crate termsize;
//!
//! termsize::get().map(|size| println!("rows {} cols {}", size.rows, size.cols));
//! ```
/// Container for number of rows and columns
#[derive(Debug)]
pub struct Size {
pub rows: u16,
pub cols: u16,
}
/// Gets the current terminal size
pub fn get() -> Option {}
}
````
## Features
- Generate a skeletonized view of any Rust crate
- Support for both local crates and remote crates from crates.io
- Syntax highlighting for terminal output
- Optionally include private items and auto-implemented traits
- Support for custom feature flags and version specification
## Installation
To install Ruskel, run:
```sh
cargo install ruskel
```
## Usage
Ruskel uses nightly-only features on `cargo doc` for document generation, so you
need to have the nightly toolchain installed to run it, but not to install it.
Basic usage:
```sh
ruskel [TARGET]
```
See the help output for all options:
```sh
ruskel --help
```
Ruskel has a flexible target specification that tries to do the right thing in
a wide set of circumstances.
```sh
# Current project
ruskel
# If we're in a workspace and we have a crate mypacakage
ruskel mypackage
# A dependency of the current project, else we fetch from crates.io
ruskel serde
# A sub-path within a crate
ruskel serde::de::Deserialize
# Path to a crate
ruskel /my/path
# A module within that crate
ruskel /my/path::foo
# A crate from crates.io with a specific version
ruskel serde@1.0.0
```
## libruskel library
`libruskel` is a library that can be integrated into other Rust projects to
provide Ruskel functionality.
Here's a basic example of using `libruskel` in your Rust code:
```rust
use libruskel::Ruskel;
fn main() -> Result<(), Box> {
let rs = Ruskel::new("/path/to/target")?;
let rendered = rs.render(false, false)?;
println!("{}", rendered);
Ok(())
}
```