jeirmeister/repo-to-text
1
0
Fork 0
mirror of https://github.com/kirill-markin/repo-to-text.git synced 2025-12-05 19:12:24 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

clipboard feature

Browse source
This commit is contained in:
Kirill Markin 2024-06-08 11:44:50 +02:00
parent a7d497f63a
commit 118da435cc
3 changed files with 17 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -7,6 +7,7 @@
- Generates a text representation of a directory's structure.
- Includes the output of the `tree` command.
- Saves the contents of each file, encapsulated in markdown code blocks.
- Copies the generated text representation to the clipboard for easy sharing.
- Easy to install and use via `pip` and Homebrew.
## Installation
@ -32,12 +33,14 @@ brew install yourusername/repo-to-text
To install `repo-to-text` locally for development, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/yourusername/repo-to-text.git
cd repo-to-text
```
2. Install the package locally:
```bash
pip install -e .
```
@ -50,7 +53,7 @@ After installation, you can use the `repo-to-text` command in your terminal. Nav
repo-to-text
```
This will create a file named `repo_structure.txt` in the current directory with the text representation of the repository.
This will create a file named repo_snapshot.txt in the current directory with the text representation of the repository. The contents of this file will also be copied to your clipboard for easy sharing.
## Enabling Debug Logging