mirror of
https://github.com/kirill-markin/repo-to-text.git
synced 2025-12-05 19:12:24 -08:00
Merge remote-tracking branch 'remotes/caffeinum/add-aliases' into release/0.4.4
This commit is contained in:
commit
fd84b62395
3 changed files with 16 additions and 3 deletions
14
README.md
14
README.md
|
|
@ -42,6 +42,12 @@ After installation, you can use the `repo-to-text` command in your terminal. Nav
|
|||
repo-to-text
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
flatten
|
||||
```
|
||||
|
||||
This will create a file named `repo-to-text_YYYY-MM-DD-HH-MM-SS-UTC.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.
|
||||
|
||||
### Options
|
||||
|
|
@ -56,12 +62,18 @@ You can customize the behavior of `repo-to-text` with the following options:
|
|||
|
||||
This will save the file in the specified output directory instead of the current directory.
|
||||
|
||||
- `--create-settings`: Create a default `.repo-to-text-settings.yaml` file with predefined settings. This is useful if you want to start with a template settings file and customize it according to your needs. To create the default settings file, run the following command in your terminal:
|
||||
- `--create-settings` or `--init`: Create a default `.repo-to-text-settings.yaml` file with predefined settings. This is useful if you want to start with a template settings file and customize it according to your needs. To create the default settings file, run the following command in your terminal:
|
||||
|
||||
```bash
|
||||
repo-to-text --create-settings
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
repo-to-text --init
|
||||
```
|
||||
|
||||
This will create a file named `.repo-to-text-settings.yaml` in the current directory. If the file already exists, an error will be raised to prevent overwriting.
|
||||
|
||||
- `--debug`: Enable DEBUG logging. By default, `repo-to-text` runs with INFO logging level. To enable DEBUG logging, use the `--debug` flag:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue