diff --git a/README.md b/README.md index 2f3a6069d9..8fd0145eba 100644 --- a/README.md +++ b/README.md @@ -1,261 +1,58 @@ -
- +# Riko 🚀 -English • [Català](locales/ca/README.md) • [Deutsch](locales/de/README.md) • [Español](locales/es/README.md) • [Français](locales/fr/README.md) • [हिंदी](locales/hi/README.md) • [Bahasa Indonesia](locales/id/README.md) • [Italiano](locales/it/README.md) • [日本語](locales/ja/README.md) +*A fork of the Roo codebase enhanced with integrated, AI-powered, spec-driven development features.* - - +**Project Status:** In Development -[한국어](locales/ko/README.md) • [Nederlands](locales/nl/README.md) • [Polski](locales/pl/README.md) • [Português (BR)](locales/pt-BR/README.md) • [Русский](locales/ru/README.md) • [Türkçe](locales/tr/README.md) • [Tiếng Việt](locales/vi/README.md) • [简体中文](locales/zh-CN/README.md) • [繁體中文](locales/zh-TW/README.md) +## Vision - -
-
-
-

Roo Code

-

- -

-

Connect with developers, contribute ideas, and stay ahead with the latest AI-powered coding tools.

- - Join Discord - Join Reddit - -
-
-
- -
- -Download on VS Marketplace -Feature Requests -Rate & Review -Documentation - -
- -**Roo Code** is an AI-powered **autonomous coding agent** that lives in your editor. It can: - -- Communicate in natural language -- Read and write files directly in your workspace -- Run terminal commands -- Automate browser actions -- Integrate with any OpenAI-compatible or custom API/model -- Adapt its “personality” and capabilities through **Custom Modes** - -Whether you’re seeking a flexible coding partner, a system architect, or specialized roles like a QA engineer or product manager, Roo Code can help you build software more efficiently. - -Check out the [CHANGELOG](CHANGELOG.md) for detailed updates and fixes. +**Riko** extends the powerful and intuitive Roo application with a native feature for **spec-driven development**. The goal is to provide developers with a systematic way to plan, design, and map out implementation tasks directly within their primary workflow. By integrating this structured process, Riko aims to improve planning, enhance collaboration, and increase the quality and maintainability of software projects. --- -## 🎉 Roo Code 3.25 Released - -Roo Code 3.25 brings powerful new features and significant improvements to enhance your development workflow! - -- **Message Queueing** - Queue multiple messages while Roo is working, allowing you to continue planning your workflow without interruption. -- **Custom Slash Commands** - Create personalized slash commands for quick access to frequently used prompts and workflows, with full UI management. -- **Enhanced Gemini Tools** - New URL context and Google Search grounding capabilities provide Gemini models with real-time web information and enhanced research abilities. - ---- - -## What Can Roo Code Do? - -- 🚀 **Generate Code** from natural language descriptions -- 🔧 **Refactor & Debug** existing code -- 📝 **Write & Update** documentation -- 🤔 **Answer Questions** about your codebase -- 🔄 **Automate** repetitive tasks -- 🏗️ **Create** new files and projects - -## Quick Start - -1. [Install Roo Code](https://docs.roocode.com/getting-started/installing) -2. [Connect Your AI Provider](https://docs.roocode.com/getting-started/connecting-api-provider) -3. [Try Your First Task](https://docs.roocode.com/getting-started/your-first-task) - -## Key Features - -### Multiple Modes +## Core Features -Roo Code adapts to your needs with specialized [modes](https://docs.roocode.com/basic-usage/using-modes): - -- **Code Mode:** For general-purpose coding tasks -- **Architect Mode:** For planning and technical leadership -- **Ask Mode:** For answering questions and providing information -- **Debug Mode:** For systematic problem diagnosis -- **[Custom Modes](https://docs.roocode.com/advanced-usage/custom-modes):** Create unlimited specialized personas for security auditing, performance optimization, documentation, or any other task - -### Smart Tools - -Roo Code comes with powerful [tools](https://docs.roocode.com/basic-usage/how-tools-work) that can: - -- Read and write files in your project -- Execute commands in your VS Code terminal -- Control a web browser -- Use external tools via [MCP (Model Context Protocol)](https://docs.roocode.com/advanced-usage/mcp) - -MCP extends Roo Code's capabilities by allowing you to add unlimited custom tools. Integrate with external APIs, connect to databases, or create specialized development tools - MCP provides the framework to expand Roo Code's functionality to meet your specific needs. - -### Customization - -Make Roo Code work your way with: - -- [Custom Instructions](https://docs.roocode.com/advanced-usage/custom-instructions) for personalized behavior -- [Custom Modes](https://docs.roocode.com/advanced-usage/custom-modes) for specialized tasks -- [Local Models](https://docs.roocode.com/advanced-usage/local-models) for offline use -- [Auto-Approval Settings](https://docs.roocode.com/advanced-usage/auto-approving-actions) for faster workflows - -## Resources - -### Documentation - -- [Basic Usage Guide](https://docs.roocode.com/basic-usage/the-chat-interface) -- [Advanced Features](https://docs.roocode.com/advanced-usage/auto-approving-actions) -- [Frequently Asked Questions](https://docs.roocode.com/faq) - -### Community - -- **Discord:** [Join our Discord server](https://discord.gg/roocode) for real-time help and discussions -- **Reddit:** [Visit our subreddit](https://www.reddit.com/r/RooCode) to share experiences and tips -- **GitHub:** Report [issues](https://github.com/RooCodeInc/Roo-Code/issues) or request [features](https://github.com/RooCodeInc/Roo-Code/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop) +* **Spec Management Dashboard**: A centralized view to create, manage, and track the status of all your feature specifications. +* **Multi-Phase Spec Editor**: A guided, three-phase editor for defining **Requirements**, creating a **Technical Design**, and breaking down the work into **Implementation Tasks**. +* **Seamless Roo Integration**: Built to feel like a natural part of the Roo application, Riko uses the existing Svelte component library and Tailwind CSS design system for a consistent UX. +* **AI-Assisted Workflow**: Designed to work with AI assistants to help generate, refine, and implement specs, streamlining the development process. --- -## Local Setup & Development - -1. **Clone** the repo: - -```sh -git clone https://github.com/RooCodeInc/Roo-Code.git -``` - -2. **Install dependencies**: - -```sh -pnpm install -``` +## Getting Started (Development) -3. **Run the extension**: +Riko is a full-stack SvelteKit and Express.js application. To get started with development, follow these steps: -There are several ways to run the Roo Code extension: - -### Development Mode (F5) - -For active development, use VSCode's built-in debugging: - -Press `F5` (or go to **Run** → **Start Debugging**) in VSCode. This will open a new VSCode window with the Roo Code extension running. - -- Changes to the webview will appear immediately. -- Changes to the core extension will also hot reload automatically. - -### Automated VSIX Installation - -To build and install the extension as a VSIX package directly into VSCode: - -```sh -pnpm install:vsix [-y] [--editor=] -``` - -This command will: - -- Ask which editor command to use (code/cursor/code-insiders) - defaults to 'code' -- Uninstall any existing version of the extension. -- Build the latest VSIX package. -- Install the newly built VSIX. -- Prompt you to restart VS Code for changes to take effect. - -Options: - -- `-y`: Skip all confirmation prompts and use defaults -- `--editor=`: Specify the editor command (e.g., `--editor=cursor` or `--editor=code-insiders`) - -### Manual VSIX Installation - -If you prefer to install the VSIX package manually: - -1. First, build the VSIX package: - ```sh - pnpm vsix - ``` -2. A `.vsix` file will be generated in the `bin/` directory (e.g., `bin/roo-cline-.vsix`). -3. Install it manually using the VSCode CLI: - ```sh - code --install-extension bin/roo-cline-.vsix +1. **Clone the repository:** + ```bash + git clone [https://github.com/aaronmrosenthal/riko.git](https://github.com/aaronmrosenthal/riko.git) + cd riko ``` ---- - -We use [changesets](https://github.com/changesets/changesets) for versioning and publishing. Check our `CHANGELOG.md` for release notes. - ---- - -## Disclaimer - -**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). +2. **Install Frontend Dependencies:** + ```bash + cd frontend + npm install + ``` ---- +3. **Run Frontend Dev Server:** + ```bash + npm run dev + ``` -## Contributing +4. **Install Backend Dependencies:** + ```bash + cd ../server + npm install + ``` -We love community contributions! Get started by reading our [CONTRIBUTING.md](CONTRIBUTING.md). +5. **Run Backend Dev Server:** + ```bash + npm run dev + ``` --- -## Contributors - -Thanks to all our contributors who have helped make Roo Code better! - - - -| mrubens
mrubens | saoudrizwan
saoudrizwan | cte
cte | daniel-lxs
daniel-lxs | samhvw8
samhvw8 | hannesrudolph
hannesrudolph | -| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| KJ7LNW
KJ7LNW | a8trejo
a8trejo | MuriloFP
MuriloFP | ColemanRoo
ColemanRoo | canrobins13
canrobins13 | stea9499
stea9499 | -| jr
jr | joemanley201
joemanley201 | System233
System233 | nissa-seru
nissa-seru | jquanton
jquanton | roomote-agent
roomote-agent | -| NyxJae
NyxJae | d-oit
d-oit | elianiva
elianiva | chrarnoldus
chrarnoldus | qdaxb
qdaxb | xyOz-dev
xyOz-dev | -| punkpeye
punkpeye | wkordalski
wkordalski | SannidhyaSah
SannidhyaSah | sachasayan
sachasayan | Smartsheet-JB-Brown
Smartsheet-JB-Brown | monotykamary
monotykamary | -| cannuri
cannuri | feifei325
feifei325 | zhangtony239
zhangtony239 | shariqriazz
shariqriazz | vigneshsubbiah16
vigneshsubbiah16 | pugazhendhi-m
pugazhendhi-m | -| lloydchang
lloydchang | liwilliam2021
liwilliam2021 | dtrugman
dtrugman | hassoncs
hassoncs | PeterDaveHello
PeterDaveHello | Szpadel
Szpadel | -| lupuletic
lupuletic | kiwina
kiwina | Premshay
Premshay | psv2522
psv2522 | olweraltuve
olweraltuve | diarmidmackenzie
diarmidmackenzie | -| ChuKhaLi
ChuKhaLi | NaccOll
NaccOll | aheizi
aheizi | nbihan-mediware
nbihan-mediware | noritaka1166
noritaka1166 | RaySinner
RaySinner | -| afshawnlotfi
afshawnlotfi | dleffel
dleffel | StevenTCramer
StevenTCramer | Ruakij
Ruakij | pdecat
pdecat | kyle-apex
kyle-apex | -| emshvac
emshvac | brunobergher
brunobergher | Lunchb0ne
Lunchb0ne | SmartManoj
SmartManoj | vagadiya
vagadiya | slytechnical
slytechnical | -| dlab-anton
dlab-anton | arthurauffray
arthurauffray | upamune
upamune | NamesMT
NamesMT | taylorwilsdon
taylorwilsdon | sammcj
sammcj | -| p12tic
p12tic | gtaylor
gtaylor | aitoroses
aitoroses | benzntech
benzntech | ross
ross | mr-ryan-james
mr-ryan-james | -| heyseth
heyseth | taisukeoe
taisukeoe | avtc
avtc | eonghk
eonghk | GOODBOY008
GOODBOY008 | kcwhite
kcwhite | -| ronyblum
ronyblum | teddyOOXX
teddyOOXX | thill2323
thill2323 | vincentsong
vincentsong | yongjer
yongjer | zeozeozeo
zeozeozeo | -| ashktn
ashktn | franekp
franekp | yt3trees
yt3trees | seedlord
seedlord | QuinsZouls
QuinsZouls | anton-otee
anton-otee | -| axkirillov
axkirillov | bramburn
bramburn | olearycrew
olearycrew | catrielmuller
catrielmuller | devxpain
devxpain | snoyiatk
snoyiatk | -| GitlyHallows
GitlyHallows | jcbdev
jcbdev | Chenjiayuan195
Chenjiayuan195 | julionav
julionav | KanTakahiro
KanTakahiro | kevint-cerebras
kevint-cerebras | -| SplittyDev
SplittyDev | mdp
mdp | napter
napter | philfung
philfung | dqroid
dqroid | dairui1
dairui1 | -| chris-garrett
chris-garrett | bbenshalom
bbenshalom | bannzai
bannzai | ershang-fireworks
ershang-fireworks | f14XuanLv
f14XuanLv | janaki-sasidhar
janaki-sasidhar | -| forestyoo
forestyoo | hatsu38
hatsu38 | hongzio
hongzio | im47cn
im47cn | shoopapa
shoopapa | axmo
axmo | -| asychin
asychin | amittell
amittell | Yoshino-Yukitaro
Yoshino-Yukitaro | Yikai-Liao
Yikai-Liao | zxdvd
zxdvd | s97712
s97712 | -| vladstudio
vladstudio | vivekfyi
vivekfyi | HahaBill
HahaBill | tmsjngx0
tmsjngx0 | TGlide
TGlide | Githubguy132010
Githubguy132010 | -| tgfjt
tgfjt | maekawataiki
maekawataiki | DeXtroTip
DeXtroTip | qingyuan1109
qingyuan1109 | refactorthis
refactorthis | robertheadley
robertheadley | -| samir-nimbly
samir-nimbly | sensei-woo
sensei-woo | shaybc
shaybc | shivamd1810
shivamd1810 | shohei-ihaya
shohei-ihaya | shubhamgupta731
shubhamgupta731 | -| student20880
student20880 | takakoutso
takakoutso | user202729
user202729 | cdlliuy
cdlliuy | zetaloop
zetaloop | PretzelVector
PretzelVector | -| nevermorec
nevermorec | jues
jues | jwcraig
jwcraig | kinandan
kinandan | kohii
kohii | lhish
lhish | -| lightrabbit
lightrabbit | olup
olup | mecab
mecab | mlopezr
mlopezr | moqimoqidea
moqimoqidea | mosleyit
mosleyit | -| nobu007
nobu007 | oprstchn
oprstchn | village-way
village-way | philipnext
philipnext | pokutuna
pokutuna | pfitz
pfitz | -| ExactDoug
ExactDoug | celestial-vault
celestial-vault | linegel
linegel | ertan2002
ertan2002 | edwin-truthsearch-io
edwin-truthsearch-io | EamonNerbonne
EamonNerbonne | -| dbasclpy
dbasclpy | dflatline
dflatline | Deon588
Deon588 | dleen
dleen | CW-B-W
CW-B-W | chadgauth
chadgauth | -| thecolorblue
thecolorblue | bogdan0083
bogdan0083 | benashby
benashby | Atlogit
Atlogit | atlasgong
atlasgong | AntiMoron
AntiMoron | -| andrewshu2000
andrewshu2000 | andreastempsch
andreastempsch | alasano
alasano | HadesArchitect
HadesArchitect | alarno
alarno | nexon33
nexon33 | -| adilhafeez
adilhafeez | adamwlarson
adamwlarson | adamhill
adamhill | AMHesch
AMHesch | adambrand
adambrand | abumalick
abumalick | -| AlexandruSmirnov
AlexandruSmirnov | samsilveira
samsilveira | 01Rian
01Rian | RSO
RSO | RandalSchwartz
RandalSchwartz | SECKainersdorfer
SECKainersdorfer | -| R-omk
R-omk | pwilkin
pwilkin | Sarke
Sarke | PaperBoardOfficial
PaperBoardOfficial | OlegOAndreev
OlegOAndreev | niteshbalusu11
niteshbalusu11 | -| Naam
Naam | kvokka
kvokka | ecmasx
ecmasx | mollux
mollux | marvijo-code
marvijo-code | markijbema
markijbema | -| mamertofabian
mamertofabian | monkeyDluffy6017
monkeyDluffy6017 | libertyteeth
libertyteeth | shtse8
shtse8 | Rexarrior
Rexarrior | kevinvandijk
kevinvandijk | -| KevinZhao
KevinZhao | ksze
ksze | AyazKaan
AyazKaan | Juice10
Juice10 | snova-jorgep
snova-jorgep | Fovty
Fovty | -| Jdo300
Jdo300 | hesara
hesara | | | | | - - - -## License - -[Apache 2.0 © 2025 Roo Code, Inc.](./LICENSE) - ---- +## Contribution -**Enjoy Roo Code!** Whether you keep it on a short leash or let it roam autonomously, we can’t wait to see what you build. If you have questions or feature ideas, drop by our [Reddit community](https://www.reddit.com/r/RooCode/) or [Discord](https://discord.gg/roocode). Happy coding! +This project is currently under active development. Please refer to the project's issue tracker for tasks and feel free to open a pull request.