https://github.com/chadnpc/repo2md

🔥 Blazingly fast PowerShell module that converts code repositories into a markdown format.
https://github.com/chadnpc/repo2md

Last synced: over 1 year ago
JSON representation

🔥 Blazingly fast PowerShell module that converts code repositories into a markdown format.

• Host: GitHub
• URL: https://github.com/chadnpc/repo2md
• Owner: chadnpc
• License: wtfpl
• Created: 2025-03-03T16:08:06.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-03T16:29:30.000Z (over 1 year ago)
• Last Synced: 2025-03-03T17:25:02.782Z (over 1 year ago)
• Language: PowerShell
• Homepage:
• Size: 24.4 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# [Repo2md](https://www.powershellgallery.com/packages/Repo2md)

🔥 Blazingly fast PowerShell thingy that converts code repositories into a markdown format.

[![Build Rust](https://github.com/chadnpc/Repo2md/actions/workflows/build_rust.yml/badge.svg)](https://github.com/chadnpc/Repo2md/actions/workflows/build_rust.yml)

[![Build Module](https://github.com/chadnpc/Repo2md/actions/workflows/build_module.yaml/badge.svg)](https://github.com/chadnpc/Repo2md/actions/workflows/build_module.yaml)

## Usage

```PowerShell

Install-Module Repo2md

```

then

```PowerShell

Import-Module Repo2md

# do stuff here.

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 .

```

## License

This project is licensed under the [WTFPL License](LICENSE).