\n \n $\"Cargo$ \n

\n\n[![Rust CI](https://github.com/cutsea110/cargo-anatomy/actions/workflows/ci.yml/badge.svg)](https://github.com/cutsea110/cargo-anatomy/actions/workflows/ci.yml)\n[![Crates.io](https://img.shields.io/crates/v/cargo-anatomy.svg)](https://crates.io/crates/cargo-anatomy)\n[![Crates.io Downloads](https://img.shields.io/crates/d/cargo-anatomy.svg?label=Crates.io&logo=rust)](https://crates.io/crates/cargo-anatomy)\n[![Docker Cloud Build Status](https://img.shields.io/docker/pulls/cutsea110/cargo-anatomy?label=cargo-anatomy&logo=docker)](https://hub.docker.com/repository/docker/cutsea110/cargo-anatomy/general)\n\n`cargo-anatomy` analyzes Rust workspaces and calculates metrics inspired by Robert C. Martin's package metrics. Each crate inside the workspace is treated as a package.\n\n## Installation\n\n```\ncargo install cargo-anatomy\n```\n\n## Metrics\n\n- **N** — number of classes in the crate (`struct`, `enum`, `trait` and `type` definitions).\n- **R** — number of internal class relationships. Each unique reference from one class to another within the same crate counts once.\n- **H** — relational cohesion: `H = (R + 1) / N`.\n- **Ca** — afferent coupling: the number of external classes that depend on types from this crate.\n- **Ce** — efferent coupling: the number of classes in this crate that depend on types from other crates in the workspace.\n- **A** — abstraction: ratio of abstract classes (traits) to total classes, `A = abstract_classes / N`.\n- **I** — instability: `I = Ce / (Ce + Ca)`.\n- **D** — distance from the main sequence: `D = |A + I - 1| / sqrt(2)`.\n- **D'** — normalized distance from the main sequence: `D' = |A + I - 1|`.\n\n## Evaluation\nEach metric is also mapped to a qualitative label. These labels are assigned using the following thresholds:\n\n- **A (abstraction)**: ≥ 0.7 is `abstract`, ≤ 0.3 is `concrete`, otherwise `mixed`.\n- **H (cohesion)**: > 1.0 is `high`, otherwise `low`.\n- **I (instability)**: ≥ 0.7 is `unstable`, ≤ 0.3 is `stable`, otherwise `moderate`.\n- **D' (normalized distance)**:\n - ≤ 0.4 → `good`.\n - ≥ 0.6 → `useless` if `A + I - 1 ≥ 0`, otherwise `painful`.\n - otherwise `balanced`.\n`cargo-anatomy` also reports the list of classes discovered in each crate and detailed dependency graphs when invoked with the `-a` flag.\n\n## Usage\n\n```bash\n# Run on the current workspace\ncargo anatomy\n\n# Show detailed class and dependency information\ncargo anatomy -a\n\n# Include external dependencies in metrics (may be slower)\ncargo anatomy -x\n\n# Use a custom evaluation config generated by `cargo anatomy init` below\ncargo anatomy -c config.toml\n\n# Generate a template config file which you can modify and use with `-c`\ncargo anatomy init\n\n# Display help with metric descriptions\ncargo anatomy -?\n\n# Show version\ncargo anatomy -V\n\n# Output in YAML format\ncargo anatomy -o yaml\n# Output in Graphviz DOT format\ncargo anatomy -o dot\n# Output in Mermaid format\ncargo anatomy -o mermaid\n\n# Fail if metrics violate thresholds (experimental)\ncargo anatomy --h-lt 1.1 --d-prime-ge 0.9\n```\n\nFor custom evaluation thresholds, run `cargo anatomy init` to generate a\ntemplate configuration and pass `-c ` to load it. See the [Configuration](#configuration) section for more details.\n\nThe command outputs metrics for every member crate in compact JSON format by default. Use `-x` to also analyze external dependencies. Analyzing external crates can significantly increase processing time. When the `-a` flag is used, each crate also includes a `details.kind` field indicating whether it is part of the workspace or an external crate. Pipe to `jq` if you want it pretty printed. Use `-o yaml` for YAML output, `-o dot` for Graphviz or `-o mermaid` for Mermaid diagrams. When using `-o dot`, you can write the graph to a file and convert it with Graphviz: `cargo anatomy -o dot > graph.dot && dot -Tpng graph.dot -o graph.png`. Dependency arrows are labeled with the efferent couple count from the source crate when the `-a` flag is used. Graphviz and Mermaid diagrams can include individual type nodes when `--show-types-crates=` is specified. Mermaid will only render the first 500 edges by default, so increase `maxEdges` in your [Mermaid configuration](https://mermaid.js.org/config/schema-docs/config.html#maxedges) if your graph is larger. Both Graphviz and Mermaid outputs omit dependency edges unless `-a` is supplied, so combining these formats with `-a` is recommended when you want to visualize the graph.\n\nSee [docs/output-schema.md](https://github.com/cutsea110/cargo-anatomy/blob/main/docs/output-schema.md) for a description of the output schema. Example output (`| jq`):\n\n```json\n{\n \"meta\": {\n \"cargo-anatomy\": { \"version\": \"0.6.0\", \"target\": \"linux/x86_64\" },\n \"config\": {\n \"evaluation\": {\n \"abstraction\": { \"abstract_min\": 0.7, \"concrete_max\": 0.3 },\n \"cohesion\": { \"high_gt\": 1.0 },\n \"instability\": { \"unstable_min\": 0.7, \"stable_max\": 0.3 },\n \"distance\": { \"good_max\": 0.4, \"bad_min\": 0.6 }\n }\n }\n },\n \"crates\": [\n {\n \"crate_name\": \"my_crate\",\n \"metrics\": {\n \"n\": 3,\n \"r\": 1,\n \"h\": 0.67,\n \"ca\": 0,\n \"ce\": 1,\n \"a\": 0.33,\n \"i\": 1.0,\n \"d\": 0.24,\n \"d_prime\": 0.34\n },\n \"evaluation\": {\n \"a\": \"mixed\",\n \"h\": \"low\",\n \"i\": \"unstable\",\n \"d_prime\": \"good\"\n },\n \"details\": {\n \"kind\": \"Workspace\",\n \"classes\": [\n { \"name\": \"Foo\", \"kind\": \"Struct\" },\n { \"name\": \"Bar\", \"kind\": \"Struct\" },\n { \"name\": \"MyTrait\", \"kind\": \"Trait\" }\n ]\n }\n }\n ],\n \"warnings\": {\n \"dependency_cycles\": []\n }\n}\n```\n\nEnable `RUST_LOG=info` to see progress logs during analysis.\n\n## Configuration\n\n`cargo-anatomy` looks for a `.anatomy.toml` file at the workspace root to customize how metric values are evaluated. Run `cargo anatomy init` to create a template `.anatomy.toml` in the current directory. Pass `-c ` to use a different configuration. The file is written in TOML and contains the following sections and defaults:\n\n```toml\n[evaluation]\n [evaluation.abstraction]\n abstract_min = 0.7 # minimum ratio considered abstract\n concrete_max = 0.3 # maximum ratio considered concrete\n\n [evaluation.cohesion]\n high_gt = 1.0 # values greater than this are high cohesion\n\n [evaluation.instability]\n unstable_min = 0.7 # minimum ratio considered unstable\n stable_max = 0.3 # maximum ratio considered stable\n\n [evaluation.distance]\n good_max = 0.4 # max normalized distance considered good\n bad_min = 0.6 # min normalized distance considered bad\n```\n\nSpecify a path with `-c ` to use a different configuration, or omit the option to rely on these defaults.\n\n## Docker image\n\n### Using the official image\n\nA pre-built container is available on Docker Hub. Replace `` with the\ndesired tag and mount your workspace into `/work`:\n\n```bash\ndocker run --rm -v $(pwd):/work cutsea110/cargo-anatomy: [ARGS...]\n```\n\nAny arguments after the image name are forwarded to `cargo-anatomy`. The image\nincludes the toolchain `cargo` binary and sets the `CARGO` environment variable\nto that path, so `cargo metadata` works without `rustup`.\n\n### Building an image (for developers)\n\nBuild an image for the current architecture and load it into Docker with:\n\n```bash\ndocker buildx build --platform -t cargo-anatomy --load .\n```\n\nReplace `` with `linux/amd64` on x86_64 machines or `linux/arm64` on\nArm-based hosts. To publish a multi-platform image, use `--push` instead of\n`--load`:\n\n```bash\ndocker buildx build --platform linux/amd64,linux/arm64 \\\n -t /cargo-anatomy: --push .\n```\nSet `` to the tag for the published image. After building or pulling an\nimage, run it as shown above. The runtime uses a distroless base for a smaller\nfootprint.\n\n\n## GitHub Actions\n\nYou can integrate `cargo-anatomy` in your CI pipeline. The example below installs\n`cargo-anatomy` and fails the job when metrics do not satisfy the configured thresholds.\nMake sure a `.anatomy.toml` file is present in your repository so the workflow\ncan load your evaluation settings. You can generate a template with\n`cargo anatomy init` and commit it to version control.\n\n```yaml\n# .github/workflows/anatomy.yml\nname: cargo-anatomy\n\non:\n push:\n branches: [ main ]\n pull_request:\n\njobs:\n analyze:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-rust@v1\n with:\n rust-version: stable\n - name: Install cargo-anatomy\n run: cargo install cargo-anatomy\n - name: Run cargo-anatomy\n run: cargo anatomy -c .anatomy.toml --h-lt 1.1 --d-prime-ge 0.9\n```\n\n","has_starred","hub_user","immutable_tags_settings",{"_306":11,"_307":308},"enabled","rules",[309],".*","is_automated","permissions",{"_313":17,"_314":11,"_315":11},"read","write","admin","user","storage_size",1971303807,"isOrg","reponame","tag","sha256:f5ec3a12889aed3e9873638d30f6a3d94f6c3164f90a3090a93b5401edab10b4","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_22":23,"_264":-7,"_262":-7,"_263":-7,"_24":330,"_30":322,"_336":-7,"_337":11},{"_26":27,"_28":29,"_30":31,"_32":33,"_34":35,"_36":331,"_72":73,"_74":29,"_75":76,"_77":78,"_79":80,"_81":82,"_83":65,"_84":73,"_85":54,"_86":17},[332,333,334,335],{"_39":40,"_30":41,"_42":43,"_44":45,"_46":47,"_48":49,"_50":43,"_51":-5,"_52":33,"_53":54,"_55":-5},{"_39":57,"_30":58,"_42":43,"_44":59,"_46":60,"_48":49,"_50":43,"_51":-5,"_52":61,"_53":54,"_55":-5},{"_39":63,"_30":64,"_42":43,"_44":65,"_46":66,"_48":63,"_50":43,"_51":-5,"_52":67,"_53":54,"_55":-5},{"_39":63,"_30":69,"_42":43,"_44":70,"_46":71,"_48":63,"_50":43,"_51":-5,"_52":67,"_53":54,"_55":-5},"imageWithLayers","hasPermissionToViewRepoSettings","actionData","errors"]

cutsea110/cargo-anatomy:latest