UPdate Readme.

Browse Source
This commit is contained in:
retoor 2025-04-03 13:22:50 +02:00
parent cc04745542
commit 98d9e37616
1 changed files with 49 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -1,24 +1,64 @@
# R Vibe Tool
R is a CLI vibe tool for Linux with nice markdown output. It has agent support. Put your instructions into `~/.rcontext.txt`to describe how it should behave. Tip: include the saving of files as instruction step. Use the `index` tool to initialize only source files and no environment / node_modules files to continue on an existing project! Good to instruct that first of your `.rcontext.txt` file.
## Overview
By default it uses OpenAI GPT-3.5-turbo as the model. It will use my limited OpenAI key as example.
That will thus only work temporary! Good news, Ollama and Claude are also supported
R Vibe Tool is a powerful Command-Line Interface (CLI) utility designed for Linux environments, offering advanced AI-assisted development capabilities with elegant markdown output.
An example what I have vibed with is [this](https://molodetz.nl/projects/streamii/README.md.html).
## Features
## How to get it working under OLLAMA
### Ollama molodetz server is slow.
- **Flexible AI Integration**: Support for multiple AI models including:
- OpenAI GPT-3.5-turbo (default)
- Ollama
- Anthropic Claude
- **Customizable Behavior**: Configure tool behavior through `~/.rcontext.txt`
- **Agent Support**: Intelligent context-aware assistance
- **Markdown Output**: Clean, readable documentation generation
## Prerequisites
- Linux operating system
- Configured AI model access
## Configuration
### Environment Variables
#### Ollama Configuration
```bash
export R_MODEL="qwen2.5:3b"
export R_BASE_URL="https://ollama.molodetz.nl"
./r
```
## How to get it working under ANTHROPIC CLAUDE
```
#### Claude Configuration
```bash
export R_MODEL="claude-3-5-haiku-20241022"
export R_BASE_URL="https://api.anthropic.com"
export R_KEY="sk-ant-"
export R_KEY="sk-ant-[your-key]"
./r
```
## Best Practices
1. Use `~/.rcontext.txt` to define specific behavioral instructions
2. Include file saving steps in your context instructions
3. Use the `index` tool to initialize only source files, excluding environment and node_modules
## Example Project
For a comprehensive example of R Vibe Tool in action, visit:
[Streamii Project](https://molodetz.nl/projects/streamii/README.md.html)
## Limitations
- OpenAI key usage is temporary and limited
- Performance may vary depending on the selected AI model
## Support
For issues or contributions, please refer to the project repository.
## License
[Insert License Information]