Skip to content

CapyAgent - a program on your own computer.

RUEN
Download

Documentation

First tell us what you want to do

The materials are laid out by task, not by area of the code. Below are the entry points, from "install it and get the first answer" to "add my own connector".

What is free and what is paid is on the pricing page. Would rather not run your own server? There is the cloud.

Quick start

The program is distributed under BSL 1.1, the licence terms are published and ready-made releases sit beside them. The repository is closed for now, so the program is inspected by running it: what it does on your machine and where it goes on the network is visible from the program itself.

Entry points

If you want to...

01 first run

Run it and see an answer

Requirements, install, model setup, the first conversation. The shortest road from zero to a working agent.

Quick start

03 config

Configure the model and channels

Model providers, channel tokens, environment variables, tool restrictions and confirmations.

Setup guide

04 internals

Understand how it is built

The agent loop, channels, memory, the scheduler, the policy layer and the local HTTP API. What the agent consists of, and why.

For technical specialists

05 access

Open access to data safely

The full security model: confirmations, the boundary around untrusted data, connector isolation, what stays local and what is transmitted.

Data and security

06 services

Connect a specific service

The connector catalogue: which tools each one provides, which variables it needs, and where that service loses data silently.

List of systems

07 service

Run it as a permanent service

The systemd unit, a dedicated user, the data directory, the journal, and what to do when a channel dies.

Server install

08 skills

Add a skill or a plugin

The plugin manifest, the SKILL.md format, permissions for secrets and network, and the lock file that pins contents.

Skills and plugins

In brief

How the project is built

A Go core

One binary: the agent loop, channels, memory, the scheduler, the access policy and a local HTTP API. The reason is simple: a client gets it installed on a laptop, not on a cluster.

Connectors to services

Each connector is a separate small program that connects one service over the MCP standard. It runs apart from the core and works in any compatible MCP host. Even if the core has to be replaced, the connectors will outlive the change.

Checks before a release

Every release goes through automated checks before it is published. What does not pass does not reach the client.

A warning that stops nobody gets read exactly once. That is why the checks stop a build instead of adding a note to a list.

Did not find the answer?

Write what you need to do and we will say whether it exists in the code and where to look.

Write to us See what changed

Related

  • First launch - From download to the first conversation.
  • Install on a server - One command, a setup wizard and a Telegram bot.
  • Pricing - What is free, what is paid and what is sold separately.
  • Cloud - When you would rather not run your own server: the agent runs on ours.
  • How it works inside - Connectors, the ways data gets lost and what already works.