skills.rest
RyderFreeman4Logos
RyderFreeman4LogosCOMMUNITY
Explore all skills by this author →
𝕏@wuzhige4pixelGitHub

codebase-audit

Audit Cargo workspace crates in dependency order and generate per-crate documentation and facts.toml.

12|1|Updated Feb 6, 2026
Search Tags:#documentation#codebase#audit#cargo#topology#crates
One-click install
npx skills add https://github.com/RyderFreeman4Logos/cli-sub-agent --skill codebase-audit-ryderfreeman4logos
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: codebase-audit
Source: https://github.com/RyderFreeman4Logos/cli-sub-agent/tree/main/patterns/codebase-audit/skills/codebase-audit
Command: npx skills add https://github.com/RyderFreeman4Logos/cli-sub-agent --skill codebase-audit-ryderfreeman4logos

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Systematically audits an entire codebase (or scoped subset) to generate comprehensive, crate-level documentation and risk assessments, consolidating README.md, per-crate reviews, and a machine-readable facts.toml.

Core Features & Use Cases

  • Per-crate documentation: automatically generate README.md, review_report.md, and blog.md for each crate.
  • Topological processing: process crates in dependency order to ensure context propagation and reproducible results.
  • Facts sidecar: emit a structured facts.toml capturing APIs, dependencies, risks, and architecture.
  • Use Case: audit a multi-crate workspace to produce consistent documentation and governance artifacts across all crates.

Quick Start

Initiate a full workspace codebase audit to generate per-crate documentation and a global facts summary.

Frequently Asked Questions about codebase-audit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate codebase audits for a Cargo workspace with multiple crates?▼

To automate codebase audits for a Cargo workspace, process crates in topological dependency order. This generates per-crate documentation like README.md, review reports, and a machine-readable facts.toml capturing APIs and risks.

What is topological processing when auditing a Rust codebase?▼

Topological processing audits a Rust codebase by evaluating crates in their dependency order. This ensures accurate context propagation across the topology and reproducible results for scalable workspace reporting.

Can I generate per-crate documentation and risk assessments for large Rust projects?▼

Yes, you can generate per-crate documentation and risk assessments for large Rust projects. The audit systematically evaluates scoped subsets or entire workspaces to produce review reports and structured facts.

How do I create a structured facts.toml file for crate dependencies and architecture?▼

Create a structured facts.toml for crate dependencies by running a comprehensive codebase audit. This emits a sidecar file capturing APIs, dependency risks, and architecture alongside the generated documentation.

Does the codebase audit process support scoped subset audits or only full workspace evaluation?▼

The codebase audit process supports both full workspace evaluation and scoped subset audits. It orchestrates a deterministic workflow to process crates in dependency order, ensuring scalable reporting regardless of scope.

Related Skills

Explore More Software Engineering Skills→
hiromimahiromima

Rust Development Workflow

Automate cargo build, test, clippy, and fmt across the Miyabi workspace.

Community
Advanced
RyderFreeman4LogosRyderFreeman4Logos
12

codebase-audit-writer

Analyze Rust crates to generate facts.toml, README.md, review_report.md, and blog.md.

Community
Advanced
ichuanichuan
1

deploy-caddy-reverse-proxy

Deploy Caddy reverse proxy with Let's Encrypt SSL and systemd integration.

Community
Advanced
YukiIto1999YukiIto1999

reverse-engineering-rust-malware

Identify Rust-compiled malware binaries and extract crate dependencies and suspicious patterns.

Community
Advanced