{"id":17066108,"url":"https://github.com/cortesi/ruskel","last_synced_at":"2025-04-12T18:14:05.768Z","repository":{"id":247197045,"uuid":"825243926","full_name":"cortesi/ruskel","owner":"cortesi","description":"Ruskel generates skeletonized outlines of Rust crates.","archived":false,"fork":false,"pushed_at":"2025-02-24T21:28:03.000Z","size":348,"stargazers_count":18,"open_issues_count":1,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-12T18:13:55.652Z","etag":null,"topics":["ai","documentation","terminal"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cortesi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-07T08:25:46.000Z","updated_at":"2025-03-22T10:16:55.000Z","dependencies_parsed_at":"2024-10-23T23:39:00.017Z","dependency_job_id":"f35c9810-ba98-41f5-a83c-f58cf2cb1d32","html_url":"https://github.com/cortesi/ruskel","commit_stats":{"total_commits":116,"total_committers":1,"mean_commits":116.0,"dds":0.0,"last_synced_commit":"d8affe6e164171551d965841e2975d331bd65720"},"previous_names":["cortesi/ruskel"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cortesi%2Fruskel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cortesi%2Fruskel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cortesi%2Fruskel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cortesi%2Fruskel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cortesi","download_url":"https://codeload.github.com/cortesi/ruskel/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248610336,"owners_count":21132920,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","documentation","terminal"],"created_at":"2024-10-14T11:05:59.273Z","updated_at":"2025-04-12T18:14:05.758Z","avatar_url":"https://github.com/cortesi.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ruskel\n\n[![Crates.io](https://img.shields.io/crates/v/libruskel.svg)](https://crates.io/crates/libruskel)\n[![Documentation](https://docs.rs/libruskel/badge.svg)](https://docs.rs/libruskel)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nRuskel produces a syntactically correct, single-page skeleton of a crate's\npublic API. If the crate is not found in the local workspace, it is fetched\nfrom [crates.io](https://crates.io).\n\nRuskel is great for:\n\n- Quick access to Rust documentation from the command line.\n- Exporting the full public API of a crate as a single file to pass to LLMs and\n  other tools.\n\nFor example, here is the skeleton of the very tiny `termsize` crate. Note that\nthe entire public API is included, but all implementation is omitted.\n\n````rust\npub mod termsize {\n    //! Termsize is a tiny crate that provides a simple\n    //! interface for retrieving the current\n    //! [terminal interface](http://www.manpagez.com/man/4/tty/) size\n    //!\n    //! ```rust\n    //! extern crate termsize;\n    //!\n    //! termsize::get().map(|size| println!(\"rows {} cols {}\", size.rows, size.cols));\n    //! ```\n\n    /// Container for number of rows and columns\n    #[derive(Debug)]\n    pub struct Size {\n        pub rows: u16,\n        pub cols: u16,\n    }\n\n    /// Gets the current terminal size\n    pub fn get() -\u003e Option\u003cself::super::Size\u003e {}\n}\n````\n\n\n## Features\n\n- Generate a skeletonized view of any Rust crate\n- Support for both local crates and remote crates from crates.io\n- Syntax highlighting for terminal output \n- Optionally include private items and auto-implemented traits\n- Support for custom feature flags and version specification\n\n\n## Installation\n\nTo install Ruskel, run:\n\n```sh\ncargo install ruskel\n```\n\n\n## Usage\n\n\nRuskel uses nightly-only features on `cargo doc` for document generation, so you\nneed to have the nightly toolchain installed to run it, but not to install it.\n\nBasic usage:\n\n```sh\nruskel [TARGET]\n```\n\nSee the help output for all options:\n\n```sh\nruskel --help\n```\n\nRuskel has a flexible target specification that tries to do the right thing in\na wide set of circumstances.\n\n```sh\n# Current project\nruskel\n\n# If we're in a workspace and we have a crate mypacakage\nruskel mypackage\n\n# A dependency of the current project, else we fetch from crates.io \nruskel serde\n\n# A sub-path within a crate\nruskel serde::de::Deserialize \n\n# Path to a crate\nruskel /my/path\n\n# A module within that crate\nruskel /my/path::foo\n\n# A crate from crates.io with a specific version\nruskel serde@1.0.0\n```\n\n\n\n## libruskel library\n\n`libruskel` is a library that can be integrated into other Rust projects to\nprovide Ruskel functionality.\n\nHere's a basic example of using `libruskel` in your Rust code:\n\n```rust\nuse libruskel::Ruskel;\n\nfn main() -\u003e Result\u003c(), Box\u003cdyn std::error::Error\u003e\u003e {\n    let rs = Ruskel::new(\"/path/to/target\")?;\n    let rendered = rs.render(false, false)?;\n    println!(\"{}\", rendered);\n    Ok(())\n}\n```\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcortesi%2Fruskel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcortesi%2Fruskel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcortesi%2Fruskel/lists"}