Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asnunes/cat-context
Have you ever wanted to ask a question about a project to a LLM but lost a lot of time trying to explain the structure of the project and the relevant files?
https://github.com/asnunes/cat-context
Last synced: about 1 month ago
JSON representation
Have you ever wanted to ask a question about a project to a LLM but lost a lot of time trying to explain the structure of the project and the relevant files?
- Host: GitHub
- URL: https://github.com/asnunes/cat-context
- Owner: asnunes
- License: mit
- Created: 2024-11-29T14:18:46.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-02T11:59:25.000Z (about 1 month ago)
- Last Synced: 2024-12-02T12:53:43.577Z (about 1 month ago)
- Language: Python
- Size: 24.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cat-context
Have you ever wanted to ask a question about a project to a LLM but lost a lot of time trying to explain the structure of the project and the relevant files?
`cctx` is a command-line tool that allows you to recursively print the file tree of a specified directory, display contents of specified files, and ignore certain paths or the entire tree. It's useful for quickly understanding the structure and content of a project in the context of a question.
## Features
- **Recursively print file trees**: Visualize the directory structure of your project.
- **Display file contents**: Easily view the contents of specified files.
- **Ignore paths**: Exclude certain files or directories from the tree.
- **Ignore entire tree**: Focus solely on specified files without displaying the tree.
- **Specify line ranges**: Display specific lines from files.
## Installation
You can install `cat-context` via pip:
```bash
pip install cat-context
```
This will install the `cat-context` package and make the `cctx` command available globally.
## Usage
```bash
cctx [OPTIONS] [FILE_PATHS...]
```
### Options
- `--cwd `: Change the current working directory. Defaults to the current directory.
- `-ip`, `--ignore-path `: Paths to ignore in the file tree (relative to cwd or absolute). Can be used multiple times to ignore multiple paths.
- `-it`, `--ignore-tree`: Ignore the entire tree and only display specified files.
### Arguments
- `FILE_PATHS`: One or more files to display contents of if they exist in the tree. You can specify line numbers using the format `path:start_line:end_line`.
### Examples
#### Display the file tree and the contents of specific files
```bash
cctx README.md cctx/main.py
```
#### Display contents of specific lines in a file (e.g., lines 10 to 20)
```bash
cctx cctx/main.py:10:20
```
#### Ignore the tree and only display contents of specified files
```bash
cctx --ignore-tree README.md
```
#### Ignore specific paths when displaying the tree
```bash
cctx --ignore-path=folder1 --ignore-path=folder2
```
#### Display the file tree of a specified directory
```bash
cctx --cwd=/path/to/directory
```
## Development
If you want to run `ctx` in development mode or contribute to the project, follow these steps.
### Clone the repository
```bash
git clone https://github.com/asnunes/ctx.git
cd cctx
```
### Install dependencies
Make sure you have Python 3 installed. It's recommended to use a virtual environment.
```bash
python3 -m venv venv
source venv/bin/activate # On Windows use venv\Scripts\activate
```
### Install the package in editable mode
```bash
pip install -e .
```
### Run the script
```bash
cctx [OPTIONS] [FILE_PATHS...]
```
Or directly via Python:
```bash
python cctx/main.py [OPTIONS] [FILE_PATHS...]
```
### Example
```bash
python cctx/main.py --cwd=. README.md
```
## Running Tests
To run the tests, use the `unittest` module from the root directory.
```bash
python -m unittest discover tests
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.