Skip to content

Commit 04115b0

Browse files
mrubensmrubens
authored
Some basic FAQs (#28)
1 parent 4b3d9ba commit 04115b0

File tree

2 files changed

+173
-1
lines changed

2 files changed

+173
-1
lines changed

‎.clinerules‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Roo Code Documentation Rules
2+
3+
## Documentation Links
4+
- Do not include .md extensions in documentation links
5+
- Use relative paths for internal documentation links
6+
- Example: [link text](basic-usage/using-tools) NOT [link text](basic-usage/using-tools.md)
7+
8+
This ensures links work correctly in the built documentation while maintaining clean URLs.

‎docs/faq.md‎

Lines changed: 165 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,167 @@
11
# Frequently Asked Questions
22

3-
Coming soon!
3+
This page answers some common questions about Roo Code.
4+
5+
## General
6+
7+
### What is Roo Code?
8+
9+
Roo Code is a VS Code extension that provides an AI-powered coding assistant. It allows you to interact with a large language model (LLM) directly within your editor, using natural language to perform a wide range of coding tasks.
10+
11+
### How does Roo Code work?
12+
13+
Roo Code uses large language models (LLMs) to understand your requests and translate them into actions. It can:
14+
15+
* Read and write files in your project.
16+
* Execute commands in your VS Code terminal.
17+
* Perform web browsing (if enabled).
18+
* Use external tools via the Model Context Protocol (MCP).
19+
20+
You interact with Roo Code through a chat interface, where you provide instructions and review/approve its proposed actions.
21+
22+
### What can Roo Code do?
23+
24+
Roo Code can help with a variety of coding tasks, including:
25+
26+
* Generating code from natural language descriptions.
27+
* Refactoring existing code.
28+
* Fixing bugs.
29+
* Writing documentation.
30+
* Explaining code.
31+
* Answering questions about your codebase.
32+
* Automating repetitive tasks.
33+
* Creating new files and projects.
34+
35+
### Is Roo Code free to use?
36+
37+
The Roo Code extension itself is free and open-source. However, Roo Code relies on external API providers (like Anthropic, OpenAI, OpenRouter, etc.) for its AI capabilities. These providers typically charge for API usage based on the number of tokens processed. You will need to create an account and obtain an API key from your chosen provider. See [Setting Up Your First AI Provider](getting-started/connecting-api-provider) for details.
38+
39+
### What are the risks of using Roo Code?
40+
41+
Roo Code is a powerful tool, and it's important to use it responsibly. Here are some things to keep in mind:
42+
43+
* **Roo Code can make mistakes.** Always review Roo Code's proposed changes carefully before approving them.
44+
* **Roo Code can execute commands.** Be very cautious about allowing Roo Code to run commands, especially if you're using auto-approval.
45+
* **Roo Code can access the internet.** If you're using a provider that supports web browsing, be aware that Roo Code could potentially access sensitive information.
46+
47+
## Setup & Installation
48+
49+
### How do I install Roo Code?
50+
51+
See the [Installation Guide](getting-started/installing) for detailed instructions.
52+
53+
### Which API providers are supported?
54+
55+
Roo Code supports a wide range of API providers, including:
56+
57+
* Anthropic (Claude)
58+
* OpenAI (GPT models)
59+
* OpenRouter (access to multiple models)
60+
* Google Gemini
61+
* Glama
62+
* AWS Bedrock
63+
* GCP Vertex AI
64+
* Ollama (local models)
65+
* LM Studio (local models)
66+
* DeepSeek
67+
* Mistral
68+
* Unbound
69+
* Requesty
70+
* VS Code Language Model API
71+
72+
See [Configuring Your AI Provider and Model](#configuring-your-ai-provider-and-model) for details on setting up each provider.
73+
74+
### How do I get an API key?
75+
76+
Each API provider has its own process for obtaining an API key. See the [Setting Up Your First AI Provider](getting-started/connecting-api-provider) for links to the relevant documentation for each provider.
77+
78+
### Can I use Roo Code with local models?
79+
80+
Yes, Roo Code supports running models locally using Ollama and LM Studio. See [Using Local Models](advanced-usage/local-models) for instructions.
81+
82+
## Usage
83+
84+
### How do I start a new task?
85+
86+
Open the Roo Code panel (rocket icon 🚀) and type your task in the chat box. Be clear and specific about what you want Roo Code to do. See [Typing Your Requests](basic-usage/typing-your-requests) for best practices.
87+
88+
### What are modes in Roo Code?
89+
90+
[Modes](basic-usage/modes) are different personas that Roo Code can adopt, each with a specific focus and set of capabilities. The built-in modes are:
91+
92+
* **Code:** For general-purpose coding tasks.
93+
* **Architect:** For planning and technical leadership.
94+
* **Ask:** For answering questions and providing information.
95+
96+
You can also create [Custom Modes](advanced-usage/custom-modes).
97+
98+
### How do I switch between modes?
99+
100+
Use the dropdown menu in the chat input area to select a different mode, or use the `/` command to switch to a specific mode.
101+
102+
### What are tools and how do I use them?
103+
104+
[Tools](basic-usage/using-tools) are how Roo Code interacts with your system. Roo Code automatically selects and uses the appropriate tools to complete your tasks. You don't need to call tools directly. You will be prompted to approve or reject each tool use.
105+
106+
### What are context mentions?
107+
108+
[Context mentions](basic-usage/context-mentions) are a way to provide Roo Code with specific information about your project, such as files, folders, or problems. Use the "@" symbol followed by the item you want to mention (e.g., `@/src/file.ts`, `@problems`).
109+
110+
### Can Roo Code access the internet?
111+
112+
Yes, if you are using a provider with a model that support web browsing. Be mindful of the security implications of allowing this.
113+
114+
### Can Roo Code run commands in my terminal?
115+
116+
Yes, Roo Code can execute commands in your VS Code terminal. You will be prompted to approve each command before it's executed, unless you've enabled auto-approval for commands. Be extremely cautious about auto-approving commands.
117+
118+
### How do I provide feedback to Roo Code?
119+
120+
You can provide feedback by approving or rejecting Roo Code's proposed actions. You can provide additional feedback by using the feedback field.
121+
122+
### Can I customize Roo Code's behavior?
123+
124+
Yes, you can customize Roo Code in several ways:
125+
126+
* **Custom Instructions:** Provide general instructions that apply to all modes, or mode-specific instructions.
127+
* **Custom Modes:** Create your own modes with tailored prompts and tool permissions.
128+
* **`.clinerules` Files:** Create `.clinerules` files in your project to provide additional guidelines.
129+
* **Settings:** Adjust various settings, such as auto-approval, diff editing, and more.
130+
131+
### Does Roo Code have any auto approval settings?
132+
Yes, Roo Code has a few settings that when enabled will automatically approve actions. Find out more [here](advanced-usage/auto-approving-actions)
133+
134+
## Advanced Features
135+
136+
### Can I use Roo offline?
137+
Yes, if you use a [local model](advanced-usage/local-models).
138+
139+
### What is MCP (Model Context Protocol)?
140+
141+
[MCP](advanced-usage/mcp) is a protocol that allows Roo Code to communicate with external servers, extending its capabilities with custom tools and resources.
142+
143+
### Can I create my own MCP servers?
144+
145+
Yes, you can create your own MCP servers to add custom functionality to Roo Code. See the [MCP documentation](https://github.com/modelcontextprotocol) for details.
146+
147+
## Troubleshooting
148+
149+
### Roo Code isn't responding. What should I do?
150+
151+
* Make sure your API key is correct and hasn't expired.
152+
* Check your internet connection.
153+
* Check the status of your chosen API provider.
154+
* Try restarting VS Code.
155+
* If the problem persists, report the issue on [GitHub](https://github.com/RooVetGit/Roo-Code/issues) or [Discord](https://discord.gg/roocode).
156+
157+
### I'm seeing an error message. What does it mean?
158+
159+
The error message should provide some information about the problem. If you're unsure how to resolve it, seek help in the community forums.
160+
161+
### Roo Code made changes I didn't want. How do I undo them?
162+
163+
Roo Code uses VS Code's built-in file editing capabilities. You can use the standard "Undo" command (Ctrl/Cmd + Z) to revert changes. Also, if experimental checkpoints are enabled, Roo can revert changes made to a file.
164+
165+
### How do I report a bug or suggest a feature?
166+
167+
Please report bugs or suggest features on the Roo Code [Issues page](https://github.com/RooVetGit/Roo-Code/issues) and [Feature Requests page](https://github.com/RooVetGit/Roo-Code/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop).

0 commit comments

Comments
 (0)