https://github.com/tmpecho/pacont
A tool to easily gather code context to give to an AI like ChatGPT or Claude.
https://github.com/tmpecho/pacont
Last synced: 3 months ago
JSON representation
A tool to easily gather code context to give to an AI like ChatGPT or Claude.
- Host: GitHub
- URL: https://github.com/tmpecho/pacont
- Owner: Tmpecho
- License: mit
- Created: 2024-07-05T17:34:34.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-07-27T01:00:10.000Z (10 months ago)
- Last Synced: 2024-07-27T02:22:10.632Z (10 months ago)
- Language: Rust
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pacont
> A tool to easily gather code context to give to an AI like ChatGPT or Claude.
____
## Overview
**Pacont** (short for Path and Content) is a simple and efficient CLI tool designed to recursively print file paths and their contents within specified directories or files. This tool is particularly useful for gathering code context to provide to AI models like ChatGPT or Claude, making it easier to analyze and understand large codebases.
## Features
- Recursively traverse directories and subdirectories.
- Print file paths relative to the input directory.
- Output the contents of each file.
- Accept multiple directories and files as input, concatenating their contents with a separator.
- Control maximum recursion depth.
- Include error messages in the output for files that cannot be read.
## Installation
### Prerequisites
- Rust and Cargo installed. If you haven't installed Rust yet, you can do so by running:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
### Build from Source
1. Clone the repository:
```bash
git clone https://github.com/Tmpecho/pacont.git
cd pacont
```
2. Build the project:
```bash
cargo build --release
```
3. Move the executable to a directory in your PATH:
#### MacOS/Linux:
```bash
sudo cp target/release/pacont /usr/local/bin/pacont
```
### Homebrew Installation
```bash
brew tap Tmpecho/pacont
brew install pacont
```
## Usage
```bash
pacont [OPTIONS] ...
```
### Options
- `-m, --max-depth `: Maximum recursion depth for directories (0 means no recursion) [default: usize::MAX]
- `-i, --include-errors`: Include error messages in the output
- `-o, --output-information`: Display the number of characters and words of the output without printing the contents
- `-h, --help`: Print help information
- `-V, --version`: Print version information
### Example
Given a directory structure:
```
src/
├── div
│ └── test.kt
└── main.kt
README.md
misc/
├── notes.txt
```
Running `pacont src README.md misc/` will output:
```
**div/test.kt**
//comment
**main.kt**
println("hello")
--------------------------------------------------------------------------------
**README.md**
# Pacont
A very simple CLI tool to recursively print file paths and contents in a directory.
--------------------------------------------------------------------------------
**notes.txt**
Some notes here...
```
Running pacont `-o src README.md misc/` will output:
```
Total Characters: 1234
Total Words: 234
```
## Contributing
Contributions are welcome! Feel free to open an issue or submit a pull request if you have any improvements or new features to add.