zach
/
RA.Aid
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add chat mode documentation to README

This commit is contained in:
user 2024-12-22 15:54:05 -05:00
parent b28e5b30b4
commit 4cdb6c4ce0
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -160,6 +160,7 @@ ra-aid -m "Explain the authentication flow" --research-only
- `--model`: Specify the model name (See Model Configuration section) - `--model`: Specify the model name (See Model Configuration section)
- `--expert-provider`: Specify the provider for the expert tool (defaults to OpenAI) - `--expert-provider`: Specify the provider for the expert tool (defaults to OpenAI)
- `--expert-model`: Specify the model name for the expert tool (defaults to o1-preview for OpenAI) - `--expert-model`: Specify the model name for the expert tool (defaults to o1-preview for OpenAI)
- `--chat`: Enable chat mode for interactive assistance
### Model Configuration ### Model Configuration
@ -314,6 +315,9 @@ This mode is particularly useful for:
- Validating critical changes - Validating critical changes
- Providing domain-specific knowledge - Providing domain-specific knowledge
### Chat Mode
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.
### Environment Variables ### Environment Variables
See the [Model Configuration](#model-configuration) section for details on provider-specific environment variables. See the [Model Configuration](#model-configuration) section for details on provider-specific environment variables.