Ru Agent¶
A coding agent built for Windows. Choose your model provider, bring your own API key, and work from a native desktop app or your terminal.
Describe a change. Ru reads your project, edits files, runs commands and keeps the work visible in the conversation. Your project and conversation storage stay on your machine; prompts and tool results go to the provider you select.
Early development. A Windows x64 Preview is available; source builds are also supported. Expect rough edges; reproducible bug reports help shape the next version.
Why Ru?¶
| What you get | |
|---|---|
| A native Windows app | A WinUI 3 chat surface with an activity feed, file changes and an integrated terminal. |
| A terminal interface | A full-screen TUI with session history, model selection, slash commands and a multiline composer. |
| Your provider and keys | Choose the model/provider in Settings. No Ru account; API keys use Windows Credential Manager. |
| Work you can follow | Read/search files, make edits, run builds/tests, inspect tool activity and track background commands. |
| Reusable workflows | Add repository instructions and SKILL.md workflows for tasks you repeat. |
Ru's orchestration runs locally. It also supports web search/fetch, which make network requests when used. Local-first does not mean offline inference or a bundled local model.
Install and update¶
Separate Windows x64 Desktop and CLI installers are available in
0.1.4-preview.1. Each includes its
matching backend; the .NET SDK is only needed when building from source. Desktop
updates from Settings → About → Updates; CLI uses ru update and TUI uses
/update. Stable is the default, with Preview available by choice.
See installation, channels and recovery for package names, CLI bootstrap instructions and release verification limits. Install CLI from Command Prompt:
powershell -NoProfile -ExecutionPolicy Bypass -Command "& ([scriptblock]::Create((irm 'https://raw.githubusercontent.com/OniAntou/Ru-Agent/dev/scripts/install.ps1'))) -Channel Preview"
Open a new terminal and run ru. The script downloads, verifies and installs the
CLI package without a setup wizard. Preview is opt-in; no Stable release is
published yet. The packages are unsigned.
Quick start¶
1. Build on Windows¶
Install the .NET 10 SDK and Git, then run in PowerShell:
git clone https://github.com/OniAntou/Ru-Agent.git
cd Ru-Agent
.\build.bat
.\start_dev.bat
The build creates a self-contained folder with RuApp.exe, RuBackend.exe
and RuAgent.Cli.exe. The published app includes .NET and the Windows App
Runtime. See the contributor guide
for the complete build requirements and output path.
2. Choose a model and open a project¶
In the desktop app, open Settings, configure your provider/API key and pick a model. Open your project folder, review the workspace trust prompt, then ask Ru to do a small task:
Find where this project handles configuration. Explain it before changing anything.
Or start a terminal chat from the repository:
.\bin\ru.cmd agent chat
See the TUI guide for commands, keyboard shortcuts and session navigation.
You choose the permissions¶
| Preset | Intended use |
|---|---|
plan |
Explore and plan with read-only tools. |
standard |
Work with the workspace under the standard policy; requests beyond it can require approval. |
full_access |
Allow broader tool access; external structured files, arbitrary terminal, and structured protected paths are automatic. |
Workspace trust and explicit approvals are part of the workflow. Instructions and skills guide the agent; they do not grant execution authority.
Terminal commands run as your Windows user, without an OS filesystem or network sandbox. Standard launch permission does not confine a child process to the workspace. Read the tool policy for exact boundaries.
Help build Ru¶
Use Ru on a small project and tell us what worked or broke. A short reproduction helps us improve the next version.
- Report a bug: include the surface, commit/version and reproduction steps.
- Suggest a feature: describe the workflow you want to improve.
- Start a discussion: share a use case, ask a question or compare workflows.
- Contribute code or docs: keep changes scoped and verify the behavior you touched.
If Ru is useful to you, a star helps other developers discover the project. Security reports belong in private advisories, not public issues.
Documentation¶
| Start here | Go deeper |
|---|---|
| Documentation index | Architecture |
| Terminal UI guide | Domain language |
| Tool policy | Verification evidence |
| Contributing | Security policy |
License¶
MIT. Use, modify and distribute Ru, including commercially, while keeping the license notice.