Skip to main content

TUI app that enriches prompts using Groq API and project context

Project description

Magic Prompt

PyPI version Python 3.11+ License: GPL v3

A TUI and CLI tool that enriches short, vague prompts into detailed, structured prompts using Groq API and your project's actual file structure and codebase.

Features

  • 📁 Project-Aware: Scans your project's file structure, config files, and extracts code signatures
  • 🧠 AI-Powered: Uses Groq's fast LLM API to intelligently expand prompts
  • Real-Time Streaming: Watch the enriched prompt generate in real-time
  • 🖥️ Dual Mode: Interactive TUI or headless CLI for shell scripting

Installation

From PyPI

pip install ai-magic-prompt

Or with uv:

uv tool install ai-magic-prompt

From Source

git clone https://github.com/arterialist/magic-prompt.git
cd magic-prompt
pip install -e .

Setup

Get your Groq API key from console.groq.com/keys.

Set it as an environment variable:

export GROQ_API_KEY=gsk_...

Or create a .env file in your project directory:

GROQ_API_KEY=your_api_key_here

Usage

Headless CLI Mode

Run from anywhere as a shell command:

# Basic usage - enrich a prompt
magic-prompt "add user authentication"

# Pipe prompt from stdin
echo "add logging" | magic-prompt

# Specify project directory
magic-prompt -d /path/to/project "refactor the API"

# Quiet mode - only output result (good for piping)
magic-prompt -q "add tests" > enriched.md

CLI Options

Option Description
-d, --directory Project directory (default: from config or cwd)
-t, --tui Launch interactive TUI mode
-q, --quiet Only output result, no progress
--debounce MS Set debounce time for real-time mode
--save-dir DIR Save default directory for future runs
--show-config Show current configuration

Interactive TUI Mode

magic-prompt --tui
# OR just run without arguments:
magic-prompt
  1. Enter your project's root directory path
  2. Type a short prompt (e.g., "add user authentication")
  3. Watch the enriched, project-aware prompt stream in real-time
  4. Press Ctrl+Y to copy the enriched prompt

TUI Keyboard Shortcuts

Key Action
Enter Submit prompt
Ctrl+T Toggle real-time
Ctrl+Y Copy to clipboard
Ctrl+L Clear output
Ctrl+R Rescan project
Ctrl+Q Quit

How It Works

  1. Scans your project directory structure
  2. Extracts docstrings, function signatures, and imports
  3. Sends context + your prompt to Groq's LLM
  4. Streams an enriched version that references actual files and APIs

License

MIT License - see LICENSE for details.

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

ai_magic_prompt-0.1.2.tar.gz (27.2 kB view details)

Uploaded Source

Built Distribution

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

ai_magic_prompt-0.1.2-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

Details for the file ai_magic_prompt-0.1.2.tar.gz.

File metadata

  • Download URL: ai_magic_prompt-0.1.2.tar.gz
  • Upload date:
  • Size: 27.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ai_magic_prompt-0.1.2.tar.gz
Algorithm Hash digest
SHA256 8af524968bca5784b67c6a89381f681d09af806c8ecc7b166130e2b722e42609
MD5 d9fa4f71044b4b1a72e80d31cfc9bd09
BLAKE2b-256 d4895af11dd568a54ea222867c6c1887f540bf7a204123e80c956afa34de54ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_magic_prompt-0.1.2.tar.gz:

Publisher: pypi-deploy.yml on arterialist/magic-prompt

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

File details

Details for the file ai_magic_prompt-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_magic_prompt-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b1e621767deb71d8daa835535cd4a1b3ae2d63b0d698c671ddfce837d1c8c961
MD5 9b62a491aceb7a29e14835b7d7294cf9
BLAKE2b-256 8878ab65f31e8aed9654795059f094036e96f2a08b9294636492bcba2b9901ba

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_magic_prompt-0.1.2-py3-none-any.whl:

Publisher: pypi-deploy.yml on arterialist/magic-prompt

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