repo-mapper-rs 🦀
Rust implementation of repo_mapper.
What it does:
A CLI tool to scan a code repository and generate a structured file tree map, inserted into your README.md written in Rust.
The map is fenced inside a markdown code block under a # Repo map section, if one exists the existing one is replaced, else it is appended to the bottom of the README.md.
Supported functionality:
- .gitignore
- file extension filtering
- directory exclusion
- ignore hidden files
Installation
pip install repo-mapper-rs
Or
uv add repo-mapper-rs
Example usage:
python -m repo_mapper \
--repo-root "/path/to/my_repo" \
--readme-path "/path/to/my_repo/README.md" \
--gitignore-path "/path/to/my_repo/.gitignore" \
--allowed-exts "py,rs,toml" \
--ignore-dirs ".venv,target" \
--ignore-hidden
This command:
- Traverses
/path/to/my_repo - Respects files excluded in
.gitignoreor listed in--ignore-dirs - Includes only files with extensions
.py,.rs,.toml. It's recommended to use this parameter to avoid unexpected files being added to the map. - Skips hidden files and directories (those starting with a dot)
- Inserts or updates the
# Repo mapsection in the README
Args
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
--repo-root |
str |
✅ | Path to the root of the repository to scan | |
--readme-path |
str |
❌ | './README.md' |
Path to the README file that will be modified |
--gitignore-path |
str |
❌ | './.gitignore' |
Path to the .gitignore file |
--allowed-exts |
Comma-separated str |
❌ | 'py,md,toml,lock,yaml,ipynb' |
Extensions to include (e.g. 'py,rs,md'). Note this is overruled by the .gitignore. |
--ignore-dirs |
Comma-separated str |
❌ | '.git,.venv,build,dist' |
Directories to exclude (e.g. '.venv,target'). If not supplied, all directories will be evaluated. Note this is overruled by the .gitignore. |
--output-mode |
str |
❌ | 'readme' |
Output mode to display the tree: choices=['readme', 'shell']. |
--ignore-hidden |
Flag (no value) | ❌ | If set, hidden files and directories will be ignored | |
--dirs-only |
Flag (no value) | ❌ | If set, only directories and subdirectories will be mapped (useful with larger codebases). |
New Features:
0.4.0
repo-map-desc:- adding
repo-map-desc:to a line will treat everything afterrepo-map-desc:up to the end of the line as a file description. - that description is added to the corresponding file in the repo map
- it will ignore any characters before
repo-map-desc:(e.g. comments or code) - only apply to the first matching line per file
- adding
0.5.0
.repo-map-descfiles- add a
.repo-map-descfile in a directory with text matching therepo-map-desc:prefix to the file - that description is then added to the dir on the repo-map
- only apply to the first matching line per file
- add a
Example
(in root/some_dir/.repo-map-desc)
repo-map-desc: this is the description that shows up in the repo map for the some_dir directory
Repo map
├── benches
│ ├── core
│ │ └── domain
│ │ ├── mod.rs # basic data creation for benches
│ │ └── render.rs
│ └── repo_mapper_rs_benchmark.rs
├── python
│ └── repo_mapper # the python CLI interface that calls the rust core
│ ├── __init__.py
│ └── __main__.py # Main CLI entry point
├── src
│ ├── core # the core rust code that does the work
│ │ ├── domain # main domain objects handles pure transformations of the files
│ │ │ ├── mod.rs
│ │ │ ├── render.rs
│ │ │ ├── repo_entry.rs # simple implementation of a repo object
│ │ │ ├── ret_codes.rs
│ │ │ ├── transform.rs # Where the file tree is generated
│ │ │ └── utils.rs
│ │ ├── parsing # convert interactions with the outside world into something useful
│ │ │ ├── args.rs
│ │ │ ├── context.rs
│ │ │ ├── file_text.rs
│ │ │ ├── gitignore.rs
│ │ │ ├── mod.rs
│ │ │ └── readme.rs
│ │ ├── adapters.rs
│ │ └── mod.rs
│ ├── api.rs # The translation layer between python and rust
│ └── lib.rs
├── tests
│ └── integration_tests.rs # component level integration tests using FakeFileSystem
├── Cargo.lock
├── Cargo.toml
├── LICENSE
├── README.md # Installation and simple docs
├── pyproject.toml
└── uv.lock
(generated with repo-mapper-rs)
::
Ret codes
| RetCode | int | description |
|---|---|---|
NoModification |
0 | The Repo map reflects the current state of the repo. |
ModifiedReadme |
1 | The README was updated. |
FailedParsingFile |
2 | Failed to read the file to string. |
FailedToWriteReadme |
3 | Failed to write the modified README to file. |
InvalidFilename |
4 | The given README.md or .gitignore path does not match the expected basename. |
1 maintainer
Metadata
1 maintainer
Release files for repo-mapper-rs 0.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| repo_mapper_rs-0.5.1.tar.gz | 33.4 kB | With provenance | Details for repo_mapper_rs-0.5.1.tar.gz |
Built distributions (wheels)
Total release size: 9.0 MB
Release files / repo_mapper_rs-0.5.1.tar.gz
| Download URL | repo_mapper_rs-0.5.1.tar.gz |
|---|---|
| Size | 33.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d9332b9840ced9eef8457dcd73d320d2444f9431c2d73d9c3957eef8a2fac3c6
|
|
BLAKE2b-256 checksum How to use checksums |
584461cbafad06b845be444f0ef1831c0162ae91ebb8d9dea5d3e14ee4d1ce3d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp315-cp315-win_amd64.whl
| Download URL | repo_mapper_rs-0.5.1-cp315-cp315-win_amd64.whl |
|---|---|
| Size | 551.6 kB |
| Tags | CPython 3.15 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
112963fbe5f4c045fff140c083d56a485b2b50933ebdf4e95ea07bb3593a191f
|
|
BLAKE2b-256 checksum How to use checksums |
d2fad8452d79b0e09eadfd05f8dbfe4a7f815e036fc0ee2dbad85a7293382df9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp315-cp315-manylinux_2_34_x86_64.whl
| Download URL | repo_mapper_rs-0.5.1-cp315-cp315-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 667.3 kB |
| Tags | CPython 3.15 Linux glibc 2.34+ x86-64 |
|
SHA-256 checksum How to use checksums |
68c7de7e921d5935419e9f2f1ce84430c1930b9595517377f444055bd65f31c2
|
|
BLAKE2b-256 checksum How to use checksums |
0c81ffeb40a101fc594a82f0c00787f5f91482d60e88e30cdb7e5e9297f4f8c8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp315-cp315-macosx_11_0_arm64.whl
| Download URL | repo_mapper_rs-0.5.1-cp315-cp315-macosx_11_0_arm64.whl |
|---|---|
| Size | 574.7 kB |
| Tags | CPython 3.15 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
389f9775c2dd2d5813d659264afd51a498feb4e823b2be90785903f16eb64613
|
|
BLAKE2b-256 checksum How to use checksums |
9ff267334018d7794c54aa79559de6e6839d82b86d0141f0a5f32dd661ca43fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp314-cp314-win_amd64.whl
| Download URL | repo_mapper_rs-0.5.1-cp314-cp314-win_amd64.whl |
|---|---|
| Size | 551.5 kB |
| Tags | CPython 3.14 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
785e7bbfdb7865c2407a854bc80302ae555e13b3b268e003cd557f38e201f3a9
|
|
BLAKE2b-256 checksum How to use checksums |
9dc238c5300ce25fa7bea46f1c06b07bfb4417ab3035df22da95eee11ea4e7c6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp314-cp314-manylinux_2_34_x86_64.whl
| Download URL | repo_mapper_rs-0.5.1-cp314-cp314-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 667.1 kB |
| Tags | CPython 3.14 Linux glibc 2.34+ x86-64 |
|
SHA-256 checksum How to use checksums |
bcc63096ebc3c1165cffd40dd195861ae8732c52d299841314cd52109c072cee
|
|
BLAKE2b-256 checksum How to use checksums |
2aef4369ff151752989e99b4e6db121d59d85c4536eed91481de304320c8cf90
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp314-cp314-macosx_11_0_arm64.whl
| Download URL | repo_mapper_rs-0.5.1-cp314-cp314-macosx_11_0_arm64.whl |
|---|---|
| Size | 574.6 kB |
| Tags | CPython 3.14 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
ba0896164122091e287957ad50a22375fcd4930a4231aa00e51cae43d4edc346
|
|
BLAKE2b-256 checksum How to use checksums |
0c86823263deb3249e4764500deee50f526fbfe8bf49b2bef3bf6a64fba864c5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp313-cp313-win_amd64.whl
| Download URL | repo_mapper_rs-0.5.1-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 550.8 kB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
35ac22ee28026597a47bf6d7ba582bf5200d531c8c8d938fd802fd06a110a619
|
|
BLAKE2b-256 checksum How to use checksums |
afc189b745794f26f247fd43eaa057e6a350730dc9e187763e793188e9e71825
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp313-cp313-manylinux_2_34_x86_64.whl
| Download URL | repo_mapper_rs-0.5.1-cp313-cp313-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 666.3 kB |
| Tags | CPython 3.13 Linux glibc 2.34+ x86-64 |
|
SHA-256 checksum How to use checksums |
f722086e692da92e1b755ad0466a48c2338c84e8842af5e9b59db71046d9a490
|
|
BLAKE2b-256 checksum How to use checksums |
6646c02707102ba6f987da8e2c40057b05612f2a2de661785dc2228d44e70fca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | repo_mapper_rs-0.5.1-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 574.1 kB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
422e741bf977ba67b14f3bf0ed1cd32828134626f0654c14b50c8275286c1f2b
|
|
BLAKE2b-256 checksum How to use checksums |
0761eed46a0761a4a991019147b0ffa5bbeddda47395e8e742787728f69b80c6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp312-cp312-win_amd64.whl
| Download URL | repo_mapper_rs-0.5.1-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 551.0 kB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
1060201f20e1092529e80104f7db2da5d8043759cc7c16866ab3e53b847ea06b
|
|
BLAKE2b-256 checksum How to use checksums |
afc4e3db86a2c4a357046cc2e48822f7897823b7803d2e89a3e293f5b95ea29b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp312-cp312-manylinux_2_34_x86_64.whl
| Download URL | repo_mapper_rs-0.5.1-cp312-cp312-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 666.4 kB |
| Tags | CPython 3.12 Linux glibc 2.34+ x86-64 |
|
SHA-256 checksum How to use checksums |
9c4c36bc2c3a4f65c22721ac27cb2443db6075a5ce1f30c291bb63ed89b57c73
|
|
BLAKE2b-256 checksum How to use checksums |
1894726907afacda03b7ec93e24975567899f7a584af26c4639746134ea76bfa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | repo_mapper_rs-0.5.1-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 574.1 kB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
f2b301657f2b124c037dbd12fe34da2374e44450b2808a9b3c12b2406954809e
|
|
BLAKE2b-256 checksum How to use checksums |
a6db7a2d8e6a1315819682f3139c560590b0226d321a3ed90c2c250f9eb211e8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp311-cp311-win_amd64.whl
| Download URL | repo_mapper_rs-0.5.1-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 551.8 kB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
e8625568daa62db897b65f70cac1e5ab9d31b0471db2b4a10bf75de392298f96
|
|
BLAKE2b-256 checksum How to use checksums |
7602b41fa4feafb23ae07cb92b80a8f22d09d210262ad835a2f5092163d1fd85
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp311-cp311-manylinux_2_34_x86_64.whl
| Download URL | repo_mapper_rs-0.5.1-cp311-cp311-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 667.0 kB |
| Tags | CPython 3.11 Linux glibc 2.34+ x86-64 |
|
SHA-256 checksum How to use checksums |
99694ee2799981eb46f2d824feb13aa881b524cacae714b35331b820f6fde9b5
|
|
BLAKE2b-256 checksum How to use checksums |
f472c939c5efcf12e1843a14cc452af0d63a4e3fdaab9c191118f1c0e1dc3e72
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logRelease files / repo_mapper_rs-0.5.1-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | repo_mapper_rs-0.5.1-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 575.0 kB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
d574c43e332068044f6b2af222c840d9c1d5e662f3a74886f8b572857764d847
|
|
BLAKE2b-256 checksum How to use checksums |
093676e5165d4a311f6749141a124095f6c690c3c41e61d76843bf35c0a509b8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logSecurity for repo-mapper-rs 0.5.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 16 files in this release have been uploaded with provenance metadata.
Attestation for repo_mapper_rs-0.5.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
