@quantum-ai/roo-code-cli 0.5.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +131 -0
- package/dist/index.mjs +20421 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +61 -0
package/README.md
ADDED
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://marketplace.visualstudio.com/items?itemName=RooVeterinaryInc.roo-cline"><img src="https://img.shields.io/badge/VS_Code_Marketplace-007ACC?style=flat&logo=visualstudiocode&logoColor=white" alt="VS Code Marketplace"></a>
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
# Roo Code
|
|
6
|
+
|
|
7
|
+
> Your AI-Powered Dev Team, Right in Your Editor
|
|
8
|
+
|
|
9
|
+
<details>
|
|
10
|
+
<summary>🌐 Available languages</summary>
|
|
11
|
+
|
|
12
|
+
- [English](README.md)
|
|
13
|
+
- [Català](locales/ca/README.md)
|
|
14
|
+
- [Deutsch](locales/de/README.md)
|
|
15
|
+
- [Español](locales/es/README.md)
|
|
16
|
+
- [Français](locales/fr/README.md)
|
|
17
|
+
- [हिंदी](locales/hi/README.md)
|
|
18
|
+
- [Bahasa Indonesia](locales/id/README.md)
|
|
19
|
+
- [Italiano](locales/it/README.md)
|
|
20
|
+
- [日本語](locales/ja/README.md)
|
|
21
|
+
- [한국어](locales/ko/README.md)
|
|
22
|
+
- [Nederlands](locales/nl/README.md)
|
|
23
|
+
- [Polski](locales/pl/README.md)
|
|
24
|
+
- [Português (BR)](locales/pt-BR/README.md)
|
|
25
|
+
- [Русский](locales/ru/README.md)
|
|
26
|
+
- [Türkçe](locales/tr/README.md)
|
|
27
|
+
- [Tiếng Việt](locales/vi/README.md)
|
|
28
|
+
- [简体中文](locales/zh-CN/README.md)
|
|
29
|
+
- [繁體中文](locales/zh-TW/README.md)
|
|
30
|
+
- ...
|
|
31
|
+
</details>
|
|
32
|
+
|
|
33
|
+
## Installation
|
|
34
|
+
|
|
35
|
+
You can install Roo Code CLI globally via npm:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npm install -g @quantum-ai/roo-code-cli
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Usage with OpenAI-Compatible API
|
|
42
|
+
|
|
43
|
+
Roo Code can be configured to work with any OpenAI-compatible API endpoint.
|
|
44
|
+
|
|
45
|
+
### Set Environment Variables
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
set OPENAI_API_KEY=YourTokenHere
|
|
49
|
+
set OPENAI_BASE_URL=https://api.deepseek.com/v1
|
|
50
|
+
set OPENAI_MODEL=deepseek-chat
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Start Interactive TUI Mode
|
|
54
|
+
|
|
55
|
+
Start the TUI interface directly:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
npx roo --tui --yolo
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
This skips initial setup questions and launches the interactive mode immediately.
|
|
62
|
+
|
|
63
|
+
### Use with a Prompt
|
|
64
|
+
|
|
65
|
+
Send a prompt and get a response:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
npx roo --prompt "Hello"
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### YOLO Mode (Auto-Approve All Actions)
|
|
72
|
+
|
|
73
|
+
Enable YOLO mode to automatically approve all actions without confirmation:
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
npx roo --prompt "Hello" --yolo
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
or
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
npx roo --approval-mode yolo
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
**Warning:** YOLO mode bypasses all security approvals. Use with caution.
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## What Can Roo Code Do For YOU?
|
|
90
|
+
|
|
91
|
+
- Generate Code from natural language descriptions and specs
|
|
92
|
+
- Adapt with Modes: Code, Architect, Ask, Debug, and Custom Modes
|
|
93
|
+
- Refactor & Debug existing code
|
|
94
|
+
- Write & Update documentation
|
|
95
|
+
- Answer Questions about your codebase
|
|
96
|
+
- Automate repetitive tasks
|
|
97
|
+
- Utilize MCP Servers
|
|
98
|
+
|
|
99
|
+
## Modes
|
|
100
|
+
|
|
101
|
+
Roo Code adapts to how you work:
|
|
102
|
+
|
|
103
|
+
- Code Mode: everyday coding, edits, and file ops
|
|
104
|
+
- Architect Mode: plan systems, specs, and migrations
|
|
105
|
+
- Ask Mode: fast answers, explanations, and docs
|
|
106
|
+
- Debug Mode: trace issues, add logs, isolate root causes
|
|
107
|
+
- Custom Modes: build specialized modes for your team or workflow
|
|
108
|
+
|
|
109
|
+
Learn more: [Using Modes](https://roocodeinc.github.io/Roo-Code/basic-usage/using-modes) • [Custom Modes](https://roocodeinc.github.io/Roo-Code/advanced-usage/custom-modes)
|
|
110
|
+
|
|
111
|
+
## Resources
|
|
112
|
+
|
|
113
|
+
- **[Documentation](https://roocodeinc.github.io/Roo-Code/):** The official guide to installing, configuring, and mastering Roo Code.
|
|
114
|
+
- **[GitHub Issues](https://github.com/RooCodeInc/Roo-Code/issues):** Report bugs and track development.
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## Disclaimer
|
|
119
|
+
|
|
120
|
+
The Roo Code Extension was shut down on May 15th.
|
|
121
|
+
|
|
122
|
+
- If you're looking for an alternative, check out [ZooCode](https://github.com/Zoo-Code-Org/Zoo-Code/) (a fork started by the Roo Code community) and [Cline](https://cline.bot/) (from where Roo Code originated).
|
|
123
|
+
- If you were a paying user and have billing questions, please write [billing@roocode.com](mailto:billing@roocode.com).
|
|
124
|
+
|
|
125
|
+
**Please note** that Roo Code, Inc does **not** make any representations or warranties regarding any code, models, or other tools provided or made available in connection with Roo Code, any associated third-party tools, or any resulting outputs. You assume **all risks** associated with the use of any such tools or outputs; such tools are provided on an **"AS IS"** and **"AS AVAILABLE"** basis. Such risks may include, without limitation, intellectual property infringement, cyber vulnerabilities or attacks, bias, inaccuracies, errors, defects, viruses, downtime, property loss or damage, and/or personal injury. You are solely responsible for your use of any such tools or outputs (including, without limitation, the legality, appropriateness, and results thereof).
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## License
|
|
130
|
+
|
|
131
|
+
[Apache 2.0 © 2026 Roo Code, Inc.](./LICENSE)
|