Skip to main content

A CLI tool for building and running magical LLM prompts

Project description

🧙‍♂️ Wizard Prompt CLI

Summon the power of Claude AI to transform your code with a wave of your terminal wand!

PyPI version License: MIT

Wizard Prompt CLI is a magical command-line interface that conjures Claude AI to analyze, enhance, and transform your project files. Ask questions about your code in natural language, and watch as the AI wizard works its spells to provide insights and implement changes.

⚠️ Important: API Key Required

This tool requires an Anthropic API key to function. You must set the ANTHROPIC_API_KEY environment variable before using any commands. See the API Key Setup section below for details.

Without this environment variable set, no commands will work!

# Set this before using any wiz commands
export ANTHROPIC_API_KEY=your_api_key_here

✨ Magical Features

  • 🔮 Automatically scans your project's grimoire of files, carefully avoiding binary artifacts
  • 📜 Respects ancient incantations like .gitignore rules
  • 🌊 Streams Claude's mystical thinking process as it crafts responses
  • 🪄 Magically applies code changes with a single command
  • 🧪 Powerful file filtering to focus the AI's attention on specific scrolls of code
  • 📚 Handles file output with proper directory creation spells
  • 📥 Supports reading enchantments from stdin
  • 🖼️ Includes image attachment capabilities for visual context
  • 🚫 Exclude files via regex patterns to fine-tune your magical selection
  • 📋 Preview files that would be included before spending API tokens
  • 📝 Supports .wizrc configuration file for persistent command-line arguments

🧙 Installation

Summon the Wizard to your environment:

pip install wizard-prompt-cli

Or conjure it from source:

git clone https://github.com/ddrscott/wizard-prompt-cli.git
cd wizard-prompt-cli
pip install -e .

🔑 API Key Setup

Before casting spells, you need to obtain your magical key:

  1. Create an account at Anthropic if you don't have one
  2. Generate an API key from your Anthropic dashboard
  3. Set the environment variable with your secret key:
# For Linux/macOS
export ANTHROPIC_API_KEY=your_api_key_here

# For Windows (Command Prompt)
set ANTHROPIC_API_KEY=your_api_key_here

# For Windows (PowerShell)
$env:ANTHROPIC_API_KEY="your_api_key_here"

For permanent enchantment, add this to your shell profile (.bashrc, .zshrc, etc.).

🔴 Note: The ANTHROPIC_API_KEY environment variable is required. The tool will not function without it properly set. If you encounter errors about unauthorized access or missing API keys, please verify this variable is correctly set.

📝 Configuration with .wizrc

You can store command configurations in a .wizrc YAML file in your project directory:

# Example .wizrc file
files:
  exclude: ["*test*"]
  image: ["screenshot.png"]
  max_tokens: 80000

# Example .wizrc configuration
files: &files
  exclude: ["*.log", "build", "dist"]
  
prompt:
  <<: *files

The tool will automatically load this configuration and apply it to corresponding commands. The example above shows:

  • Setting exclusion patterns to ignore specific files
  • Using YAML anchors (&files) to define common configurations
  • Inheriting settings between commands with YAML merge keys (<<: *files)
  • Configuring command-specific options like max_tokens

Each top-level key in the YAML corresponds to a subcommand, with nested options matching the command's options. All configuration is completely optional, and command-line arguments will override settings in .wizrc when provided.

The .wizrc file is automatically excluded from git via .gitignore.

🪄 Usage

Wizard Prompt CLI offers three main incantations and supports configuration via a .wizrc file:

📝 Prompt Command

Invoke Claude with your questions and project files:

wiz prompt "How can I improve this code?"

Include specific scrolls:

wiz prompt -f main.py -f utils.py "How can I make these files more efficient?"

Add images for visual context:

wiz prompt -i screenshot.png "What UI improvements would you suggest based on this screenshot?"

Exclude files matching a pattern:

wiz prompt -x ".*test.*\.py$" "Analyze all non-test Python files"

Options:

  • -f, --file: Specify files to include (can be used multiple times)
  • -i, --image: Include image files as context (can be used multiple times)
  • -o, --output: Location to write response (default: .response.md)
  • -m, --max-tokens: Maximum tokens for the response (default: 60000)
  • -t, --thinking-tokens: Maximum tokens for Claude's thinking process (default: 16000)
  • -x, --exclude: Regular expression pattern to exclude files

The wizard's response will be saved to .response.md by default, and a copy of the full messages including system prompt will be saved to .messages.md.

📋 Files Command

Preview which files would be included in a prompt without calling the API:

wiz files

This command accepts the same filtering options as prompt:

wiz files -f main.py -f utils.py
wiz files -x ".*test.*\.py$"

Options:

  • -f, --file: Specify files to include (can be used multiple times)
  • -i, --image: Include image files as context (can be used multiple times)
  • -x, --exclude: Regular expression pattern to exclude files

Use this command to verify file selection before spending API tokens with a real prompt.

✨ Apply Command

Cast the spell to implement the suggested changes:

wiz apply

Or specify a different spell book:

wiz apply custom_response.md

You can also channel content directly to the apply command:

cat response.md | wiz apply -

📚 How It Works

  1. The prompt command channels your question and file contents to Claude
  2. Claude weaves a spell over your files and provides a response with suggested changes
  3. Changes are formatted with [FILE path]...[/FILE] magical markers
  4. The apply command interprets these markers and transforms your files

🌟 Examples

Ask the wizard to refactor a specific function:

wiz prompt -f src/utils.py "Refactor the parse_data function to be more efficient"

Conjure a new feature:

wiz prompt "Add a progress bar to the file processing function"

Get feedback on UI design with an image:

wiz prompt -i design.png -f styles.css "How can I improve this layout?"

Exclude test files when analyzing your codebase:

wiz prompt -x ".*test.*\.py$|__pycache__" "Review my Python code architecture"

Preview files that would be included in a complex filter:

wiz files -x "\.(json|md|txt)$"

Focus on specific file types by excluding others:

wiz prompt -x "\.(json|md|txt)$" "Analyze only my code files, not documentation or data"

Adjust token limits for complex analysis:

wiz prompt -m 80000 -t 20000 "Perform a comprehensive security audit of this codebase"

Then cast the spell to apply the changes:

wiz apply

Or do it all in one and see the output at the same time:

wiz prompt "Fix bugs" | tee -a /dev/tty | wiz apply -

🔄 Git Integration Best Practices

When using Wizard Prompt CLI to modify your code, it's essential to integrate with Git or your preferred version control system to keep track of changes and maintain safety.

Before Casting Spells

  1. Commit your current changes to create a restore point:

    git add .
    git commit -m "Save state before wizard modifications"
    
  2. Alternatively, create a new branch for experimental wizard changes:

    git checkout -b wizard-experiment
    

After Applying Changes

  1. Review all modifications with Git before committing:

    git diff
    
  2. For a more detailed review, use a visual diff tool:

    git difftool
    
  3. For a file-by-file review:

    git add -p
    
  4. If you're satisfied with the changes:

    git add .
    git commit -m "Applied AI-suggested improvements to X"
    
  5. If the wizard's spells went awry, revert the changes:

    git reset --hard HEAD~1  # If you committed before using wiz
    # or
    git checkout -- .        # If you haven't committed the wizard's changes
    

Always review changes carefully before committing them to your repository. The AI is powerful but not infallible - your expertise is the final arbiter of which magical transformations to keep!

🔧 Troubleshooting

If you encounter errors like "API key not found" or "Unauthorized", check that:

  1. You have set the ANTHROPIC_API_KEY environment variable correctly
  2. The API key is valid and active in your Anthropic account
  3. You've correctly formatted the environment variable without extra spaces

You can verify your environment variable is set correctly with:

# Linux/macOS
echo $ANTHROPIC_API_KEY

# Windows PowerShell
echo $env:ANTHROPIC_API_KEY

📜 License

MIT License


Star History

Star History Chart

✨ If this magical tool helped you, consider giving it a star! ✨

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

wizard_prompt_cli-0.4.0.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

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

wizard_prompt_cli-0.4.0-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file wizard_prompt_cli-0.4.0.tar.gz.

File metadata

  • Download URL: wizard_prompt_cli-0.4.0.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for wizard_prompt_cli-0.4.0.tar.gz
Algorithm Hash digest
SHA256 635a4eb2cc4eed87688204afa6e59c4261e355fed50816c564b5266f3fbe21a1
MD5 ead282adec36aaa78a78459698809f8d
BLAKE2b-256 59dbf49a896de42cd2a7c6ed7dfa49913536d3a390486c5a87e932a8d67a9c78

See more details on using hashes here.

Provenance

The following attestation bundles were made for wizard_prompt_cli-0.4.0.tar.gz:

Publisher: python-publish.yml on ddrscott/wiz

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

File details

Details for the file wizard_prompt_cli-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for wizard_prompt_cli-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 50d1c77c4da49ba6b49c14b369c411c969383e86fa79e3bfae25d39a8fa0e1df
MD5 8dd848aa5dd29a81a47c5418563b06a0
BLAKE2b-256 18b7ce75d49efdd9561f397853365882ed80b6e1a9f9fc9cee1d2b72ba02b607

See more details on using hashes here.

Provenance

The following attestation bundles were made for wizard_prompt_cli-0.4.0-py3-none-any.whl:

Publisher: python-publish.yml on ddrscott/wiz

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