docker instructions cleanup

This commit is contained in:
Kirill Markin 2024-12-30 15:58:04 +01:00
parent 7c32b7a565
commit cde732c57d
No known key found for this signature in database
GPG key ID: 03AB9530E15B9C1C
4 changed files with 67 additions and 33 deletions

View file

@ -98,6 +98,44 @@ You can customize the behavior of `repo-to-text` with the following options:
This will write the output directly to `myfile.txt` instead of creating a timestamped file.
## Docker Usage
### Building and Running
1. Build the container:
```bash
docker compose build
```
2. Start a shell session:
```bash
docker compose run --rm repo-to-text
```
Once in the shell, you can run `repo-to-text`:
- Process current directory:
```bash
repo-to-text
```
- Process specific directory:
```bash
repo-to-text /home/user/myproject
```
- Use with options:
```bash
repo-to-text --output-dir /home/user/output
```
The container mounts your home directory at `/home/user`, allowing access to all your projects.
## Settings
`repo-to-text` also supports configuration via a `.repo-to-text-settings.yaml` file. By default, the tool works without this file, but you can use it to customize what gets included in the final text file.