useagent README

The project's README from github.com/useagenthq/useagent. As one markdown file: README.md.

useAgent

The open-source AI coworker for your team.
Your agents. Their own computer. Finished work you can use.

Status: alpha License: AGPL-3.0 Runtime: bun Documentation

Watch the demo · Quick Start · Self-hosting · Documentation · Architecture

useAgent gives Claude Code, Codex, OpenCode, and Pi a shared workspace with repositories, a terminal, a browser, and your team's tools and context. Ask for research, a website, a spreadsheet, or a code change. Follow the work in the thread, step in when needed, and open the files it produces.

Watch useAgent in action: an agent session with a live timeline, terminal, and workspace panes

Watch the 63-second product tour →
Real product footage. No sign-in required. The recorded UI may differ from your release.

Alpha software. useAgent is under active development: expect rough edges, and APIs/schemas may change between releases. It already runs real daily workloads, but pin a tag if you need stability.

Features

A computer for every thread

Watch an agent research in a real browser, run commands, and work with your repositories. Open its desktop or terminal and take control when you need to. Daytona and CubeSandbox provide isolated Linux workstations with screen recording.

Computer use and sandboxes →

An agent reads browser sources while its tool activity and research stream into the thread

Teach it how your team works

Import skills from GitHub, pin a playbook to a task, and reuse the procedures that work. Skills are versioned, so a run records exactly what it used.

Skills and playbooks →

Browse reusable skills and the team's knowledge from the shared workspace

Context that carries forward

Keep knowledge, wiki pages, and optional team memory beside the work. Inspect recalled facts, correct them, and keep personal and organization memory separate.

Knowledge and memory →

The memory hub with separate organization and personal views, shown in dark and light themes

Also in the workspace:

Supported agents

Claude Code   Codex   OpenCode   Pi

One session UI and event contract across engines. Connect a supported provider account or API key; available models, login methods, and tools depend on the adapter and your self-hosted configuration. See the engine guide.

Integrations

Work arrives from anywhere and tools stay behind the gateway:

Surface What's connected
Channels in Web app, Slack, REST API, schedules - every channel enters through the same run door
Native Slack (mentions, threads, delivery), GitHub (App auth, clones, PRs)
Via connectors Gmail, Linear, Notion, HubSpot - OAuth handled by the broker, tokens sealed server-side
Workspace surfaces Knowledge base, team memory, skills and playbooks, scheduled automations

Quick Start

Clone the public repository:

git clone https://github.com/useagenthq/useagent.git
cd useagent

Requires bun and Postgres 16+ with the pgvector extension (stock Postgres images do not include it). No Postgres handy? One container does it:

docker run -d --name useagent-pg -p 127.0.0.1:5432:5432 \
  -e POSTGRES_HOST_AUTH_METHOD=trust pgvector/pgvector:pg16
export DATABASE_URL=postgres://postgres@localhost:5432/postgres
for workspace in \
  packages/agent-harness packages/artifact-workspace \
  packages/agent-client packages/artifact-formats packages/sandbox-contract \
  packages/conformance packages/cli \
  backend frontend; do
  (cd "$workspace" && bun install --frozen-lockfile)
done

bun run dev:backend    # API + orchestration on :3201
bun run dev:frontend   # UI on :3400 (proxies /api/* to the backend)

bun run typecheck covers every package.

The database example is for local development. See the setup guide for provider credentials and sandbox configuration before running a real agent task.

Self-hosting

useAgent runs on any Linux host - AWS, Google Cloud, Azure, Hetzner, or bare metal. See infra/self-host/ for the full guide, including the one-command Hetzner reference host (Terraform) and the provider-agnostic deploy-app.sh:

SERVER_IP=<host-ip> PG_PASSWORD=... OPENROUTER_API_KEY=... \
  infra/self-host/deploy-app.sh /path/to/this/repo

Sandboxes are pluggable: Daytona (managed service - pairs with a host on any cloud, easiest start) or CubeSandbox (self-hosted runtime on your own hardware - full data locality). Production deploy lanes are documented in infra/self-host/; the provisioning is provider-agnostic and addresses the host over SSH.

Architecture

useAgent architecture: entry channels feed a self-hosted control plane (Run API, Postgres event log, engine adapters, session UI); adapters spawn an isolated cloud sandbox per thread; every integration crosses the trusted gateway; finished work comes back as editable artifacts

Three properties do the heavy lifting:

  1. The engine is a plug. Claude Code, Codex, OpenCode, and Pi all speak one canonical event contract through the engine adapters - swap engines and your threads, artifacts, and memory stay.
  2. Every run is an event log. Postgres is the source of truth: runs survive backend restarts, replay exactly, and stay inspectable after the fact.
  3. Credentials never enter the sandbox. The agent's computer is isolated; every integration call crosses the trusted gateway as a typed tool, and the keys live only on your control plane.
Path What it owns
frontend/ Product UI: chat, sessions, skills, playbooks, wiki, artifacts, automations, settings
backend/ Control plane: auth, runs, sandboxes, engines, knowledge, memory, artifacts, connectors
packages/ Shared contracts: thread events, canonical engine events, workpieces, renderers
docs-site/ Documentation site: concepts, architecture, API, operations
infra/self-host/ Self-hosting on any provider + Hetzner reference Terraform
memory/ Optional team-memory service

Deeper reading: the documentation site and the interactive request-flow diagram.

The additive immutable-container release lane is documented in docs/operations/immutable-releases.md.

Community and contributing

License

useAgent is free and open-source software under the GNU AGPL v3.0 (AGPL-3.0-only). You may use, modify, and self-host useAgent under the AGPL.

If you want to embed useAgent into proprietary software, distribute it without AGPL obligations, build an OEM or white-label product, or obtain different terms, a commercial license is available.

Contributions are accepted under the CLA. The useAgent name and logo are covered by the trademark policy, not the code license. Third-party components are listed in NOTICE; vendored and ported files carry per-file attribution headers.

useagent (useagenthq/useagent)

Searching Database…

这是什么?useAgent 是 Devin 的开源替代品:它为 Claude Code、Codex、OpenCode 和 Pi 这类编程 agent 提供一个带终端、浏览器和团队工具的共享云工作区,让它们能做调研、改代码、写文档这类实际工作。
这是装好就能用的应用,还是我需要自己部署的平台?它是一个自托管平台,由前端网页应用、后端控制平面和可插拔的沙箱运行时(Daytona 或 CubeSandbox)组成,沙箱运行时真正运行 agent 的隔离工作站;你把整套东西部署在自己的 Linux 主机或云账户上。
怎么让它跑起来?克隆仓库,然后用 bun 和一个启用了 pgvector 扩展的 Postgres 16+ 数据库来运行它;如果还没有现成的 Postgres,可以用一个容器把它启动起来,正式部署前可用 bun run typecheck 检查每一个包。
它支持哪些编程 agent?需要它们的账户吗?它通过一个共享的事件契约支持 Claude Code、Codex、OpenCode 和 Pi;每一个都用提供商账户或 API 密钥来连接,可用的模型、登录方式和工具取决于该引擎的适配器以及你的自托管配置。
它现在稳定性如何?它被标注为 alpha 软件:要预期各种粗糙之处以及版本间破坏 API 和 schema 的变更,不过只要你固定某个发布标签,它已经能承担真实的日常工作负载。
我的凭据和 API 密钥会去哪里?它们绝不会进入 agent 的沙箱;每一次集成调用都作为类型化的工具经过一个可信网关,密钥只保存在你自己的控制平面上。
agent 在工作区里实际能产出什么?文档、电子表格、演示文稿、PDF、图片和视频,这些被称为 workpiece,支持带修订记录的编辑和原生格式导出。
可以不通过网页应用、直接从 Slack 派任务吗?可以,你在 Slack 里提及某个 agent、发送附件,就能在会话线程里收到完成的产物;此外还有网页应用、REST API 和定时计划这几个入口。
skills 和 playbooks 是什么?skill 是你从 GitHub 导入并固定到某个任务上的流程;它们带版本管理,每次运行都会准确记录所用的版本,让团队能复用已经行之有效的做法。
它能连接哪些第三方工具?通过 OAuth 连接器可以连接 Gmail、Linear、Notion 和 HubSpot,由一个 broker 处理认证并在服务端封存令牌,agent 永远看不到原始凭据。
What are similar projects?open-swe, moyai, ruflo, qm, claude-code, nocobase, hive, Aperant
Creator
useagenthq
Size
44.9 MB
Stars
366
Age
1mo
Commits · 90 Days