Skip to main content

CLI tool for creating code snapshots with configurable settings

Project description

🦜 LLM-Auto-Context

A CLI tool for generating code snapshots for AI code assistants such as ChatGPT and Claude.

Python Version License

Installation

Using UV (recommended):

uv pip install llm-auto-context

Using pip:

pip install llm-auto-context

Usage

Basic usage:

llm_auto_context

This will use the default config file .codesnapshot.json in your current directory.

Configuration

Create a .codesnapshot.json file in your project root:

{
    "directories": ["src", "lib"],
    "output_file": "code_snapshot.md",
    "include_extensions": [".py", ".js", ".ts"],
    "exclude_dirs": ["node_modules", ".git", "build"],
    "exclude_files": ["secrets.env"]
}

CLI Options

  • --config: Path to config file (default: .codesnapshot.json)
  • -d, --directory: Override directories to scan (can be used multiple times)
  • -o, --output: Override output file path
  • --include: Override file extensions to include (can be used multiple times)
  • --exclude-dir: Additional directories to exclude (can be used multiple times)
  • --exclude-file: Additional files to exclude (can be used multiple times)

Example:

llm_auto_context -d src -d lib -o snapshot.md --exclude-dir tests

Development

  1. Clone the repository
  2. Create a virtual environment:
uv venv
  1. Install dependencies:
uv pip install -e ".[dev]"
  1. Run tests:
pytest

License

MIT

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

llm_auto_context-1.2.0.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

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

llm_auto_context-1.2.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file llm_auto_context-1.2.0.tar.gz.

File metadata

  • Download URL: llm_auto_context-1.2.0.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.4.28

File hashes

Hashes for llm_auto_context-1.2.0.tar.gz
Algorithm Hash digest
SHA256 d962bf62697e8285338e99120c5655b36d5cdf55090a50f59272413d9b8c5408
MD5 d93cc761fdcfb8186e0053c490d84b20
BLAKE2b-256 10677938bd50b648ffd1b0764e680746b89ee03384cfb2ec6261315a95b542be

See more details on using hashes here.

File details

Details for the file llm_auto_context-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for llm_auto_context-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6017c6dfc9b3db090b88393f3b3b557d2ac58cbe8a4d4a5bd3e4c0e20296ab08
MD5 71d6dd0c1f21103dbf2056485a71da9a
BLAKE2b-256 d1339cf96243137ee0bcd25983b861bd313aa636468764b719cb9c6694463e7e

See more details on using hashes here.

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