Rust Project Build Context

https://docs.rs/crate/pkgrank/0.4.2
Admin
This project provides a snapshot of a Rust project's source code and build artifacts for analysis,...
Tokens:11,265
Snippets:166
Trust Score:9.1
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install pkgrank via PowerShell

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Installs pkgrank on Windows using PowerShell. This command bypasses the execution policy for installation.

```powershell
# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://github.com/arclabs561/pkgrank/releases/latest/download/pkgrank-installer.ps1 | iex"
```

--------------------------------

### Install and Run Cargo Modules

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Installs the cargo-modules tool and then uses pkgrank to perform module-level analysis on a specified crate, limiting the output to the top 25 results.

```bash
cargo install cargo-modules
pkgrank modules -p my_crate --lib -n 25
```

--------------------------------

### Install pkgrank via Cargo

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Installs pkgrank using the Cargo package manager. Requires a Rust toolchain.

```bash
cargo install pkgrank
```

--------------------------------

### Install pkgrank via Shell Script

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Installs pkgrank using a curl script for macOS and Linux. Ensure you have `curl` and `sh` available.

```bash
# macOS / Linux
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/arclabs561/pkgrank/releases/latest/download/pkgrank-installer.sh | sh
```

--------------------------------

### Pkgrank JSON Output Format

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Example of the JSON output format for pkgrank commands that support JSON output. This format includes schema version, status, command, and rows of data.

```json
{
  "schema_version": 1,
  "ok": true,
  "command": "files",
  "rows": [ ... ]
}
```

--------------------------------

### Workspace Configuration

Source: https://docs.rs/crate/pkgrank/0.4.2/source/dist-workspace.toml

This snippet shows a basic Cargo.toml configuration for a workspace, specifying the members included in the workspace. It also includes configuration for the 'dist' tool, defining the preferred cargo-dist version, supported CI backends, desired installers, and target platforms for building applications.

```toml
[workspace]
members = ["cargo:."]

# Config for 'dist'
[dist]
# The preferred dist version to use in CI (Cargo.toml SemVer syntax)
cargo-dist-version = "0.31.0"
# CI backends to support
ci = "github"
# The installers to generate for each app
installers = ["shell", "powershell"]
# Target platforms to build apps for (Rust target-triple syntax)
targets = ["aarch64-apple-darwin", "aarch64-unknown-linux-gnu", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-pc-windows-msvc"]

```

--------------------------------

### Upgrade priority analysis for Cargo projects

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Identifies outdated dependencies in a Cargo project and ranks them by their importance or potential risk, guiding upgrade efforts.

```bash
# Upgrade priority: which outdated deps matter most? (Cargo only)
pkgrank upgrade-priority
```

--------------------------------

### Define Architectural Rules with .pkgrank.toml

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Configure architectural rules using a `.pkgrank.toml` file at the project root. This file defines layers and specifies forbidden or allowed dependencies between them.

```toml
[layers]
domain = ["src/domain/**", "src/models/**"]
infra = ["src/infra/**", "src/db/**"]
api = ["src/api/**", "src/routes/**"]

# Deny rules: explicitly forbid specific imports
[[deny]]
from = "domain"
to = "infra"

# Allow rules: layer may ONLY import from listed layers (stricter)
[[allow]]
from = "domain"
to = ["domain"]  # domain may only import domain -- no infra, no api

```

--------------------------------

### Query Projects

Source: https://docs.rs/crate/pkgrank/0.4.2

Lists all projects that have been analyzed by pkgrank. Useful for managing and reviewing multiple project analyses.

```bash
pkgrank query projects
```

--------------------------------

### File-level analysis using shorthand for Bitbucket

Source: https://docs.rs/crate/pkgrank/0.4.2

Analyzes the file-level structure of a Bitbucket repository using a shorthand notation.

```bash
pkgrank files bb:pypy/pypy
```

--------------------------------

### File-level analysis using shorthand for SourceHut

Source: https://docs.rs/crate/pkgrank/0.4.2

Analyzes the file-level structure of a SourceHut repository using a shorthand notation.

```bash
pkgrank files sh:~sircmpwn/aerc
```

--------------------------------

### Build Failure Log

Source: https://docs.rs/crate/pkgrank/0.4.2/builds/3164347

This snippet shows the log output from a failed documentation build. It indicates an 'ExecutionFailed' error due to no library targets found in the package.

```log
# error kind
ExecutionFailed

# pre-build errors
command failed: exit status: 101




# rustc version
rustc 1.97.0-nightly (e22c616e4 2026-04-19)


# docs.rs version
docsrs 0.0.0 (15f7e1e9dfac4fc5b7cc4abfd7682239002ba909 2026-04-08 )


# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace-builder3/builds/pkgrank-0.4.2/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace-builder3/builds/pkgrank-0.4.2/source:/opt/rustwide/workdir:ro,Z" "-v" "/home/cratesfyi/workspace-builder3/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/home/cratesfyi/workspace-builder3/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-m" "6442450944" "--cpuset-cpus" "16-19" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:d429b63d4308055ea97f60fb1d3dfca48854a00942f1bd2ad806beaf015945ec" "sleep" "infinity", kill_on_drop: false }`
[INFO] [stderr] WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap.
[INFO] [stdout] 65102431e3f878e5fc41d26168b1c344f2e15e083a1439397090c058f2e16776
[INFO] running `Command { std: "docker" "start" "65102431e3f878e5fc41d26168b1c344f2e15e083a1439397090c058f2e16776", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "exec" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "--user" "1001:1001" "65102431e3f878e5fc41d26168b1c344f2e15e083a1439397090c058f2e16776" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20260419-1.97.0-nightly-e22c616e4\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--extern-html-root-takes-precedence\"]" "--offline" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-unknown-linux-gnu\"" "-Zrustdoc-scrape-examples" "-j4" "--target" "x86_64-unknown-linux-gnu", kill_on_drop: false }`
[INFO] [stderr] error: no library targets found in package `pkgrank`
[INFO] running `Command { std: "docker" "stop" "-t" "1" "65102431e3f878e5fc41d26168b1c344f2e15e083a1439397090c058f2e16776", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "inspect" "65102431e3f878e5fc41d26168b1c344f2e15e083a1439397090c058f2e16776", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "rm" "-f" "65102431e3f878e5fc41d26168b1c344f2e15e083a1439397090c058f2e16776", kill_on_drop: false }`
[INFO] [stdout] 65102431e3f878e5fc41d26168b1c344f2e15e083a1439397090c058f2e16776

```

--------------------------------

### File-level analysis using shorthand for Tangled

Source: https://docs.rs/crate/pkgrank/0.4.2

Analyzes the file-level structure of a Tangled repository using a shorthand notation.

```bash
pkgrank files tg:tangled.org/core
```

--------------------------------

### Cross-Project Queries via SQLite

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Execute various queries on analyzed projects using SQLite syntax. These queries can reveal hotspots, dependencies, project lists, and more.

```bash
pkgrank query hotspots
```

```bash
pkgrank query deps
```

```bash
pkgrank query projects
```

```bash
pkgrank query "files lib.rs"
```

```bash
pkgrank query compare
```

```bash
pkgrank query drift
```

--------------------------------

### Query Snapshot Comparison

Source: https://docs.rs/crate/pkgrank/0.4.2

Compares the dependency graph and structural metrics between the two most recent snapshots of a project. Useful for tracking changes and identifying regressions.

```bash
pkgrank query compare
```

--------------------------------

### Query Dependencies

Source: https://docs.rs/crate/pkgrank/0.4.2

Lists the most frequently used external dependencies across all analyzed projects. Helps in understanding project reliance on third-party packages.

```bash
pkgrank query deps
```

--------------------------------

### File-level analysis of a project via URL

Source: https://docs.rs/pkgrank

Analyzes file-level structure for a project hosted on GitHub, specified by its full URL.

```bash
pkgrank files https://github.com/fastapi/fastapi
```

--------------------------------

### File-level analysis using shorthand for GitLab

Source: https://docs.rs/crate/pkgrank/0.4.2

Analyzes the file-level structure of a GitLab repository using a shorthand notation.

```bash
pkgrank files gl:inkscape/inkscape
```

--------------------------------

### File-level analysis of remote projects via URL or shorthand

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Analyzes file-level structure for remote projects specified by URL or shorthand notation (e.g., owner/repo). Defaults to GitHub if no forge is specified.

```bash
# Any repo via URL or shorthand (owner/repo defaults to GitHub)
pkgrank files tokio-rs/tokio
pkgrank files https://gitlab.com/inkscape/inkscape
pkgrank files cb:forgejo/forgejo
```

--------------------------------

### File-level analysis of remote Bitbucket repository

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Analyzes file-level structure for a specified Bitbucket repository using the `bb:` shorthand.

```bash
pkgrank files bb:pypy/pypy                  # Bitbucket
```

--------------------------------

### Cargo.toml Profile Configuration

Source: https://docs.rs/crate/pkgrank/0.4.2/source/Cargo.toml.orig

Configures the 'dist' build profile for the pkgrank crate, inheriting from 'release' and enabling thin LTO.

```toml
# The profile that 'dist' will build with
[profile.dist]
inherits = "release"
lto = "thin"

```

--------------------------------

### File-level analysis of local project

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Performs file-level structural analysis on the current local project. The ecosystem is auto-detected.

```bash
# File-level: structural hotspots in any project
pkgrank files .
```

--------------------------------

### Cargo.toml Dependencies

Source: https://docs.rs/crate/pkgrank/0.4.2/source/Cargo.toml.orig

Lists the regular dependencies required by the pkgrank crate, including version specifications and optional features.

```toml
[dependencies]
anyhow = "1.0"
cargo_metadata = "0.23.1"
clap = { version = "4.5", features = ["derive", "wrap_help"] }
graphops = { version = "0.1.4", features = ["petgraph"] }
petgraph = "0.6"
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
bincode = "1.3"
rusqlite = { version = "0.33", features = ["bundled"] }
dirs-next = "2.0"
toml = "0.8"
ureq = { version = "2.10", features = ["json"] }
tokio = { version = "1.40", features = ["full"], optional = true }
rmcp = {
  version = "0.12.0",
  optional = true,
  features = [
    "macros",
    "server",
    "client",
    "transport-io",
    "transport-child-process",
    "schemars",
  ]
}
schemars = { version = "1.2.0", optional = true, features = ["derive"] }
glob = "0.3.3"

```

--------------------------------

### Cargo.toml Binary Target Configuration

Source: https://docs.rs/crate/pkgrank/0.4.2/source/Cargo.toml.orig

Defines a binary target named 'pkgrank' with its source path.

```toml
[[bin]]
name = "pkgrank"
path = "src/main.rs"

```

--------------------------------

### Analyze Package Centrality with Custom Metric and Limit

Source: https://docs.rs/crate/pkgrank/0.4.2

Analyzes packages and ranks them using a specified metric (e.g., consumers-pagerank) and limits the output to the top N results. Useful for focusing on specific ranking criteria.

```bash
pkgrank analyze --metric consumers-pagerank -n 10
```

--------------------------------

### Cargo.toml Development Dependencies

Source: https://docs.rs/crate/pkgrank/0.4.2/source/Cargo.toml.orig

Specifies the development dependencies used for testing and building the pkgrank crate.

```toml
[dev-dependencies]
assert_cmd = "2.0"
predicates = "3.0"

```

--------------------------------

### Package-level analysis for a specific project path

Source: https://docs.rs/crate/pkgrank/0.4.2

Performs package-level analysis on a project located at a specified path, auto-detecting the ecosystem.

```bash
pkgrank analyze path/to/npm-project
```

--------------------------------

### Define Deny Rules in .pkgrank.toml

Source: https://docs.rs/crate/pkgrank/0.4.2

Defines explicit deny rules in .pkgrank.toml to forbid specific layer-to-layer imports. Violations are reported during `pkgrank files` analysis.

```toml
[[deny]]
from = "domain"
to = "infra"
```

--------------------------------

### Define Layers in .pkgrank.toml

Source: https://docs.rs/crate/pkgrank/0.4.2

Defines architectural layers (e.g., domain, infra, api) using glob patterns in a .pkgrank.toml file. This configuration is used for enforcing architectural rules.

```toml
[layers]
domain = ["src/domain/**", "src/models/**"]
infra = ["src/infra/**", "src/db/**"]
api = ["src/api/**", "src/routes/**"]
```

--------------------------------

### Query Files by Name

Source: https://docs.rs/crate/pkgrank/0.4.2

Searches for files within the analyzed projects that match a given name. This is a simple way to locate specific files across the codebase.

```bash
pkgrank query "files lib.rs"
```

--------------------------------

### Cargo.toml Package Configuration

Source: https://docs.rs/crate/pkgrank/0.4.2/source/Cargo.toml.orig

Defines the core metadata for the pkgrank package, including its name, version, edition, license, authors, repository, and homepage.

```toml
[package]
name = "pkgrank"
version = "0.4.2"
edition = "2021"
rust-version = "1.80"
license = "MIT OR Apache-2.0"
authors = ["Arc <attobop@gmail.com>"]
repository = "https://github.com/arclabs561/pkgrank"
homepage = "https://github.com/arclabs561/pkgrank"

description = "Centrality analysis for dependency graphs and file-level import graphs"
keywords = ["dependency", "graph", "pagerank", "architecture", "analysis"]
categories = ["command-line-utilities", "development-tools"]

```

--------------------------------

### File-level analysis of any local project (default)

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Performs file-level structural analysis on the current local project, auto-detecting the programming language ecosystem. Respects `.gitignore` and excludes common generated files.

```bash
# Any local project (ecosystem auto-detected)
pkgrank files .
```

--------------------------------

### Default .gitignore Entries

Source: https://docs.rs/crate/pkgrank/0.4.2/source/.gitignore

Commonly ignored files and directories in Rust projects.

```gitignore
target/
**/*.rs.bk
```

--------------------------------

### File-level analysis using shorthand for Codeberg

Source: https://docs.rs/crate/pkgrank/0.4.2

Analyzes the file-level structure of a Codeberg repository using a shorthand notation.

```bash
pkgrank files cb:forgejo/forgejo
```

--------------------------------

### JSON Output for Upgrade Priority

Source: https://docs.rs/crate/pkgrank/0.4.2

Outputs the upgrade priority scores in JSON format, allowing for programmatic integration, such as filtering the top results for CI integration.

```bash
pkgrank upgrade-priority --format json | jq '.rows[:5]'
```

--------------------------------

### File-level analysis of remote GitLab repository

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Analyzes file-level structure for a specified GitLab repository using the `gl:` shorthand.

```bash
# Works with any git forge
pkgrank files gl:inkscape/inkscape          # GitLab
```

--------------------------------

### File-level analysis with Git churn risk overlay

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Performs file-level analysis and includes Git churn data to identify files with high structural importance and frequent changes.

```bash
# File-level with git churn risk overlay
pkgrank files . --git
```

--------------------------------

### Define Allow Rules in .pkgrank.toml

Source: https://docs.rs/crate/pkgrank/0.4.2

Defines allow rules in .pkgrank.toml, specifying which layers a given layer is permitted to import from. This is a stricter approach that catches unlisted imports as violations.

```toml
[[allow]]
from = "domain"
to = ["domain"]
```

--------------------------------

### Package-level analysis of specific project path

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Performs package-level centrality analysis on a specified project directory, auto-detecting the ecosystem.

```bash
pkgrank analyze path/to/npm-project
pkgrank analyze path/to/python-project
```

--------------------------------

### Show Blast Radius with Workspace and Limit Options

Source: https://docs.rs/crate/pkgrank/0.4.2

Displays transitive dependents for a package, with options to control workspace inclusion and limit the number of results. Useful for fine-tuning blast radius analysis.

```bash
pkgrank blast-radius --workspace-only=false -n 20 serde
```

--------------------------------

### Cargo Rustdoc Command

Source: https://docs.rs/crate/pkgrank/0.4.2/builds/3164347/x86_64-unknown-linux-gnu_json.txt

This command executes the cargo rustdoc process with specific configurations for docs.rs, including output format and external crate mapping. It is used to generate documentation for Rust crates.

```bash
[INFO] running `Command { std: "docker" "exec" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "--user" "1001:1001" "d9cc6e362190975775ef8c04096f1bafb79a0aa768d26226829849f84f5f5abb" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--output-format\", \"json\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--extern-html-root-takes-precedence\"]" "--offline" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-unknown-linux-gnu\"" "-Zrustdoc-scrape-examples" "-j4" "--target" "x86_64-unknown-linux-gnu", kill_on_drop: false }`
```

--------------------------------

### File-level analysis with caching

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Enables caching of results for file-level analysis, speeding up subsequent queries on the same project by reusing previously computed data.

```bash
# Cache results for repeated queries
pkgrank files . --cache
```

--------------------------------

### Analyze Package Centrality with JSON Output

Source: https://docs.rs/crate/pkgrank/0.4.2

Outputs the package analysis results in JSON format, with an option to limit the number of JSON entries. Suitable for programmatic integration and CI/CD pipelines.

```bash
pkgrank analyze --format json --json-limit 200
```

--------------------------------

### Cargo.toml Workspace Configuration

Source: https://docs.rs/crate/pkgrank/0.4.2/source/Cargo.toml.orig

Specifies the workspace resolver and members for the pkgrank project.

```toml
[workspace]
resolver = "2"
members = [".."]

```

--------------------------------

### File-level analysis of remote SourceHut repository

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Analyzes file-level structure for a specified SourceHut repository using the `sh:` shorthand.

```bash
pkgrank files sh:~sircmpwn/aerc             # SourceHut
```

--------------------------------

### Package-level analysis of dependencies

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Performs package-level centrality analysis on the project's dependencies. The ecosystem is auto-detected.

```bash
# Package-level: rank dependencies by importance (auto-detects ecosystem)
pkgrank analyze
```

--------------------------------

### Package-level analysis for a Python project

Source: https://docs.rs/crate/pkgrank/0.4.2

Performs package-level analysis specifically for a Python project.

```bash
pkgrank analyze path/to/python-project
```

--------------------------------

### Blast Radius Analysis

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Show all packages that transitively depend on a given package. The output is sorted by BFS depth and then by PageRank.

```bash
pkgrank blast-radius serde
```

```bash
pkgrank blast-radius express path/to/npm-project
```

```bash
pkgrank blast-radius --workspace-only=false -n 20 serde
```

--------------------------------

### File-level analysis of remote Codeberg repository

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Analyzes file-level structure for a specified Codeberg repository using the `cb:` shorthand.

```bash
pkgrank files cb:forgejo/forgejo            # Codeberg
```

--------------------------------

### File-level analysis focusing on a specific file

Source: https://docs.rs/crate/pkgrank/0.4.2

Analyzes the import graph, focusing on the specified file and its direct relationships.

```bash
pkgrank files . --focus main.rs
```

--------------------------------

### Analyze Package Centrality with Ecosystem Override

Source: https://docs.rs/crate/pkgrank/0.4.2

Analyzes packages within a dependency graph, explicitly specifying the ecosystem. This is useful when auto-detection might fail or for cross-ecosystem analysis.

```bash
pkgrank analyze --ecosystem js path/to/project
```

```bash
pkgrank analyze --ecosystem python path/to/project
```

```bash
pkgrank analyze --ecosystem go path/to/project
```

--------------------------------

### Directory-level aggregation for large codebases

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Performs file-level analysis but aggregates results by directory, useful for very large projects.

```bash
# Directory-level aggregation for large codebases
pkgrank files astral-sh/ruff --directory
```

--------------------------------

### Package-Level Analysis

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Analyze packages within a dependency graph to rank them by centrality. The tool auto-detects the ecosystem from project contents.

```bash
# Auto-detect: finds Cargo.toml, package-lock.json, uv.lock, or go.mod
pkgrank analyze
```

```bash
# Explicit ecosystem override
pkgrank analyze --ecosystem js path/to/project
pkgrank analyze --ecosystem python path/to/project
pkgrank analyze --ecosystem go path/to/project
```

```bash
# Choose metric
pkgrank analyze --metric consumers-pagerank -n 10
```

```bash
# JSON output
pkgrank analyze --format json --json-limit 200
```

--------------------------------

### pkgrank Specific .gitignore Entries

Source: https://docs.rs/crate/pkgrank/0.4.2/source/.gitignore

Additional files and directories specific to pkgrank artifacts that should be ignored.

```gitignore
# pkgrank artifacts (default under super-workspace root; keep here for safety if run in-repo)
evals/pkgrank/
runs/
.claude/reports/
.claude/settings.local.json
```

--------------------------------

### File-level analysis of remote GitHub repository

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Analyzes file-level structure for a specified GitHub repository (owner/repo format).

```bash
pkgrank files tokio-rs/tokio
```

--------------------------------

### File-level analysis of remote Tangled repository

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Analyzes file-level structure for a specified Tangled repository using the `tg:` shorthand.

```bash
pkgrank files tg:tangled.org/core           # Tangled
```

--------------------------------

### File-level analysis with Git churn risk

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Combines structural centrality analysis with Git change frequency data to highlight files that are both structurally important and frequently modified, indicating potential churn risk.

```bash
# Git churn risk: combine structural centrality with change frequency
pkgrank files . --git
```

--------------------------------

### File-level analysis focusing on a specific file with Git churn

Source: https://docs.rs/crate/pkgrank/0.4.2

Analyzes file-level structure and Git churn, focusing on a specific file and its relationships.

```bash
pkgrank files . --git --focus lib.rs
```

--------------------------------

### File-level analysis including test files

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Includes test files in the file-level analysis, which are typically excluded by default. This allows for analysis of test code structure and its relation to the main codebase.

```bash
# Include test files (excluded by default)
pkgrank files . --include-tests
```

--------------------------------

### File-level analysis of remote GitLab repository

Source: https://docs.rs/crate/pkgrank/0.4.2

Analyzes the file-level structure of a GitLab repository specified by its URL.

```bash
pkgrank files https://gitlab.com/inkscape/inkscape
```

--------------------------------

### Directory aggregation for large codebases

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Performs file-level analysis but aggregates results by directory, which is beneficial for managing and understanding very large codebases.

```bash
# Directory aggregation for large codebases
pkgrank files astral-sh/ruff --directory
```

--------------------------------

### Query Hotspots

Source: https://docs.rs/crate/pkgrank/0.4.2

Retrieves a list of files with the highest churn risk, indicating files that are both structurally central and frequently changed. Useful for identifying areas needing refactoring or attention.

```bash
pkgrank query hotspots
```

--------------------------------

### Calculate Upgrade Priority

Source: https://docs.rs/pkgrank

Scores outdated dependencies based on structural importance and urgency. Requires `cargo-outdated`. Useful for prioritizing dependency upgrades.

```bash
pkgrank upgrade-priority -n 15
```

```bash
pkgrank upgrade-priority --format json | jq '.rows[:5]'
```

--------------------------------

### Blast radius analysis for a package in a specific project

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Calculates the 'blast radius' of a package within the context of a specific project, useful for understanding dependency impact in a particular environment.

```bash
pkgrank blast-radius express path/to/npm-project
```

--------------------------------

### File-level analysis focusing on a specific file

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Analyzes file-level structure, focusing the output and analysis on a particular file within the project.

```bash
# Focus on a specific file
pkgrank files . --focus main.rs
```

--------------------------------

### File-level analysis focusing on a specific file with Git data

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Analyzes file-level structure and Git churn, focusing the output and analysis on a particular file. This helps understand the combined structural and change impact of a single file.

```bash
# Focus on one file: see imports, dependents, co-changers, blast radius
pkgrank files . --git --focus lib.rs
```

--------------------------------

### Blast radius analysis for a package

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Calculates the 'blast radius' of a package, indicating its potential impact if it were to change. Useful for identifying critical dependencies.

```bash
# Blast radius: what breaks if serde changes?
pkgrank blast-radius serde
```

--------------------------------

### Cargo.toml Feature Flags

Source: https://docs.rs/crate/pkgrank/0.4.2/source/Cargo.toml.orig

Defines feature flags for the pkgrank crate, including 'default' and 'stdio'.

```toml
[features]
# Default should "just work" when run as a Cursor MCP server.
default = ["stdio"]
stdio = ["dep:tokio", "dep:rmcp", "dep:schemars"]
# Expose extra/debug MCP tools (wider tool surface).
mcp-debug = []

```

--------------------------------

### Identify Affected Files

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Determine which files would be affected if specific files in the project change. This helps in understanding the blast radius of changes.

```bash
pkgrank files . --affected src/graph.rs,src/index.rs
```

```bash
git diff --name-only | pkgrank files . --affected -
```

--------------------------------

### Upgrade Priority for Cargo

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Score outdated dependencies based on their structural importance and dependents count. This helps prioritize upgrades, especially when integrated with CI.

```bash
pkgrank upgrade-priority -n 15
```

```bash
# JSON for CI integration
pkgrank upgrade-priority --format json | jq '.rows[:5]'
```

--------------------------------

### Calculate Upgrade Priority for Dependencies

Source: https://docs.rs/crate/pkgrank/0.4.2

Calculates an upgrade priority score for outdated dependencies based on structural importance (dependents, PageRank) and urgency. Requires `cargo-outdated`.

```bash
pkgrank upgrade-priority -n 15
```

--------------------------------

### Query Centrality Drift

Source: https://docs.rs/crate/pkgrank/0.4.2

Analyzes changes in structural centrality metrics over time. Helps identify files or packages whose importance is increasing or decreasing.

```bash
pkgrank query drift
```

--------------------------------

### Run Sweep Analysis on Multiple Crates

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Performs a sweep analysis across specified crates (crate_a and crate_b) focusing on library code.

```bash
pkgrank modules-sweep -p crate_a -p crate_b --lib
```

--------------------------------

### CI: Fail on Cycles or Layer Violations

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Use this command in CI to ensure no cycles or layer violations exist in the project. It will exit with a non-zero status code if violations are found.

```bash
pkgrank files . --fail-on-violation
```

--------------------------------

### CI gate for architectural violations

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Uses file-level analysis to check for architectural violations and fails the CI job if any are found.

```bash
# CI gate: fail on architectural violations
pkgrank files . --fail-on-violation
```

--------------------------------

### VCS Info JSON Structure

Source: https://docs.rs/crate/pkgrank/0.4.2/source/.cargo_vcs_info.json

This JSON object contains version control system information, specifically the Git commit SHA and the path within the VCS.

```json
{
  "git": {
    "sha1": "d9f4b509a774ac6659567d25d6cc246a38af5d43"
  },
  "path_in_vcs": ""
}
```

--------------------------------

### Identify files affected by a change

Source: https://docs.rs/crate/pkgrank/0.4.2/source/README.md

Determines which files in the project are affected by changes to a specific file or a list of changed files from stdin.

```bash
# What files are affected by a change?
pkgrank files . --affected src/parser.rs
git diff --name-only | pkgrank files . --affected -
```

--------------------------------

### Cache Analysis Results

Source: https://docs.rs/crate/pkgrank/0.4.2

Caches the results of file analysis queries to speed up repeated queries on the same project. This is useful for improving performance during iterative development or CI runs.

```bash
pkgrank files . --cache
```

--------------------------------

### Identify Affected Files by Changes

Source: https://docs.rs/crate/pkgrank/0.4.2

Determines which files would be affected if a specified set of files changes. This helps in understanding the blast radius of modifications.

```bash
pkgrank files . --affected src/graph.rs,src/index.rs
```

--------------------------------

### Identify files affected by staged changes

Source: https://docs.rs/crate/pkgrank/0.4.2

Identifies files affected by changes currently staged in Git, using '-' to read from stdin.

```bash
git diff --name-only | pkgrank files . --affected -
```

--------------------------------

### Identify files affected by a specific change

Source: https://docs.rs/crate/pkgrank/0.4.2

Determines which files are impacted by changes in a specified file, using Git history.

```bash
pkgrank files . --affected src/parser.rs
```
Tokens:
Raw