Skip to main content

A command-line agent.

Project description

Heare Developer CLI

Heare Developer CLI is a powerful and interactive coding assistant that leverages Anthropic's Claude AI models to help developers with various tasks. It provides a sandbox environment where you can perform file operations, execute bash commands, and interact with an AI assistant for coding-related queries and tasks.

Key Features

  1. Advanced AI Models: Access to Claude 3 models (Opus, Sonnet, Sonnet-3.5, Haiku) for varied needs and performance levels
  2. Intelligent File Handling: Smart file mention system using @ syntax for referencing files
  3. Sandbox Environment: Configurable sandbox modes for controlled file operations
  4. Tool Integration: Built-in tools for file and system operations, including Plane.so API integration for task management
  5. Command Auto-completion: Intelligent command and path completion
  6. Multi-line Input Support: Easy handling of multi-line code and text input
  7. Token Usage Tracking: Real-time monitoring of token usage and associated costs
  8. Rate Limiting Protection: Built-in rate limit handling with exponential backoff
  9. Permission Management: Granular control over file and system operations
  10. Rich Command History: Searchable command history with auto-suggestions

Installation

  1. Clone the repository:

    git clone https://github.com/clusterfudge/heare-developer.git
    cd heare-developer
    
  2. Install the required dependencies:

    pip install -r requirements.txt
    
  3. Set up your Anthropic API key:

    export ANTHROPIC_API_KEY=your_api_key_here
    

    Or create a .env file containing:

    ANTHROPIC_API_KEY=your_api_key_here
    
  4. (Optional) Set up your Plane.so API key for task management:

    export PLANE_API_KEY=your_plane_api_key_here
    

    Or create a ~/.plane-secret file containing just your API key.

Usage

Basic usage:

python -m heare.developer.cli [sandbox_path]

Command Line Options

  • sandbox_path: Path to initialize the sandbox (default: current directory)
  • --model: Choose the Claude AI model (default: sonnet-3.5)
    • Available options: opus, sonnet, sonnet-3.5, haiku
  • --summary-cache: Specify path for summary cache (default: ~/.cache/heare.summary_cache)
  • --sandbox-mode: Set sandbox mode for file operations
    • Options: REMEMBER_PER_RESOURCE, FORGET_IMMEDIATELY, REMEMBER_FOREVER
  • --prompt: Provide initial prompt (prefix with @ to read from file)

Interactive Features

  1. File References: Use @ syntax to reference files in your messages:

    > Can you explain the code in @src/main.py?
    
  2. Multi-line Input:

    > {
    Here's my multi-line
    input that can include
    code or text
    }
    
  3. Command Auto-completion:

    • Press Tab to auto-complete commands and file paths
    • @ followed by partial path triggers file path completion
  4. Available Commands:

    • /quit or /exit: Exit the CLI
    • /restart: Clear chat history and start over
    • Various tool-specific commands (shown on startup)
  5. Plane.so Integration:

    • Manage tasks, issues, and projects directly through the CLI
    • List workspaces, projects, and issues
    • Create, update, and link issues
    • Add comments and create subtasks
    • See docs/plane_tools_examples.md for detailed usage examples

Sandbox Modes

  • REMEMBER_PER_RESOURCE: Remember permissions per resource (default)
  • FORGET_IMMEDIATELY: Ask for permission each time
  • REMEMBER_FOREVER: Remember all permissions

Development

The project follows a modular architecture:

  • heare/developer/: Core CLI and developer tools
  • heare/pm/: Project management functionality (WIP)
  • tests/: Test suite

To contribute:

  1. Fork the repository
  2. Create a feature branch
  3. Add tests for new functionality
  4. Submit a pull request

License

[Insert your chosen license here]

Acknowledgements

This project uses:

  • Anthropic's Claude AI models
  • Rich for terminal UI
  • Prompt Toolkit for command line interface
  • Various other open source packages (see requirements.txt)
  1. Available Commands:

    • /quit or /exit: Exit the CLI
    • /restart: Clear chat history and start over
    • Various tool-specific commands (shown on startup)
  2. Plane.so Integration:

    • Manage tasks, issues, and projects directly through the CLI
    • List workspaces, projects, and issues
    • Create, update, and link issues
    • Add comments and create subtasks
    • See docs/plane_tools_examples.md for detailed usage examples

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

heare_developer-0.7.1.tar.gz (196.5 kB view details)

Uploaded Source

Built Distribution

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

heare_developer-0.7.1-py3-none-any.whl (100.2 kB view details)

Uploaded Python 3

File details

Details for the file heare_developer-0.7.1.tar.gz.

File metadata

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

File hashes

Hashes for heare_developer-0.7.1.tar.gz
Algorithm Hash digest
SHA256 f924a3a7bad462e433b0f95ac025fc8ad096d81f292d75c9057a02ac05320a40
MD5 77ca4893bb422b4deb0b119e4cda15dc
BLAKE2b-256 9eab2473316d8d3785f6c90db4d86944de75d7409e88f1e07fee292f0934500c

See more details on using hashes here.

Provenance

The following attestation bundles were made for heare_developer-0.7.1.tar.gz:

Publisher: publish-to-pypi.yml on clusterfudge/heare-developer

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

File details

Details for the file heare_developer-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: heare_developer-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 100.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for heare_developer-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 75530df92676b26bc3e4457a4f5dd02ab8d7e81ae80512f4cfad2ddf2f5d60a6
MD5 e30354d8c43ea56729026c5696ae8676
BLAKE2b-256 c741931d487260b190dcce58e2a5f42fd335c979efd62cb0f7cdc9433af81b3c

See more details on using hashes here.

Provenance

The following attestation bundles were made for heare_developer-0.7.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on clusterfudge/heare-developer

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