Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Repository: **Rayrun Bot** (`RayrunOS/Rayrun-Bot`). DSH plugin package names kee

- `README.md` — product page (English, source of truth); `README.zh-CN.md` — mirror, updated in the same commit.
- `docs/` — quick start, architecture, security, FAQ, roadmap, Grok Bot inspiration, MVP plan, client plan, UI design, bot persona, local file design, platform asks. README stays short; detail goes here.
- `packages/dsh-rayrun-bots/` — the whole product layer: bot roster, bot↔session mapping, persistent host, approvals, routines, client panel, and the adapter to the cloud-computer plugin. A1 skeleton exists (`package.json`, `index.js`, `client.js`, `lib/`, `locale/`, `test/`); the bot layer itself is not built yet.
- `packages/dsh-rayrun-bots/` — the whole product layer: bot roster, bot↔session mapping, persistent host, approvals, routines, client panel, and the adapter to the cloud-computer plugin. The package loads (health route + v0.1 client shell). The bot layer itself — roster, sessions, remote approvals, persistence — is not built yet.
- `dsh-rayrun-computer` — **a separate project** (`RayrunOS/dsh-rayrun-computer`, MIT), not a directory in this repo. It provides the cloud computers and the `rayrun_*` tools; Rayrun Bot consumes it as a dependency. Never modify, fork or vendor it here.
- `package.json` — private workspace root. No dependencies, no build step.

Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ There is no build step. Each package carries plain-Node checks under its own
- `node packages/dsh-rayrun-bots/test/manifest-check.mjs`
- `node packages/dsh-rayrun-bots/test/locale-audit.mjs`
- `node packages/dsh-rayrun-bots/test/rpc-contract.mjs`
- `node packages/dsh-rayrun-bots/test/client-contract.mjs`

The same checks run in CI (`.github/workflows/checks.yml`) on push and pull
requests. Live integration tests need real Rayrun credentials and never run in
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ English | [简体中文](README.zh-CN.md)

Rayrun Bot gives the bots in [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) a name, a body and a home. A bot is not a chat session: it has a name, instructions, memory and a schedule, and it lives on your own [Rayrun](https://rayrunos.com/) cloud computer — a Linux machine you can watch and take over — while thinking with your own DeepSeek API key. Nothing is hosted by us: the compute is on your Rayrun account, the model bill is yours, and the approval prompt is the contract. This repository is where that product is built.

> **Status (November 2026).** Pre-alpha. The cloud-computer plugin this project builds on is a separate project at [RayrunOS/dsh-rayrun-computer](https://github.com/RayrunOS/dsh-rayrun-computer); Rayrun Bot adds the bot layer on top of it, and that layer is what this repository is building. The first package skeleton (`packages/dsh-rayrun-bots`) now loads as a bundle, but there is no bot layer or release yet.
> **Status (November 2026).** Pre-alpha. The cloud-computer plugin this project builds on is a separate project at [RayrunOS/dsh-rayrun-computer](https://github.com/RayrunOS/dsh-rayrun-computer); Rayrun Bot adds the bot layer on top of it, and that layer is what this repository is building. `packages/dsh-rayrun-bots` loads as a bundle. Its client half renders the v0.1 shell (chat list, conversation, details, new bot, setup, settings) as an in-memory preview. The host half still only answers a health check. There is no persisted roster, no remote approvals, and no release yet.

## How it works

Expand Down Expand Up @@ -118,7 +118,7 @@ Rayrun Bot/
├── package.json # private workspace root
├── docs/ # design docs, plans, platform asks
└── packages/
└── dsh-rayrun-bots/ # A1 skeleton: host/client halves, locale, tests
└── dsh-rayrun-bots/ # health route + v0.1 client shell, locale, tests
```

The cloud-computer plugin (`dsh-rayrun-computer`) is not in this tree: it is a **separate project**, consumed as a dependency. Two plugins in the same DSH profile, one product. The repository and product are called **Rayrun Bot**; the packages keep the `dsh-` prefix that the DSH ecosystem uses. The README is the product page; `docs/` holds the detail. Deeper reads: [quick start](docs/quickstart.md), [architecture](docs/architecture.md), [security](docs/security.md), [FAQ](docs/faq.md), [roadmap](docs/roadmap.md), [Grok Bot inspiration](docs/inspiration.md), [MVP plan](docs/mvp-plan.md), [client plan](docs/client-plan.md), [UI design](docs/ui-design.md), [bot persona](docs/bot-persona.md), [local file design](docs/local-file-design.md), [platform asks](docs/platform-asks.md). Both READMEs are updated in the same commit — English is the source of truth.
Expand All @@ -133,7 +133,7 @@ dsh plugin --profile web add /absolute/path/to/package
# restart DSH afterwards; the page loads the new client half on start
```

- Checks: `node --check packages/dsh-rayrun-bots/index.js`, `node packages/dsh-rayrun-bots/test/manifest-check.mjs`, `node packages/dsh-rayrun-bots/test/locale-audit.mjs`, `node packages/dsh-rayrun-bots/test/rpc-contract.mjs`; the same checks run in CI on push and pull requests (`.github/workflows/checks.yml`).
- Checks: `node --check` on `packages/dsh-rayrun-bots/index.js` and `client.js`, then `node packages/dsh-rayrun-bots/test/manifest-check.mjs`, `locale-audit.mjs`, `rpc-contract.mjs`, and `client-contract.mjs`; the same checks run in CI on push and pull requests (`.github/workflows/checks.yml`).
- Live integration tests need real Rayrun credentials and never run in CI.
- Read [`CLAUDE.md`](CLAUDE.md) and [`CONTRIBUTING.md`](CONTRIBUTING.md) before changing anything. Commit messages are in English with `feat:`, `fix:`, `chore:` or `docs:` prefixes.

Expand All @@ -144,8 +144,8 @@ dsh plugin --profile web add /absolute/path/to/package
| | |
| --- | --- |
| **Works today** (separate project, our dependency) | Seven `rayrun_*` tools, noVNC desktop, per-session cloud/local routing, hash-verified workspace sync, task delegation, worker projection, optional idle stop. Verified on DeepSeek Harness `0.2.1-rc.5`. |
| **This repository** | The repo itself: README, docs, issue and PR templates, agent rules, the dependency boundary, and the `dsh-rayrun-bots` A1 skeleton (placeholder page + health route) with plain-Node checks and a checks-only CI workflow. No bot features and no publishable release yet. |
| **Not built yet** | Bot roster and bot↔session mapping, a persistent DSH host on the machine, remote approvals, routines and triggers, cost bar, IM channel, the two-plugin install path (dependency declaration and version check), npm packages and the release/publish CI path. |
| **This repository** | README, docs, issue and PR templates, agent rules, the dependency boundary, and `dsh-rayrun-bots`: a health route plus the v0.1 client shell (five screens, in-memory preview), with plain-Node checks and a checks-only CI workflow. No persisted bot layer and no publishable release yet. |
| **Not built yet** | Bot roster and bot↔session mapping, a persistent DSH host on the machine, remote approvals that gate a worker, routines that actually run, live usage from the account, IM channel, the two-plugin install path (dependency declaration and version check), npm packages and the release/publish CI path. |
| **Platform gaps** | Safe inbound networking (today the token ingress is unusable and only `public` works), idle auto-stop, a spend cap, the session-resume contract. The full list is in [docs/architecture.md](docs/architecture.md). |

**v0.1 path** — install from npm → sign in → create a bot → approve its first gated action. Exit criteria are in [docs/roadmap.md](docs/roadmap.md).
Expand Down
10 changes: 5 additions & 5 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Rayrun Bot 给 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) 里的 Bot 一个名字、一副身体和一个家。Bot 不是聊天会话:它有名字、指令、记忆和日程,住在你自己的 [Rayrun](https://rayrunos.com/) 云电脑上——一台你能看见、也能接管的 Linux 机器——并用你自己的 DeepSeek API key 思考。没有我们托管的东西:算力记在你自己 Rayrun 账号上,模型账单是你的,审批提示就是约定。本仓库就是把这个产品造出来的地方。

> **状态(2026 年 11 月)。** Pre-alpha。本项目赖以构建的云电脑插件是一个独立项目,在 [RayrunOS/dsh-rayrun-computer](https://github.com/RayrunOS/dsh-rayrun-computer) 单独维护;Rayrun Bot 在它之上加 Bot 层,本仓库造的就是这一层。第一个包骨架(`packages/dsh-rayrun-bots`)已经能作为 bundle 加载,但还没有 Bot 层,也没有可发布的版本。
> **状态(2026 年 11 月)。** Pre-alpha。本项目赖以构建的云电脑插件是一个独立项目,在 [RayrunOS/dsh-rayrun-computer](https://github.com/RayrunOS/dsh-rayrun-computer) 单独维护;Rayrun Bot 在它之上加 Bot 层,本仓库造的就是这一层。`packages/dsh-rayrun-bots` 已经能作为 bundle 加载。它的 Client 半区画出了 v0.1 界面(聊天列表、对话、详情、新建 Bot、设置向导、设置页),数据只存在这一页的内存里。Host 半区仍然只回答一次 health 检查。没有持久化的名册,没有远程审批,也没有可发布的版本。

## 工作原理

Expand Down Expand Up @@ -118,7 +118,7 @@ Rayrun Bot/
├── package.json # 私有 workspace 根
├── docs/ # 设计文档、计划、平台需求
└── packages/
└── dsh-rayrun-bots/ # A1 骨架:host/client 两半、locale、测试
└── dsh-rayrun-bots/ # health 路由 + v0.1 客户端界面、locale、测试
```

云电脑插件(`dsh-rayrun-computer`)不在这个树里:它是**独立项目**,作为依赖被复用——同一个 DSH profile 里两个插件,一个产品。仓库和产品都叫 **Rayrun Bot**;插件包保留 `dsh-` 前缀,这是 DSH 插件生态的命名习惯。README 是产品页,细节在 `docs/`。深入阅读:[快速开始](docs/quickstart.md)、[架构](docs/architecture.md)、[安全](docs/security.md)、[FAQ](docs/faq.md)、[路线图](docs/roadmap.md)、[Grok Bot 灵感](docs/inspiration.md)、[MVP 计划](docs/mvp-plan.md)、[客户端计划](docs/client-plan.md)、[界面设计](docs/ui-design.md)、[Bot 人格](docs/bot-persona.md)、[本地文件设计](docs/local-file-design.md)、[平台需求](docs/platform-asks.md)。两份 README 必须在同一个 commit 里更新——英文版为准。
Expand All @@ -133,7 +133,7 @@ dsh plugin --profile web add /absolute/path/to/package
# 之后重启 DSH;页面启动时会加载新的 Client 半区
```

- 检查:`node --check packages/dsh-rayrun-bots/index.js`、`node packages/dsh-rayrun-bots/test/manifest-check.mjs`、`node packages/dsh-rayrun-bots/test/locale-audit.mjs`、`node packages/dsh-rayrun-bots/test/rpc-contract.mjs`;同一组检查在 CI 里对 push 和 pull request 运行(`.github/workflows/checks.yml`)。
- 检查:对 `packages/dsh-rayrun-bots/index.js` 和 `client.js` 做 `node --check`,然后跑 `node packages/dsh-rayrun-bots/test/manifest-check.mjs`、`locale-audit.mjs`、`rpc-contract.mjs` 和 `client-contract.mjs`;同一组检查在 CI 里对 push 和 pull request 运行(`.github/workflows/checks.yml`)。
- 实时集成测试需要真实 Rayrun 凭据,永远不在 CI 里跑。
- 改任何东西之前先读 [`CLAUDE.md`](CLAUDE.md) 和 [`CONTRIBUTING.md`](CONTRIBUTING.md)。提交信息用英文,前缀 `feat:`、`fix:`、`chore:`、`docs:`。

Expand All @@ -144,8 +144,8 @@ dsh plugin --profile web add /absolute/path/to/package
| | |
| --- | --- |
| **今天可用**(独立项目,我们的依赖) | 7 个 `rayrun_*` 工具、noVNC 桌面、按会话的云/本地路由、双端哈希校验的 workspace 同步、任务委托、worker 投影、可选空闲停机。已在 DeepSeek Harness `0.2.1-rc.5` 上验证。 |
| **本仓库** | 仓库本身:README、docs、issue/PR 模板、agent 规则、依赖边界,以及 `dsh-rayrun-bots` 的 A1 骨架(占位页 + health 路由),带普通 Node 检查与只跑检查的 CI workflow。还没有 Bot 功能,也没有可发布版本。 |
| **尚未构建** | Bot 名册与 Bot↔session 映射、机器上的常驻 DSH host、远程审批、routines 与触发器、成本条、IM 通道、两插件安装路径(依赖声明与版本检查)、npm 包以及发布用的 CI 路径。 |
| **本仓库** | README、docs、issue/PR 模板、agent 规则、依赖边界,以及 `dsh-rayrun-bots`:一条 health 路由加上 v0.1 客户端界面(五个画面,内存里的预览),带普通 Node 检查与只跑检查的 CI workflow。还没有持久化的 Bot 层,也没有可发布版本。 |
| **尚未构建** | Bot 名册与 Bot↔session 映射、机器上的常驻 DSH host、能拦住 worker 的远程审批、真正会跑的 routines 与触发器、来自账号的实时用量、IM 通道、两插件安装路径(依赖声明与版本检查)、npm 包以及发布用的 CI 路径。 |
| **平台缺口** | 安全入向网络(今天 token ingress 不可用,只有 `public` 能用)、空闲自动停、spend cap、session 续跑契约。完整清单在 [docs/architecture.md](docs/architecture.md)。 |

**v0.1 路径**——从 npm 安装 → 登录 → 创建一个 Bot → 批准它的第一个受限动作。验收标准在 [docs/roadmap.md](docs/roadmap.md)。
Expand Down
14 changes: 9 additions & 5 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Quickstart

*Status: 2026-11-13. Two separate projects. This repository is pre-alpha: it
holds docs, repository scaffolding and the `dsh-rayrun-bots` A1 skeleton, no
publishable code yet. The cloud-computer plugin at
*Status: 2026-11-16. Two separate projects. This repository is pre-alpha: it
holds docs, repository scaffolding, and `dsh-rayrun-bots` — a health route and
the v0.1 client shell. The shell is an in-memory preview. There is no
publishable release yet. The cloud-computer plugin at
[RayrunOS/dsh-rayrun-computer](https://github.com/RayrunOS/dsh-rayrun-computer)
is untouched and stays its own project; this repository builds the bot layer and
reuses that plugin as an external dependency — two plugins in one DSH profile.*
Expand Down Expand Up @@ -80,15 +81,18 @@ When the bot half lands, the first-run path should be:
4. Talk to it, or let a routine wake it up while you are away.
5. Approve its first gated action from the panel.

None of steps 1–5 exist yet in this repository. See
Installing this package and opening **Bots** shows the v0.1 shell. The roster,
the approval card, and the setup wizard on that page are in-memory preview
state: creating a bot does not put it on a cloud computer, and Allow once does
not send anything. Steps 2–5 do not reach Rayrun yet. See
[roadmap.md](roadmap.md) for what each milestone needs.

## What works today vs what is still missing

| | |
| --- | --- |
| **Works today** (separate project) | the seven tools, noVNC desktop, per-session cloud/local routing, hash-verified workspace sync, task delegation, worker projection, optional idle stop; verified on DSH `0.2.1-rc.5` |
| **This repository** | README, docs, issue/PR templates, agent rules, and the `dsh-rayrun-bots` A1 skeleton with plain-Node checks and a checks-only CI workflow. No publishable code. |
| **This repository** | README, docs, issue/PR templates, agent rules, and `dsh-rayrun-bots`: a health route plus the v0.1 client shell (in-memory preview), with plain-Node checks and a checks-only CI workflow. No publishable release. |
| **Planned, unverified** | two-plugin install: the Rayrun Bot bundle declares `dsh-rayrun-computer` as a dependency so one install loads both host and client halves (W0 spike S6) |
| **Not built yet** | bot roster and bot↔session mapping, a persistent DSH host on the machine, remote approvals, routines and triggers, cost bar, IM channel, npm packages and the release/publish CI path |
| **Blocked on the Rayrun platform** | safe inbound networking (the token ingress is unusable today and only `public` works), idle auto-stop, a spend cap, the session-resume contract |
Expand Down
22 changes: 14 additions & 8 deletions packages/dsh-rayrun-bots/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
# dsh-rayrun-bots

The Rayrun Bot plugin package. Status: **A1 skeleton** — the bundle loads, the
client half adds a "Bots" entry with a placeholder page, and the host half answers
one health action. There is no bot layer yet.
The Rayrun Bot plugin package. Status: **client shell** — the bundle loads, the
client half renders the v0.1 screens, and the host half answers one health
action. The screens are an in-memory preview. There is no bot layer yet.

## What it does today

- Host half: `GET /plugins/rayrun-bots?action=health` returns
`{ ok: true, plugin: "rayrun-bots", version, ready: false }`. `POST` is
same-origin gated: a browser `Origin` that does not match the request `Host`
is refused with 403. No credentials are touched.
- Client half: a `Bots` sidebar entry and a placeholder page. It does not call
the host yet.
- Client half: a `Bots` sidebar entry and the three-column shell from
[docs/ui-design.md](../../docs/ui-design.md) — chat list, conversation,
details (Activity / Library), new bot, the four-step setup wizard, and
settings. Sample bots, messages, receipts, and the approval card live in the
page only. Deny / Allow once, creating a bot, the wizard, and settings update
that in-memory state. The page does not call the host, and it does not keep a
Rayrun token or a DeepSeek key.

Not built yet: bot roster, chat list, conversation, details panel, approvals,
routines, the adapter to `dsh-rayrun-computer`, and the npm release path. See the
Not built yet: a real bot roster, bot↔session mapping, remote approvals, routines
that run, the adapter to `dsh-rayrun-computer`, and the npm release path. See the
repo-level [MVP plan](../../docs/mvp-plan.md) and [client plan](../../docs/client-plan.md).

## Install from a checkout
Expand All @@ -39,6 +44,7 @@ node --check client.js
node test/manifest-check.mjs
node test/locale-audit.mjs
node test/rpc-contract.mjs
node test/client-contract.mjs
```

The same commands run in the repository's checks-only CI workflow on push and
Expand All @@ -51,7 +57,7 @@ Live integration tests need real Rayrun credentials and never run in CI.
package.json # name, exports, dsh.bundle + dsh.client
cordis.patch.yml # the bundle row (id rayrun-bots -> package dsh-rayrun-bots)
index.js # host half: same-origin RPC route, health action only
client.js # client half: sidebar "Bots" + placeholder page
client.js # client half: v0.1 shell (in-memory preview)
lib/errors.js # stable error codes (shared with docs/mvp-plan.md §4.3)
lib/rpc.js # JSON responses and request-body parsing
locale/en.json # source copy
Expand Down
Loading
Loading