Skip to main content

Compact JSON repository inventory maps for multi-repo workspaces.

Project description

Workspace Repo Map

Compact JSON repository inventory maps for multi-repo workspaces.

license: MIT python version CI deps: none part of: AI-accountability toolkit

workspace-repo-map scans a workspace root for Git repositories and writes a compact JSON map of remotes, branches, dirty counts, marker files, and public or local-only classification hints.

Generated maps are portable by default: repository paths are root-relative, the local root is represented by a short hash, and credential-shaped material in remote URLs is always redacted. Dropping whole origins by class is opt-in via .repomap.toml.

Install

python -m pip install workspace-repo-map

Usage

workspace-repo-map --root . --output WORKSPACE-REPO-MAP.json
workspace-repo-map --json

Without --json, the map is written to <root>/WORKSPACE-REPO-MAP.json (or --output) and a one-line summary (wrote <path> / repos=N dirty=M) is printed.

Classification is driven by an optional .repomap.toml at the workspace root (see example.repomap.toml). With no config, repos are classified by a neutral remote-host heuristic: local (no remote), public (origin on a public host), or private. Here public means "origin is on a public code-hosting platform" — a heuristic, not a guarantee of visibility.

For a full install line, the complete flag list, the importable Python API, and worked examples with expected output, see USAGE.md. A runnable end-to-end demo lives in examples/demo.py.

Notes

  • This CLI is agent assisted. Review output before sharing it in public.
  • Repository names and branch details are exported from local git metadata.
  • Absolute local root paths are not included by default.

Zain Dana Harper — small tools with explicit edges. Portfolio · HarperZ9 Built with Claude Code; reviewed, tested, and owned by me.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

workspace_repo_map-0.2.0.tar.gz (34.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

workspace_repo_map-0.2.0-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file workspace_repo_map-0.2.0.tar.gz.

File metadata

  • Download URL: workspace_repo_map-0.2.0.tar.gz
  • Upload date:
  • Size: 34.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for workspace_repo_map-0.2.0.tar.gz
Algorithm Hash digest
SHA256 abac3bb79e16fd872d51f3ab006e213b6106a1d49eb6d8008ae2e5919c7fb4f7
MD5 1d22ddf0c09939e4ae31b169cdcdfcf8
BLAKE2b-256 f1a0c2530f68323bcfe4452a54d1fbd0f9fa84799b1dacf2c5758edddecbf424

See more details on using hashes here.

File details

Details for the file workspace_repo_map-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for workspace_repo_map-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 055bae10ae4520b11845bcb394cf557e379681a4b217c891e2014786f5a19e3d
MD5 aad7bd5c3e6055127e8fa3b3cb28d760
BLAKE2b-256 9d47a913830409d9e548339c749b6b438c97f97d755045c0eb47bf2291328e55

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page