Skip to main content

A CLI utility to generate prompts from project source code.

Project description

Anti-Cursor

A Python CLI utility to generate a Markdown prompt describing a project's source code structure and contents. The generated prompt includes an introductory explanation, a detailed projection of the file structure, and code listings from each source file (with file names).

Features

  • Accepts either a local directory path or a GitHub repository URL.
  • Generates a Markdown prompt with:
    • A brief introduction to assist language models in understanding the context.
    • A detailed project structure tree.
    • Code listings from individual source files.
  • Clean architecture with clear separation between CLI, core logic, and file parsing.
  • Unit tests to ensure proper functionality.

Installation

From sources

  1. Clone the repository:
git clone https://github.com/Alexander-Ploskin/anti-cursor.git
  1. Install the dependencies:
sudo apt-get install xclip
pip install poetry
poetry install

From package

pip install anti-cursor

Usage

Run the CLI tool using:

anti-cursor <source>

Where <source> is either a local directory path or a GitHub repository URL.

Examples:

  1. Generate prompt from local directory:
anti-cursor .
  1. Generate prompt from GitHub repository:
anti-cursor https://github.com/Alexander-Ploskin/anti-cursor

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

anti_cursor-1.0.0.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

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

anti_cursor-1.0.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file anti_cursor-1.0.0.tar.gz.

File metadata

  • Download URL: anti_cursor-1.0.0.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for anti_cursor-1.0.0.tar.gz
Algorithm Hash digest
SHA256 03d56ea2ad87bb524f234bba04fefa32bd1cfe381c5e106e9329fc6ec785a02c
MD5 1fd99d7dfdd9b53557a207b1e3e2cb9b
BLAKE2b-256 c188c8ed653e9b4c18b69abf0a0abdb31e2176dc4cc431145950237dbedfd1aa

See more details on using hashes here.

File details

Details for the file anti_cursor-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: anti_cursor-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for anti_cursor-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79d9796bac5c2caad60938651f54658c02fff863b719a68a839eb853f09b61d5
MD5 f2252bf0c1cd0ae1c1f55273b65cd0cd
BLAKE2b-256 c0d75179ee508f93c3761f7b052cd742c0725b06fe30dad65232cb96e1ba3a14

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