https://github.com/efjerryyang/repo2md
A simple tool to export a code repository into readable markdown file. Automatically exclude files and directories specified by `.gitignore` and `.git/info/exclude`. Convenient for prompting LLMs. Allow force ignoring/including files/directories by cli arguments.
https://github.com/efjerryyang/repo2md
Last synced: about 1 year ago
JSON representation
A simple tool to export a code repository into readable markdown file. Automatically exclude files and directories specified by `.gitignore` and `.git/info/exclude`. Convenient for prompting LLMs. Allow force ignoring/including files/directories by cli arguments.
- Host: GitHub
- URL: https://github.com/efjerryyang/repo2md
- Owner: efJerryYang
- Created: 2024-03-14T01:34:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-18T18:08:14.000Z (about 2 years ago)
- Last Synced: 2025-02-03T23:41:26.936Z (over 1 year ago)
- Language: Rust
- Homepage:
- Size: 41 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Repository to Markdown (repo2md)
> Credit to Claude-3
## Usage
```bash
Usage: repo2md [OPTIONS]
Arguments:
Path to the local repository
Options:
--include ... Patterns of files/directories to include
--ignore/--exclude ... Patterns of files/directories to ignore/exclude
-h, --help Print help
-V, --version Print version
```
Or clone this project and run with `cargo` from this project root:
```bash
cargo run -- [OPTIONS]
```
## Example Output
See [example_repo2md.md](example_repo2md.md) for an example of the output of this tool.
```sh
cargo run -- .
# or
repo2md .
```