| Name | ra-aid JSON |
| Version |
0.14.5
JSON |
| download |
| home_page | None |
| Summary | RA.Aid - ReAct Aid |
| upload_time | 2025-02-25 00:58:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [2024] [AI Christianson]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. |
| keywords |
agent
ai
development
langchain
tools
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<img src="assets/RA-black-bg.png" alt="RA.Aid - Develop software autonomously." style="margin-bottom: 20px;">
[](https://www.python.org)
[](LICENSE)
[]()
**Develop software autonomously.**
RA.Aid (pronounced "raid") helps you develop software autonomously. It was made by putting `aider` (https://aider.chat/) in a LangChain ReAct agent loop. This unique combination allows developers to leverage `aider`'s code editing capabilities while benefiting from LangChain's agent-based task execution framework. The tool provides an intelligent assistant that can help with research, planning, and implementation of multi-step development tasks.
The result is **near-fully-autonomous software development**.
**Enjoying RA.Aid?** Show your support by giving us a star ⭐ on [GitHub](https://github.com/ai-christianson/RA.Aid)!
Here's a demo of RA.Aid adding a feature to itself:
<img src="assets/demo-ra-aid-task-1.gif" alt="RA.Aid Demo" autoplay loop style="width: 100%; max-width: 800px;">
## Documentation
Complete documentation is available at https://docs.ra-aid.ai
Key sections:
- [Installation Guide](https://docs.ra-aid.ai/quickstart/installation)
- [Recommended Configuration](https://docs.ra-aid.ai/quickstart/recommended)
- [Open Models Setup](https://docs.ra-aid.ai/quickstart/open-models)
- [Usage Examples](https://docs.ra-aid.ai/category/usage)
- [Contributing Guide](https://docs.ra-aid.ai/contributing)
- [Getting Help](https://docs.ra-aid.ai/getting-help)
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Architecture](#architecture)
- [Dependencies](#dependencies)
- [Development Setup](#development-setup)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
> 👋 **Pull requests are very welcome!** Have ideas for how to impove RA.Aid? Don't be shy - your help makes a real difference!
>
> 💬 **Join our Discord community:** [Click here to join](https://discord.gg/f6wYbzHYxV)
⚠️ **IMPORTANT: USE AT YOUR OWN RISK** ⚠️
- This tool **can and will** automatically execute shell commands and make code changes
- The --cowboy-mode flag can be enabled to skip shell command approval prompts
- No warranty is provided, either express or implied
- Always use in version-controlled repositories
- Review proposed changes in your git diff before committing
## Key Features
- **Multi-Step Task Planning**: The agent breaks down complex tasks into discrete, manageable steps and executes them sequentially. This systematic approach ensures thorough implementation and reduces errors.
- **Automated Command Execution**: The agent can run shell commands automatically to accomplish tasks. While this makes it powerful, it also means you should carefully review its actions.
- **Ability to Leverage Expert Reasoning Models**: The agent can use advanced reasoning models such as OpenAI's o1 *just when needed*, e.g. to solve complex debugging problems or in planning for complex feature implementation.
- **Web Research Capabilities**: Leverages Tavily API for intelligent web searches to enhance research and gather real-world context for development tasks
- **Three-Stage Architecture**:
1. **Research**: Analyzes codebases and gathers context
2. **Planning**: Breaks down tasks into specific, actionable steps
3. **Implementation**: Executes each planned step sequentially
What sets RA.Aid apart is its ability to handle complex programming tasks that extend beyond single-shot code edits. By combining research, strategic planning, and implementation into a cohesive workflow, RA.Aid can:
- Break down and execute multi-step programming tasks
- Research and analyze complex codebases to answer architectural questions
- Plan and implement significant code changes across multiple files
- Provide detailed explanations of existing code structure and functionality
- Execute sophisticated refactoring operations with proper planning
## Features
- **Three-Stage Architecture**: The workflow consists of three powerful stages:
1. **Research** 🔍 - Gather and analyze information
2. **Planning** 📋 - Develop execution strategy
3. **Implementation** ⚡ - Execute the plan with AI assistance
Each stage is powered by dedicated AI agents and specialized toolsets.
- **Advanced AI Integration**: Built on LangChain and leverages the latest LLMs for natural language understanding and generation.
- **Human-in-the-Loop Interaction**: Optional mode that enables the agent to ask you questions during task execution, ensuring higher accuracy and better handling of complex tasks that may require your input or clarification
- **Comprehensive Toolset**:
- Shell command execution
- Expert querying system
- File operations and management
- Memory management
- Research and planning tools
- Code analysis capabilities
- **Interactive CLI Interface**: Simple yet powerful command-line interface for seamless interaction
- **Modular Design**: Structured as a Python package with specialized modules for console output, processing, text utilities, and tools
- **Git Integration**: Built-in support for Git operations and repository management
## Installation
RA.Aid can be installed directly using pip:
```bash
pip install ra-aid
```
### Prerequisites
Before using RA.Aid, you'll need API keys for the required AI services:
```bash
# Set up API keys based on your preferred provider:
# For Anthropic Claude models (recommended)
export ANTHROPIC_API_KEY=your_api_key_here
# For OpenAI models (optional)
export OPENAI_API_KEY=your_api_key_here
# For OpenRouter provider (optional)
export OPENROUTER_API_KEY=your_api_key_here
# For OpenAI-compatible providers (optional)
export OPENAI_API_BASE=your_api_base_url
# For Gemini provider (optional)
export GEMINI_API_KEY=your_api_key_here
# For web research capabilities
export TAVILY_API_KEY=your_api_key_here
```
Note: The programmer tool (aider) will automatically select its model based on your available API keys:
- If ANTHROPIC_API_KEY is set, it will use Claude models
- If only OPENAI_API_KEY is set, it will use OpenAI models
- You can set multiple API keys to enable different features
You can get your API keys from:
- Anthropic API key: https://console.anthropic.com/
- OpenAI API key: https://platform.openai.com/api-keys
- OpenRouter API key: https://openrouter.ai/keys
- Gemini API key: https://aistudio.google.com/app/apikey
Complete installation documentation is available in our [Installation Guide](https://docs.ra-aid.ai/quickstart/installation).
## Usage
RA.Aid is designed to be simple yet powerful. Here's how to use it:
```bash
# Basic usage
ra-aid -m "Your task or query here"
# Research-only mode (no implementation)
ra-aid -m "Explain the authentication flow" --research-only
# Enable verbose logging for detailed execution information
ra-aid -m "Add new feature" --verbose
```
More information is available in our [Usage Examples](https://docs.ra-aid.ai/category/usage).
### Command Line Options
- `-m, --message`: The task or query to be executed (required except in chat mode)
- `--research-only`: Only perform research without implementation
- `--provider`: The LLM provider to use (choices: anthropic, openai, openrouter, openai-compatible, gemini)
- `--model`: The model name to use (required for non-Anthropic providers)
- `--research-provider`: Provider to use specifically for research tasks (falls back to --provider if not specified)
- `--research-model`: Model to use specifically for research tasks (falls back to --model if not specified)
- `--planner-provider`: Provider to use specifically for planning tasks (falls back to --provider if not specified)
- `--planner-model`: Model to use specifically for planning tasks (falls back to --model if not specified)
- `--cowboy-mode`: Skip interactive approval for shell commands
- `--expert-provider`: The LLM provider to use for expert knowledge queries (choices: anthropic, openai, openrouter, openai-compatible, gemini)
- `--expert-model`: The model name to use for expert knowledge queries (required for non-OpenAI providers)
- `--hil, -H`: Enable human-in-the-loop mode for interactive assistance during task execution
- `--chat`: Enable chat mode with direct human interaction (implies --hil)
- `--verbose`: Enable verbose logging output
- `--experimental-fallback-handler`: Enable experimental fallback handler to attempt to fix too calls when the same tool fails 3 times consecutively. (OPENAI_API_KEY recommended as openai has the top 5 tool calling models.) See `ra_aid/tool_leaderboard.py` for more info.
- `--pretty-logger`: Enables panel markdown formatted logger messages for debugging purposes.
- `--temperature`: LLM temperature (0.0-2.0) to control randomness in responses
- `--disable-limit-tokens`: Disable token limiting for Anthropic Claude react agents
- `--recursion-limit`: Maximum recursion depth for agent operations (default: 100)
- `--test-cmd`: Custom command to run tests. If set user will be asked if they want to run the test command
- `--auto-test`: Automatically run tests after each code change
- `--max-test-cmd-retries`: Maximum number of test command retry attempts (default: 3)
- `--test-cmd-timeout`: Timeout in seconds for test command execution (default: 300)
- `--version`: Show program version number and exit
- `--webui`: Launch the web interface (alpha feature)
- `--webui-host`: Host to listen on for web interface (default: 0.0.0.0) (alpha feature)
- `--webui-port`: Port to listen on for web interface (default: 8080) (alpha feature)
### Example Tasks
1. Code Analysis:
```bash
ra-aid -m "Explain how the authentication middleware works" --research-only
```
2. Complex Changes:
```bash
ra-aid -m "Refactor the database connection code to use connection pooling" --cowboy-mode
```
3. Automated Updates:
```bash
ra-aid -m "Update deprecated API calls across the entire codebase" --cowboy-mode
```
4. Code Research:
```bash
ra-aid -m "Analyze the current error handling patterns" --research-only
```
2. Code Research:
```bash
ra-aid -m "Explain how the authentication middleware works" --research-only
```
3. Refactoring:
```bash
ra-aid -m "Refactor the database connection code to use connection pooling" --cowboy-mode
```
### Human-in-the-Loop Mode
Enable interactive mode to allow the agent to ask you questions during task execution:
```bash
ra-aid -m "Implement a new feature" --hil
# or
ra-aid -m "Implement a new feature" -H
```
This mode is particularly useful for:
- Complex tasks requiring human judgment
- Clarifying ambiguous requirements
- Making architectural decisions
- Validating critical changes
- Providing domain-specific knowledge
### Web Research
<img src="assets/demo-web-research-1.gif" alt="RA.Aid Demo" autoplay loop style="width: 100%; max-width: 800px;">
The agent features autonomous web research capabilities powered by the [Tavily](https://tavily.com/) API, seamlessly integrating real-world information into its problem-solving workflow. Web research is conducted automatically when the agent determines additional context would be valuable - no explicit configuration required.
For example, when researching modern authentication practices or investigating new API requirements, the agent will autonomously:
- Search for current best practices and security recommendations
- Find relevant documentation and technical specifications
- Gather real-world implementation examples
- Stay updated on latest industry standards
While web research happens automatically as needed, you can also explicitly request research-focused tasks:
```bash
# Focused research task with web search capabilities
ra-aid -m "Research current best practices for API rate limiting" --research-only
```
Make sure to set your TAVILY_API_KEY environment variable to enable this feature.
### Chat Mode
<img src="assets/demo-chat-mode-1.gif" alt="Chat Mode Demo" autoplay loop style="display: block; margin: 0 auto; width: 100%; max-width: 800px;">
Enable with `--chat` to transform ra-aid into an interactive assistant that guides you through research and implementation tasks. Have a natural conversation about what you want to build, explore options together, and dispatch work - all while maintaining context of your discussion. Perfect for when you want to think through problems collaboratively rather than just executing commands.
### Web Interface
RA.Aid includes a modern web interface that provides:
- Beautiful dark-themed chat interface
- Real-time streaming of command output
- Request history with quick resubmission
- Responsive design that works on all devices
To launch the web interface:
```bash
# Start with default settings (0.0.0.0:8080)
ra-aid --webui
# Specify custom host and port
ra-aid --webui --webui-host 127.0.0.1 --webui-port 3000
```
Command line options for web interface:
- `--webui`: Launch the web interface
- `--webui-host`: Host to listen on (default: 0.0.0.0)
- `--webui-port`: Port to listen on (default: 8080)
After starting the server, open your web browser to the displayed URL (e.g., http://localhost:8080). The interface provides:
- Left sidebar showing request history
- Main chat area with real-time output
- Input box for typing requests
- Automatic reconnection handling
- Error reporting and status messages
All ra-aid commands sent through the web interface automatically use cowboy mode for seamless execution.
### Command Interruption and Feedback
<img src="assets/demo-chat-mode-interrupted-1.gif" alt="Command Interrupt Demo" autoplay loop style="display: block; margin: 0 auto; width: 100%; max-width: 800px;">
You can interrupt the agent at any time by pressing `Ctrl-C`. This pauses the agent, allowing you to provide feedback, adjust your instructions, or steer the execution in a new direction. Press `Ctrl-C` again if you want to completely exit the program.
### Shell Command Automation with Cowboy Mode 🏇
The `--cowboy-mode` flag enables automated shell command execution without confirmation prompts. This is useful for:
- CI/CD pipelines
- Automated testing environments
- Batch processing operations
- Scripted workflows
```bash
ra-aid -m "Update all deprecated API calls" --cowboy-mode
```
**⚠️ Important Safety Notes:**
- Cowboy mode skips confirmation prompts for shell commands
- Always use in version-controlled repositories
- Ensure you have a clean working tree before running
- Review changes in git diff before committing
### Model Configuration
RA.Aid supports multiple AI providers and models. The default model is Anthropic's Claude 3 Sonnet (`claude-3-7-sonnet-20250219`).
The programmer tool (aider) automatically selects its model based on your available API keys. It will use Claude models if ANTHROPIC_API_KEY is set, or fall back to OpenAI models if only OPENAI_API_KEY is available.
Note: The expert tool can be configured to use different providers (OpenAI, Anthropic, OpenRouter, Gemini) using the --expert-provider flag along with the corresponding EXPERT_*API_KEY environment variables. Each provider requires its own API key set through the appropriate environment variable.
#### Environment Variables
RA.Aid supports multiple providers through environment variables:
- `ANTHROPIC_API_KEY`: Required for the default Anthropic provider
- `OPENAI_API_KEY`: Required for OpenAI provider
- `OPENROUTER_API_KEY`: Required for OpenRouter provider
- `DEEPSEEK_API_KEY`: Required for DeepSeek provider
- `OPENAI_API_BASE`: Required for OpenAI-compatible providers along with `OPENAI_API_KEY`
- `GEMINI_API_KEY`: Required for Gemini provider
Expert Tool Environment Variables:
- `EXPERT_OPENAI_API_KEY`: API key for expert tool using OpenAI provider
- `EXPERT_ANTHROPIC_API_KEY`: API key for expert tool using Anthropic provider
- `EXPERT_OPENROUTER_API_KEY`: API key for expert tool using OpenRouter provider
- `EXPERT_OPENAI_API_BASE`: Base URL for expert tool using OpenAI-compatible provider
- `EXPERT_GEMINI_API_KEY`: API key for expert tool using Gemini provider
- `EXPERT_DEEPSEEK_API_KEY`: API key for expert tool using DeepSeek provider
You can set these permanently in your shell's configuration file (e.g., `~/.bashrc` or `~/.zshrc`):
```bash
# Default provider (Anthropic)
export ANTHROPIC_API_KEY=your_api_key_here
# For OpenAI features and expert tool
export OPENAI_API_KEY=your_api_key_here
# For OpenRouter provider
export OPENROUTER_API_KEY=your_api_key_here
# For OpenAI-compatible providers
export OPENAI_API_BASE=your_api_base_url
# For Gemini provider
export GEMINI_API_KEY=your_api_key_here
```
### Custom Model Examples
1. **Using Anthropic (Default)**
```bash
# Uses default model (claude-3-7-sonnet-20250219)
ra-aid -m "Your task"
# Or explicitly specify:
ra-aid -m "Your task" --provider anthropic --model claude-3-5-sonnet-20241022
```
2. **Using OpenAI**
```bash
ra-aid -m "Your task" --provider openai --model gpt-4o
```
3. **Using OpenRouter**
```bash
ra-aid -m "Your task" --provider openrouter --model mistralai/mistral-large-2411
```
4. **Using DeepSeek**
```bash
# Direct DeepSeek provider (requires DEEPSEEK_API_KEY)
ra-aid -m "Your task" --provider deepseek --model deepseek-reasoner
# DeepSeek via OpenRouter
ra-aid -m "Your task" --provider openrouter --model deepseek/deepseek-r1
```
4. **Configuring Expert Provider**
The expert tool is used by the agent for complex logic and debugging tasks. It can be configured to use different providers (OpenAI, Anthropic, OpenRouter, Gemini, openai-compatible) using the --expert-provider flag along with the corresponding EXPERT_*API_KEY environment variables.
```bash
# Use Anthropic for expert tool
export EXPERT_ANTHROPIC_API_KEY=your_anthropic_api_key
ra-aid -m "Your task" --expert-provider anthropic --expert-model claude-3-5-sonnet-20241022
# Use OpenRouter for expert tool
export OPENROUTER_API_KEY=your_openrouter_api_key
ra-aid -m "Your task" --expert-provider openrouter --expert-model mistralai/mistral-large-2411
# Use DeepSeek for expert tool
export DEEPSEEK_API_KEY=your_deepseek_api_key
ra-aid -m "Your task" --expert-provider deepseek --expert-model deepseek-reasoner
# Use default OpenAI for expert tool
export EXPERT_OPENAI_API_KEY=your_openai_api_key
ra-aid -m "Your task" --expert-provider openai --expert-model o1
# Use Gemini for expert tool
export EXPERT_GEMINI_API_KEY=your_gemini_api_key
ra-aid -m "Your task" --expert-provider gemini --expert-model gemini-2.0-flash-thinking-exp-1219
```
Aider specific Environment Variables you can add:
- `AIDER_FLAGS`: Optional comma-separated list of flags to pass to the underlying aider tool (e.g., "yes-always,dark-mode")
```bash
# Optional: Configure aider behavior
export AIDER_FLAGS="yes-always,dark-mode,no-auto-commits"
```
Note: For `AIDER_FLAGS`, you can specify flags with or without the leading `--`. Multiple flags should be comma-separated, and spaces around flags are automatically handled. For example, both `"yes-always,dark-mode"` and `"--yes-always, --dark-mode"` are valid.
**Important Notes:**
- Performance varies between models. The default Claude 3 Sonnet model currently provides the best and most reliable results.
- Model configuration is done via command line arguments: `--provider` and `--model`
- The `--model` argument is required for all providers except Anthropic (which defaults to `claude-3-7-sonnet-20250219`)
More information is available in our [Open Models Setup](https://docs.ra-aid.ai/quickstart/open-models) guide.
## Architecture
RA.Aid implements a three-stage architecture for handling development and research tasks:
1. **Research Stage**:
- Gathers information and context
- Analyzes requirements
- Identifies key components and dependencies
2. **Planning Stage**:
- Develops detailed implementation plans
- Breaks down tasks into manageable steps
- Identifies potential challenges and solutions
3. **Implementation Stage**:
- Executes planned tasks
- Generates code or documentation
- Performs necessary system operations
### Core Components
- **Console Module** (`console/`): Handles console output formatting and user interaction
- **Processing Module** (`proc/`): Manages interactive processing and workflow control
- **Text Module** (`text/`): Provides text processing and manipulation utilities
- **Tools Module** (`tools/`): Contains various utility tools for file operations, search, and more
## Dependencies
### Core Dependencies
- `langchain-anthropic`: LangChain integration with Anthropic's Claude
- `tavily-python`: Tavily API client for web research
- `langgraph`: Graph-based workflow management
- `rich>=13.0.0`: Terminal formatting and output
- `GitPython==3.1.41`: Git repository management
- `fuzzywuzzy==0.18.0`: Fuzzy string matching
- `python-Levenshtein==0.23.0`: Fast string matching
- `pathspec>=0.11.0`: Path specification utilities
### Development Dependencies
- `pytest>=7.0.0`: Testing framework
- `pytest-timeout>=2.2.0`: Test timeout management
## Development Setup
1. Clone the repository:
```bash
git clone https://github.com/ai-christianson/RA.Aid.git
cd RA.Aid
```
2. Create and activate a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
3. Install development dependencies:
```bash
pip install -r requirements-dev.txt
```
4. Run tests:
```bash
python -m pytest
```
## Contributing
Contributions are welcome! Please follow these steps:
1. Fork the repository
2. Create a feature branch:
```bash
git checkout -b feature/your-feature-name
```
3. Make your changes and commit:
```bash
git commit -m 'Add some feature'
```
4. Push to your fork:
```bash
git push origin feature/your-feature-name
```
5. Open a Pull Request
### Guidelines
- Follow PEP 8 style guidelines
- Add tests for new features
- Update documentation as needed
- Keep commits focused and message clear
- Ensure all tests pass before submitting PR
More information is available in our [Contributing Guide](https://docs.ra-aid.ai/contributing).
## License
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
Copyright (c) 2024 AI Christianson
## Contact
- **Issues**: Please report bugs and feature requests on our [Issue Tracker](https://github.com/ai-christianson/RA.Aid/issues)
- **Repository**: [https://github.com/ai-christianson/RA.Aid](https://github.com/ai-christianson/RA.Aid)
- **Documentation**: [https://github.com/ai-christianson/RA.Aid#readme](https://github.com/ai-christianson/RA.Aid#readme)
Raw data
{
"_id": null,
"home_page": null,
"name": "ra-aid",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "agent, ai, development, langchain, tools",
"author": null,
"author_email": "AI Christianson <ai.christianson@christianson.ai>",
"download_url": "https://files.pythonhosted.org/packages/4d/9e/b4e30cb36fd96698520bc21aa57e528618511049d6e2104a724b6e0532a2/ra_aid-0.14.5.tar.gz",
"platform": null,
"description": "<img src=\"assets/RA-black-bg.png\" alt=\"RA.Aid - Develop software autonomously.\" style=\"margin-bottom: 20px;\">\n\n[](https://www.python.org)\n[](LICENSE)\n[]()\n\n**Develop software autonomously.**\n\nRA.Aid (pronounced \"raid\") helps you develop software autonomously. It was made by putting `aider` (https://aider.chat/) in a LangChain ReAct agent loop. This unique combination allows developers to leverage `aider`'s code editing capabilities while benefiting from LangChain's agent-based task execution framework. The tool provides an intelligent assistant that can help with research, planning, and implementation of multi-step development tasks.\n\nThe result is **near-fully-autonomous software development**.\n\n**Enjoying RA.Aid?** Show your support by giving us a star \u2b50 on [GitHub](https://github.com/ai-christianson/RA.Aid)!\n\nHere's a demo of RA.Aid adding a feature to itself:\n\n<img src=\"assets/demo-ra-aid-task-1.gif\" alt=\"RA.Aid Demo\" autoplay loop style=\"width: 100%; max-width: 800px;\">\n\n## Documentation\n\nComplete documentation is available at https://docs.ra-aid.ai\n\nKey sections:\n- [Installation Guide](https://docs.ra-aid.ai/quickstart/installation)\n- [Recommended Configuration](https://docs.ra-aid.ai/quickstart/recommended)\n- [Open Models Setup](https://docs.ra-aid.ai/quickstart/open-models)\n- [Usage Examples](https://docs.ra-aid.ai/category/usage)\n- [Contributing Guide](https://docs.ra-aid.ai/contributing)\n- [Getting Help](https://docs.ra-aid.ai/getting-help)\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Architecture](#architecture)\n- [Dependencies](#dependencies)\n- [Development Setup](#development-setup)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n\n> \ud83d\udc4b **Pull requests are very welcome!** Have ideas for how to impove RA.Aid? Don't be shy - your help makes a real difference!\n>\n> \ud83d\udcac **Join our Discord community:** [Click here to join](https://discord.gg/f6wYbzHYxV)\n\n\u26a0\ufe0f **IMPORTANT: USE AT YOUR OWN RISK** \u26a0\ufe0f\n- This tool **can and will** automatically execute shell commands and make code changes\n- The --cowboy-mode flag can be enabled to skip shell command approval prompts\n- No warranty is provided, either express or implied\n- Always use in version-controlled repositories\n- Review proposed changes in your git diff before committing\n\n## Key Features\n\n- **Multi-Step Task Planning**: The agent breaks down complex tasks into discrete, manageable steps and executes them sequentially. This systematic approach ensures thorough implementation and reduces errors.\n\n- **Automated Command Execution**: The agent can run shell commands automatically to accomplish tasks. While this makes it powerful, it also means you should carefully review its actions.\n\n- **Ability to Leverage Expert Reasoning Models**: The agent can use advanced reasoning models such as OpenAI's o1 *just when needed*, e.g. to solve complex debugging problems or in planning for complex feature implementation.\n\n- **Web Research Capabilities**: Leverages Tavily API for intelligent web searches to enhance research and gather real-world context for development tasks\n\n- **Three-Stage Architecture**:\n 1. **Research**: Analyzes codebases and gathers context\n 2. **Planning**: Breaks down tasks into specific, actionable steps\n 3. **Implementation**: Executes each planned step sequentially\n\nWhat sets RA.Aid apart is its ability to handle complex programming tasks that extend beyond single-shot code edits. By combining research, strategic planning, and implementation into a cohesive workflow, RA.Aid can:\n\n- Break down and execute multi-step programming tasks\n- Research and analyze complex codebases to answer architectural questions\n- Plan and implement significant code changes across multiple files\n- Provide detailed explanations of existing code structure and functionality\n- Execute sophisticated refactoring operations with proper planning\n\n## Features\n\n- **Three-Stage Architecture**: The workflow consists of three powerful stages:\n 1. **Research** \ud83d\udd0d - Gather and analyze information\n 2. **Planning** \ud83d\udccb - Develop execution strategy\n 3. **Implementation** \u26a1 - Execute the plan with AI assistance\n\n Each stage is powered by dedicated AI agents and specialized toolsets.\n- **Advanced AI Integration**: Built on LangChain and leverages the latest LLMs for natural language understanding and generation.\n- **Human-in-the-Loop Interaction**: Optional mode that enables the agent to ask you questions during task execution, ensuring higher accuracy and better handling of complex tasks that may require your input or clarification\n- **Comprehensive Toolset**:\n - Shell command execution\n - Expert querying system\n - File operations and management\n - Memory management\n - Research and planning tools\n - Code analysis capabilities\n- **Interactive CLI Interface**: Simple yet powerful command-line interface for seamless interaction\n- **Modular Design**: Structured as a Python package with specialized modules for console output, processing, text utilities, and tools\n- **Git Integration**: Built-in support for Git operations and repository management\n\n## Installation\n\nRA.Aid can be installed directly using pip:\n\n```bash\npip install ra-aid\n```\n\n### Prerequisites\n\nBefore using RA.Aid, you'll need API keys for the required AI services:\n\n```bash\n# Set up API keys based on your preferred provider:\n\n# For Anthropic Claude models (recommended)\nexport ANTHROPIC_API_KEY=your_api_key_here\n\n# For OpenAI models (optional)\nexport OPENAI_API_KEY=your_api_key_here\n\n# For OpenRouter provider (optional)\nexport OPENROUTER_API_KEY=your_api_key_here\n\n# For OpenAI-compatible providers (optional)\nexport OPENAI_API_BASE=your_api_base_url\n\n# For Gemini provider (optional)\nexport GEMINI_API_KEY=your_api_key_here\n\n# For web research capabilities\nexport TAVILY_API_KEY=your_api_key_here\n```\n\nNote: The programmer tool (aider) will automatically select its model based on your available API keys:\n- If ANTHROPIC_API_KEY is set, it will use Claude models\n- If only OPENAI_API_KEY is set, it will use OpenAI models\n- You can set multiple API keys to enable different features\n\nYou can get your API keys from:\n- Anthropic API key: https://console.anthropic.com/\n- OpenAI API key: https://platform.openai.com/api-keys\n- OpenRouter API key: https://openrouter.ai/keys\n- Gemini API key: https://aistudio.google.com/app/apikey\n\nComplete installation documentation is available in our [Installation Guide](https://docs.ra-aid.ai/quickstart/installation).\n\n## Usage\n\nRA.Aid is designed to be simple yet powerful. Here's how to use it:\n\n```bash\n# Basic usage\nra-aid -m \"Your task or query here\"\n\n# Research-only mode (no implementation)\nra-aid -m \"Explain the authentication flow\" --research-only\n\n# Enable verbose logging for detailed execution information\nra-aid -m \"Add new feature\" --verbose\n```\n\nMore information is available in our [Usage Examples](https://docs.ra-aid.ai/category/usage).\n\n### Command Line Options\n\n- `-m, --message`: The task or query to be executed (required except in chat mode)\n- `--research-only`: Only perform research without implementation\n- `--provider`: The LLM provider to use (choices: anthropic, openai, openrouter, openai-compatible, gemini)\n- `--model`: The model name to use (required for non-Anthropic providers)\n- `--research-provider`: Provider to use specifically for research tasks (falls back to --provider if not specified)\n- `--research-model`: Model to use specifically for research tasks (falls back to --model if not specified)\n- `--planner-provider`: Provider to use specifically for planning tasks (falls back to --provider if not specified)\n- `--planner-model`: Model to use specifically for planning tasks (falls back to --model if not specified)\n- `--cowboy-mode`: Skip interactive approval for shell commands\n- `--expert-provider`: The LLM provider to use for expert knowledge queries (choices: anthropic, openai, openrouter, openai-compatible, gemini)\n- `--expert-model`: The model name to use for expert knowledge queries (required for non-OpenAI providers)\n- `--hil, -H`: Enable human-in-the-loop mode for interactive assistance during task execution\n- `--chat`: Enable chat mode with direct human interaction (implies --hil)\n- `--verbose`: Enable verbose logging output\n- `--experimental-fallback-handler`: Enable experimental fallback handler to attempt to fix too calls when the same tool fails 3 times consecutively. (OPENAI_API_KEY recommended as openai has the top 5 tool calling models.) See `ra_aid/tool_leaderboard.py` for more info.\n- `--pretty-logger`: Enables panel markdown formatted logger messages for debugging purposes.\n- `--temperature`: LLM temperature (0.0-2.0) to control randomness in responses\n- `--disable-limit-tokens`: Disable token limiting for Anthropic Claude react agents\n- `--recursion-limit`: Maximum recursion depth for agent operations (default: 100)\n- `--test-cmd`: Custom command to run tests. If set user will be asked if they want to run the test command\n- `--auto-test`: Automatically run tests after each code change\n- `--max-test-cmd-retries`: Maximum number of test command retry attempts (default: 3)\n- `--test-cmd-timeout`: Timeout in seconds for test command execution (default: 300)\n- `--version`: Show program version number and exit\n- `--webui`: Launch the web interface (alpha feature)\n- `--webui-host`: Host to listen on for web interface (default: 0.0.0.0) (alpha feature)\n- `--webui-port`: Port to listen on for web interface (default: 8080) (alpha feature)\n\n### Example Tasks\n\n1. Code Analysis:\n ```bash\n ra-aid -m \"Explain how the authentication middleware works\" --research-only\n ```\n\n2. Complex Changes:\n ```bash\n ra-aid -m \"Refactor the database connection code to use connection pooling\" --cowboy-mode\n ```\n\n3. Automated Updates:\n ```bash\n ra-aid -m \"Update deprecated API calls across the entire codebase\" --cowboy-mode\n ```\n\n4. Code Research:\n ```bash\n ra-aid -m \"Analyze the current error handling patterns\" --research-only\n ```\n\n2. Code Research:\n ```bash\n ra-aid -m \"Explain how the authentication middleware works\" --research-only\n ```\n\n3. Refactoring:\n ```bash\n ra-aid -m \"Refactor the database connection code to use connection pooling\" --cowboy-mode\n ```\n\n### Human-in-the-Loop Mode\n\nEnable interactive mode to allow the agent to ask you questions during task execution:\n\n```bash\nra-aid -m \"Implement a new feature\" --hil\n# or\nra-aid -m \"Implement a new feature\" -H\n```\n\nThis mode is particularly useful for:\n- Complex tasks requiring human judgment\n- Clarifying ambiguous requirements\n- Making architectural decisions\n- Validating critical changes\n- Providing domain-specific knowledge\n\n### Web Research\n\n<img src=\"assets/demo-web-research-1.gif\" alt=\"RA.Aid Demo\" autoplay loop style=\"width: 100%; max-width: 800px;\">\n\nThe agent features autonomous web research capabilities powered by the [Tavily](https://tavily.com/) API, seamlessly integrating real-world information into its problem-solving workflow. Web research is conducted automatically when the agent determines additional context would be valuable - no explicit configuration required.\n\nFor example, when researching modern authentication practices or investigating new API requirements, the agent will autonomously:\n- Search for current best practices and security recommendations\n- Find relevant documentation and technical specifications\n- Gather real-world implementation examples\n- Stay updated on latest industry standards\n\nWhile web research happens automatically as needed, you can also explicitly request research-focused tasks:\n\n```bash\n# Focused research task with web search capabilities\nra-aid -m \"Research current best practices for API rate limiting\" --research-only\n```\n\nMake sure to set your TAVILY_API_KEY environment variable to enable this feature.\n\n### Chat Mode\n<img src=\"assets/demo-chat-mode-1.gif\" alt=\"Chat Mode Demo\" autoplay loop style=\"display: block; margin: 0 auto; width: 100%; max-width: 800px;\">\n\nEnable with `--chat` to transform ra-aid into an interactive assistant that guides you through research and implementation tasks. Have a natural conversation about what you want to build, explore options together, and dispatch work - all while maintaining context of your discussion. Perfect for when you want to think through problems collaboratively rather than just executing commands.\n\n### Web Interface\n\nRA.Aid includes a modern web interface that provides:\n- Beautiful dark-themed chat interface\n- Real-time streaming of command output\n- Request history with quick resubmission\n- Responsive design that works on all devices\n\nTo launch the web interface:\n\n```bash\n# Start with default settings (0.0.0.0:8080)\nra-aid --webui\n\n# Specify custom host and port\nra-aid --webui --webui-host 127.0.0.1 --webui-port 3000\n```\n\nCommand line options for web interface:\n- `--webui`: Launch the web interface\n- `--webui-host`: Host to listen on (default: 0.0.0.0)\n- `--webui-port`: Port to listen on (default: 8080)\n\nAfter starting the server, open your web browser to the displayed URL (e.g., http://localhost:8080). The interface provides:\n- Left sidebar showing request history\n- Main chat area with real-time output\n- Input box for typing requests\n- Automatic reconnection handling\n- Error reporting and status messages\n\nAll ra-aid commands sent through the web interface automatically use cowboy mode for seamless execution.\n\n### Command Interruption and Feedback\n\n<img src=\"assets/demo-chat-mode-interrupted-1.gif\" alt=\"Command Interrupt Demo\" autoplay loop style=\"display: block; margin: 0 auto; width: 100%; max-width: 800px;\">\n\nYou can interrupt the agent at any time by pressing `Ctrl-C`. This pauses the agent, allowing you to provide feedback, adjust your instructions, or steer the execution in a new direction. Press `Ctrl-C` again if you want to completely exit the program.\n\n\n### Shell Command Automation with Cowboy Mode \ud83c\udfc7\n\nThe `--cowboy-mode` flag enables automated shell command execution without confirmation prompts. This is useful for:\n\n- CI/CD pipelines\n- Automated testing environments\n- Batch processing operations\n- Scripted workflows\n\n```bash\nra-aid -m \"Update all deprecated API calls\" --cowboy-mode\n```\n\n**\u26a0\ufe0f Important Safety Notes:**\n- Cowboy mode skips confirmation prompts for shell commands\n- Always use in version-controlled repositories\n- Ensure you have a clean working tree before running\n- Review changes in git diff before committing\n\n### Model Configuration\n\nRA.Aid supports multiple AI providers and models. The default model is Anthropic's Claude 3 Sonnet (`claude-3-7-sonnet-20250219`).\n\nThe programmer tool (aider) automatically selects its model based on your available API keys. It will use Claude models if ANTHROPIC_API_KEY is set, or fall back to OpenAI models if only OPENAI_API_KEY is available.\n\nNote: The expert tool can be configured to use different providers (OpenAI, Anthropic, OpenRouter, Gemini) using the --expert-provider flag along with the corresponding EXPERT_*API_KEY environment variables. Each provider requires its own API key set through the appropriate environment variable.\n\n#### Environment Variables\n\nRA.Aid supports multiple providers through environment variables:\n\n- `ANTHROPIC_API_KEY`: Required for the default Anthropic provider\n- `OPENAI_API_KEY`: Required for OpenAI provider\n- `OPENROUTER_API_KEY`: Required for OpenRouter provider\n- `DEEPSEEK_API_KEY`: Required for DeepSeek provider\n- `OPENAI_API_BASE`: Required for OpenAI-compatible providers along with `OPENAI_API_KEY`\n- `GEMINI_API_KEY`: Required for Gemini provider\n\nExpert Tool Environment Variables:\n- `EXPERT_OPENAI_API_KEY`: API key for expert tool using OpenAI provider\n- `EXPERT_ANTHROPIC_API_KEY`: API key for expert tool using Anthropic provider\n- `EXPERT_OPENROUTER_API_KEY`: API key for expert tool using OpenRouter provider\n- `EXPERT_OPENAI_API_BASE`: Base URL for expert tool using OpenAI-compatible provider\n- `EXPERT_GEMINI_API_KEY`: API key for expert tool using Gemini provider\n- `EXPERT_DEEPSEEK_API_KEY`: API key for expert tool using DeepSeek provider\n\nYou can set these permanently in your shell's configuration file (e.g., `~/.bashrc` or `~/.zshrc`):\n\n```bash\n# Default provider (Anthropic)\nexport ANTHROPIC_API_KEY=your_api_key_here\n\n# For OpenAI features and expert tool\nexport OPENAI_API_KEY=your_api_key_here\n\n# For OpenRouter provider\nexport OPENROUTER_API_KEY=your_api_key_here\n\n# For OpenAI-compatible providers\nexport OPENAI_API_BASE=your_api_base_url\n\n# For Gemini provider\nexport GEMINI_API_KEY=your_api_key_here\n```\n\n### Custom Model Examples\n\n1. **Using Anthropic (Default)**\n ```bash\n # Uses default model (claude-3-7-sonnet-20250219)\n ra-aid -m \"Your task\"\n\n # Or explicitly specify:\n ra-aid -m \"Your task\" --provider anthropic --model claude-3-5-sonnet-20241022\n ```\n\n2. **Using OpenAI**\n ```bash\n ra-aid -m \"Your task\" --provider openai --model gpt-4o\n ```\n\n3. **Using OpenRouter**\n ```bash\n ra-aid -m \"Your task\" --provider openrouter --model mistralai/mistral-large-2411\n ```\n\n4. **Using DeepSeek**\n ```bash\n # Direct DeepSeek provider (requires DEEPSEEK_API_KEY)\n ra-aid -m \"Your task\" --provider deepseek --model deepseek-reasoner\n \n # DeepSeek via OpenRouter\n ra-aid -m \"Your task\" --provider openrouter --model deepseek/deepseek-r1\n ```\n\n4. **Configuring Expert Provider**\n\n The expert tool is used by the agent for complex logic and debugging tasks. It can be configured to use different providers (OpenAI, Anthropic, OpenRouter, Gemini, openai-compatible) using the --expert-provider flag along with the corresponding EXPERT_*API_KEY environment variables.\n\n ```bash\n # Use Anthropic for expert tool\n export EXPERT_ANTHROPIC_API_KEY=your_anthropic_api_key\n ra-aid -m \"Your task\" --expert-provider anthropic --expert-model claude-3-5-sonnet-20241022\n\n # Use OpenRouter for expert tool\n export OPENROUTER_API_KEY=your_openrouter_api_key\n ra-aid -m \"Your task\" --expert-provider openrouter --expert-model mistralai/mistral-large-2411\n\n # Use DeepSeek for expert tool\n export DEEPSEEK_API_KEY=your_deepseek_api_key\n ra-aid -m \"Your task\" --expert-provider deepseek --expert-model deepseek-reasoner\n\n # Use default OpenAI for expert tool\n export EXPERT_OPENAI_API_KEY=your_openai_api_key\n ra-aid -m \"Your task\" --expert-provider openai --expert-model o1\n\n # Use Gemini for expert tool\n export EXPERT_GEMINI_API_KEY=your_gemini_api_key\n ra-aid -m \"Your task\" --expert-provider gemini --expert-model gemini-2.0-flash-thinking-exp-1219\n ```\n\nAider specific Environment Variables you can add:\n\n- `AIDER_FLAGS`: Optional comma-separated list of flags to pass to the underlying aider tool (e.g., \"yes-always,dark-mode\")\n\n```bash\n# Optional: Configure aider behavior\nexport AIDER_FLAGS=\"yes-always,dark-mode,no-auto-commits\"\n```\n\nNote: For `AIDER_FLAGS`, you can specify flags with or without the leading `--`. Multiple flags should be comma-separated, and spaces around flags are automatically handled. For example, both `\"yes-always,dark-mode\"` and `\"--yes-always, --dark-mode\"` are valid.\n\n**Important Notes:**\n- Performance varies between models. The default Claude 3 Sonnet model currently provides the best and most reliable results.\n- Model configuration is done via command line arguments: `--provider` and `--model`\n- The `--model` argument is required for all providers except Anthropic (which defaults to `claude-3-7-sonnet-20250219`)\n\nMore information is available in our [Open Models Setup](https://docs.ra-aid.ai/quickstart/open-models) guide.\n\n## Architecture\n\nRA.Aid implements a three-stage architecture for handling development and research tasks:\n\n1. **Research Stage**:\n - Gathers information and context\n - Analyzes requirements\n - Identifies key components and dependencies\n\n2. **Planning Stage**:\n - Develops detailed implementation plans\n - Breaks down tasks into manageable steps\n - Identifies potential challenges and solutions\n\n3. **Implementation Stage**:\n - Executes planned tasks\n - Generates code or documentation\n - Performs necessary system operations\n\n### Core Components\n\n- **Console Module** (`console/`): Handles console output formatting and user interaction\n- **Processing Module** (`proc/`): Manages interactive processing and workflow control\n- **Text Module** (`text/`): Provides text processing and manipulation utilities\n- **Tools Module** (`tools/`): Contains various utility tools for file operations, search, and more\n\n## Dependencies\n\n### Core Dependencies\n- `langchain-anthropic`: LangChain integration with Anthropic's Claude\n- `tavily-python`: Tavily API client for web research\n- `langgraph`: Graph-based workflow management\n- `rich>=13.0.0`: Terminal formatting and output\n- `GitPython==3.1.41`: Git repository management\n- `fuzzywuzzy==0.18.0`: Fuzzy string matching\n- `python-Levenshtein==0.23.0`: Fast string matching\n- `pathspec>=0.11.0`: Path specification utilities\n\n### Development Dependencies\n- `pytest>=7.0.0`: Testing framework\n- `pytest-timeout>=2.2.0`: Test timeout management\n\n## Development Setup\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/ai-christianson/RA.Aid.git\ncd RA.Aid\n```\n\n2. Create and activate a virtual environment:\n```bash\npython -m venv venv\nsource venv/bin/activate # On Windows use `venv\\Scripts\\activate`\n```\n\n3. Install development dependencies:\n```bash\npip install -r requirements-dev.txt\n```\n\n4. Run tests:\n```bash\npython -m pytest\n```\n\n## Contributing\n\nContributions are welcome! Please follow these steps:\n\n1. Fork the repository\n2. Create a feature branch:\n```bash\ngit checkout -b feature/your-feature-name\n```\n\n3. Make your changes and commit:\n```bash\ngit commit -m 'Add some feature'\n```\n\n4. Push to your fork:\n```bash\ngit push origin feature/your-feature-name\n```\n\n5. Open a Pull Request\n\n### Guidelines\n\n- Follow PEP 8 style guidelines\n- Add tests for new features\n- Update documentation as needed\n- Keep commits focused and message clear\n- Ensure all tests pass before submitting PR\n\nMore information is available in our [Contributing Guide](https://docs.ra-aid.ai/contributing).\n\n## License\n\nThis project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.\n\nCopyright (c) 2024 AI Christianson\n\n## Contact\n\n- **Issues**: Please report bugs and feature requests on our [Issue Tracker](https://github.com/ai-christianson/RA.Aid/issues)\n- **Repository**: [https://github.com/ai-christianson/RA.Aid](https://github.com/ai-christianson/RA.Aid)\n- **Documentation**: [https://github.com/ai-christianson/RA.Aid#readme](https://github.com/ai-christianson/RA.Aid#readme)\n",
"bugtrack_url": null,
"license": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n \n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n \n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n \n Copyright [2024] [AI Christianson]\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.",
"summary": "RA.Aid - ReAct Aid",
"version": "0.14.5",
"project_urls": {
"Documentation": "https://github.com/ai-christianson/RA.Aid#readme",
"Homepage": "https://github.com/ai-christianson/RA.Aid",
"Issues": "https://github.com/ai-christianson/RA.Aid/issues",
"Repository": "https://github.com/ai-christianson/RA.Aid.git"
},
"split_keywords": [
"agent",
" ai",
" development",
" langchain",
" tools"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4b4179eab5b16b481e2a159180a07cb148f73db688c5c8bbcde9536f53e24791",
"md5": "b2038fd23667fedb3c26bede15731c81",
"sha256": "4f747ab16e0f614421784b52bbaac0ec7426a315421f47bde9d509a8fec58fe3"
},
"downloads": -1,
"filename": "ra_aid-0.14.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b2038fd23667fedb3c26bede15731c81",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 115449,
"upload_time": "2025-02-25T00:58:37",
"upload_time_iso_8601": "2025-02-25T00:58:37.153577Z",
"url": "https://files.pythonhosted.org/packages/4b/41/79eab5b16b481e2a159180a07cb148f73db688c5c8bbcde9536f53e24791/ra_aid-0.14.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4d9eb4e30cb36fd96698520bc21aa57e528618511049d6e2104a724b6e0532a2",
"md5": "7002dc2af9083962b68c1c0d7c8fc9e7",
"sha256": "e5e9f4ad59fdebe399d10c2e4822c3ad51f75c2a10c9a3f2bb4508f5c5ccd329"
},
"downloads": -1,
"filename": "ra_aid-0.14.5.tar.gz",
"has_sig": false,
"md5_digest": "7002dc2af9083962b68c1c0d7c8fc9e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12545376,
"upload_time": "2025-02-25T00:58:39",
"upload_time_iso_8601": "2025-02-25T00:58:39.620924Z",
"url": "https://files.pythonhosted.org/packages/4d/9e/b4e30cb36fd96698520bc21aa57e528618511049d6e2104a724b6e0532a2/ra_aid-0.14.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-25 00:58:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ai-christianson",
"github_project": "RA.Aid#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ra-aid"
}
