Skip to main content

A tool to package a repository into a single text file while respecting .gitignore.

Project description

Build Quality Gate Status

Codeorite

A CLI tool to package repository code into a single text file, respecting .gitignore rules.

Installation

pip install codeorite

Usage

Basic usage:

codeorite --root /path/to/repo --output-file output.txt

Options

  • --root: Repository root directory (default: current directory)
  • --output-file: Output file path
  • --config: Path to config file (default: codeorite_config.yaml)
  • --languages-included: Languages to include (e.g., python rust javascript)
  • --languages-excluded: Languages to exclude
  • --includes: Additional file extensions to include (e.g., .md .txt)
  • --excludes: File extensions to exclude (e.g., .pyc .log)
  • --custom-instructions: Lines to prepend as instructions

Examples

Package only Python files:

codeorite --root . --output-file output.txt --languages-included python

Package multiple languages, exclude web assets:

codeorite --root . --output-file multi.txt \
    --languages-included python rust typescript javascript \
    --excludes .json .html .css

Include markdown files, exclude Python:

codeorite --root . --output-file docs.txt \
    --includes .md \
    --excludes .py .pyc

Configuration File

Create codeorite_config.yaml in your repository:

languages_included:
  - python
  - rust
languages_excluded:
  - javascript
includes:
  - .md
excludes:
  - .pyc
custom_instructions:
  - "# Project: MyRepo"
  - "# Author: Dev Team"

Output Format

The output file contains:

  1. Custom instructions (if provided)
  2. Directory tree of included files
  3. Contents of each included file

Notes

  • Respects .gitignore rules
  • CLI arguments override config file settings
  • Cannot include and exclude the same language/extension

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codeorite-0.2.4.tar.gz (23.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codeorite-0.2.4-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file codeorite-0.2.4.tar.gz.

File metadata

  • Download URL: codeorite-0.2.4.tar.gz
  • Upload date:
  • Size: 23.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for codeorite-0.2.4.tar.gz
Algorithm Hash digest
SHA256 6d1986c8c765e2b3f07fcc040211cd75e6672e1536a1a8373f358ac02b49ad6f
MD5 e078d30c91a899336c1305f65b63f755
BLAKE2b-256 51e51f0de6b95450dc18694fbcd554f2ddc830d2cc0acb6ef9c50821a42a0bec

See more details on using hashes here.

Provenance

The following attestation bundles were made for codeorite-0.2.4.tar.gz:

Publisher: publish.yml on KeplerOps/codeorite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file codeorite-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: codeorite-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 13.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for codeorite-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 415f39ebcf6d4f0d2d038a54bfacdbd769f204ff4e8409ba305f05fa2ea231a4
MD5 1be5ddd0fe99b73ff417d2b104000255
BLAKE2b-256 648b345c36cfe25ab023ca18aa2c148a406fe849b45efac0589a591249d58a74

See more details on using hashes here.

Provenance

The following attestation bundles were made for codeorite-0.2.4-py3-none-any.whl:

Publisher: publish.yml on KeplerOps/codeorite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page