# repotofile-cli
`repotofile-cli` is a very light weight command-line tool that allows users to download a GitHub repository or an existing file directory and generate a text file containing the repository's code, excluding files specified in `.gitignore`. It's particularly useful for code analysis, backups and uploading to large language models like chatGPT.
## Features
- Clone any public GitHub repository.
- Optionally exclude configuration files, replacing their content with a placeholder.
- Generate a single text or markdown file with the entire codebase, neatly separated by files.
- Easy to install and use with a simple command.
- Ignore config files and directories by default
- Add custom files and directories to ignore
## Installation
To install `repotofile-cli`, ensure you have Python installed on your system, then run:
```bash
pip install repotofile-cli
```
## Usage
After installation, you can use the `repotofile` command or its shorthand `rtf`:
```bash
repotofile <repository-url> [options]
```
or
```bash
rtf <repository-url> [options]
```
or
```bash
repotofile <directory> [options]
```
### Options
- `-b`, `--branch` : Specify a branch or tag to download. Defaults to the default branch of the repository.
- `-o`, `--output` : Custom output file name or path. Defaults to '[repository-name].txt'.
- `--no-config` : Replace the content of configuration files with a placeholder comment.
### Examples
Cloning a repository and generating the default output file:
```bash
repotofile https://github.com/user/repo
```
Cloning a specific branch:
```bash
repotofile https://github.com/user/repo -b feature-branch
```
Generating a custom output file:
```bash
repotofile https://github.com/user/repo -o ~/Documents/repo_snapshot.txt
```
Ignoring custom files and directories:
```bash
repotofile https://github.com/user/repo --ignore-files "*.log,*.txt" --ignore-dirs "build,docs"
```
## Contributing
Contributions to `repotofile-cli` are welcome! Please read our contributing guidelines (link to guidelines) to get started.
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Maurits Bos - <maurits.bos@gmail.com>
Project Link: <https://github.com/mbbrainz/repotofile-cli>
Raw data
{
"_id": null,
"home_page": "https://github.com/mbbrainz/repotofile-cli",
"name": "repotofile-cli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "github cli tool repository conversion ai ai-tools",
"author": "Maurits Bos",
"author_email": "maurits.bos@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/34/30/ce31d161b971dd10ae8bf5a0aac196f958a086ccbdeeb3944df4d1820b9f/repotofile-cli-0.2.2.tar.gz",
"platform": null,
"description": "# repotofile-cli\n\n`repotofile-cli` is a very light weight command-line tool that allows users to download a GitHub repository or an existing file directory and generate a text file containing the repository's code, excluding files specified in `.gitignore`. It's particularly useful for code analysis, backups and uploading to large language models like chatGPT.\n\n\n## Features\n\n- Clone any public GitHub repository.\n- Optionally exclude configuration files, replacing their content with a placeholder.\n- Generate a single text or markdown file with the entire codebase, neatly separated by files.\n- Easy to install and use with a simple command.\n- Ignore config files and directories by default\n- Add custom files and directories to ignore\n\n## Installation\n\nTo install `repotofile-cli`, ensure you have Python installed on your system, then run:\n\n```bash\npip install repotofile-cli\n```\n\n## Usage\n\nAfter installation, you can use the `repotofile` command or its shorthand `rtf`:\n\n```bash\nrepotofile <repository-url> [options]\n```\n\nor\n\n```bash\nrtf <repository-url> [options]\n```\n\nor\n\n```bash\nrepotofile <directory> [options]\n```\n\n### Options\n\n- `-b`, `--branch` : Specify a branch or tag to download. Defaults to the default branch of the repository.\n- `-o`, `--output` : Custom output file name or path. Defaults to '[repository-name].txt'.\n- `--no-config` : Replace the content of configuration files with a placeholder comment.\n\n### Examples\n\nCloning a repository and generating the default output file:\n\n```bash\nrepotofile https://github.com/user/repo\n```\n\nCloning a specific branch:\n\n```bash\nrepotofile https://github.com/user/repo -b feature-branch\n```\n\nGenerating a custom output file:\n\n```bash\nrepotofile https://github.com/user/repo -o ~/Documents/repo_snapshot.txt\n```\n\nIgnoring custom files and directories:\n\n```bash\n repotofile https://github.com/user/repo --ignore-files \"*.log,*.txt\" --ignore-dirs \"build,docs\"\n```\n\n## Contributing\n\nContributions to `repotofile-cli` are welcome! Please read our contributing guidelines (link to guidelines) to get started.\n\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n## Contact\n\nMaurits Bos - <maurits.bos@gmail.com>\nProject Link: <https://github.com/mbbrainz/repotofile-cli>\n",
"bugtrack_url": null,
"license": "",
"summary": "A CLI tool to clone and process GitHub repositories.",
"version": "0.2.2",
"project_urls": {
"Bug Tracker": "https://github.com/mbbrainz/repotofile-cli/issues",
"Homepage": "https://github.com/mbbrainz/repotofile-cli"
},
"split_keywords": [
"github",
"cli",
"tool",
"repository",
"conversion",
"ai",
"ai-tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "75cd7482441b740e85e33d42b483f61f3f0d2c7c53d1b284599727448fc96847",
"md5": "e5b6961ce8cb0c42b855ab6227bba08a",
"sha256": "605e4552775e6bc6afecb7606af9740a8d7c723e5dc87c50c260c571f3de68a5"
},
"downloads": -1,
"filename": "repotofile_cli-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5b6961ce8cb0c42b855ab6227bba08a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6344,
"upload_time": "2023-11-07T19:01:30",
"upload_time_iso_8601": "2023-11-07T19:01:30.117644Z",
"url": "https://files.pythonhosted.org/packages/75/cd/7482441b740e85e33d42b483f61f3f0d2c7c53d1b284599727448fc96847/repotofile_cli-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3430ce31d161b971dd10ae8bf5a0aac196f958a086ccbdeeb3944df4d1820b9f",
"md5": "7ae3ad5c2714c8693ff0d4257d508ef4",
"sha256": "ae10901b4652e5cbb3cdc78c0eedbb3353b54a04ec9acd88d4454ad3db267df5"
},
"downloads": -1,
"filename": "repotofile-cli-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "7ae3ad5c2714c8693ff0d4257d508ef4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7155,
"upload_time": "2023-11-07T19:01:31",
"upload_time_iso_8601": "2023-11-07T19:01:31.687199Z",
"url": "https://files.pythonhosted.org/packages/34/30/ce31d161b971dd10ae8bf5a0aac196f958a086ccbdeeb3944df4d1820b9f/repotofile-cli-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-07 19:01:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mbbrainz",
"github_project": "repotofile-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "repotofile-cli"
}
JSON
