From f134e88c333218192d3b595d8f771ba1ec5ee296 Mon Sep 17 00:00:00 2001 From: Yang YiHe <108562510+nmhjklnm@users.noreply.github.com> Date: Sun, 25 Jan 2026 04:42:59 +0800 Subject: [PATCH] docs: migrate to cue-stack monorepo --- README.md | 115 +++++------------------------------------------- README.zh-CN.md | 97 +++++----------------------------------- 2 files changed, 20 insertions(+), 192 deletions(-) diff --git a/README.md b/README.md index 75971a4..025a91b 100644 --- a/README.md +++ b/README.md @@ -1,120 +1,25 @@ # cueme -
+## ⚠️ Repository migrated -English - · -中文 +This repository has been merged into the **CueStack** monorepo. -
- ---- - -[![npm](https://img.shields.io/npm/v/cueme?label=cueme&color=0B7285)](https://www.npmjs.com/package/cueme) -[![npm downloads](https://img.shields.io/npm/dm/cueme?color=0B7285)](https://www.npmjs.com/package/cueme) - -[![Repo: cue-stack](https://img.shields.io/badge/repo-cue--stack-111827)](https://github.com/nmhjklnm/cue-stack) -[![Repo: cue-console](https://img.shields.io/badge/repo-cue--console-111827)](https://github.com/nmhjklnm/cue-console) -[![Repo: cue-command](https://img.shields.io/badge/repo-cue--command-111827)](https://github.com/nmhjklnm/cue-command) -![License](https://img.shields.io/badge/license-Apache--2.0-1E40AF) - -[Contributing](./CONTRIBUTING.md) · [Trademark](./TRADEMARK.md) - -A command protocol adapter for Cue, compatible with the existing SQLite mailbox (`~/.cue/cue.db`). - -Note: image sending is currently unavailable (WIP). - -## Quick start (3 steps) - -### Step 1: Install cueme +- **New source location**: +- **Installation (unchanged)**: ```bash npm install -g cueme ``` -### Step 2: Configure the protocol.md as your system prompt - -Copy the contents of `protocol.md` into your runtime's system prompt / persistent rules: - -- [`protocol.md`](https://github.com/nmhjklnm/cue-command/blob/main/protocol.md) - -If you installed via npm, `protocol.md` is also included in the package. - -This file defines the Human Agent Protocol (HAP) rules and the `cueme` command interface. - -### Step 3: Run the UI and connect - -`cueme` speaks to the same SQLite mailbox used by the UI (`~/.cue/cue.db`). Start the UI: - -```bash -npm install -g cue-console -cue-console start -``` - -Open `http://localhost:3000`, then in your runtime chat type: - -`cue` - -## Usage - -### join - -```bash -cueme join -``` - -### recall - -```bash -cueme recall -``` - -### cue - -```bash -cueme cue - -``` - -### pause - -```bash -cueme pause - -``` - -You can also provide the prompt as a positional argument: - -```bash -cueme pause "Paused. Click Continue when you are ready." -``` - -### proto - -Example (macOS + Windsurf): - -```bash -cueme proto apply windsurf -``` - -For detailed `proto` usage (config, init, render, markers), see: - -- [`docs/proto.md`](./docs/proto.md) +--- -All commands output plain text to stdout. +## ⚠️ 仓库已迁移 -### fix (Claude Code permissions) +本仓库已合并至 **CueStack** monorepo。 -If Claude Code asks for confirmation on every `cueme` command, run: +- **新源码地址**: +- **安装方式不变**: ```bash -cueme fix claude_permissions +npm install -g cueme ``` - -This adds `Bash` to `~/.claude/settings.json`. - ---- - -## QQ Group - -

- QQ group QR code -

diff --git a/README.zh-CN.md b/README.zh-CN.md index eff3705..5e169f1 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,102 +1,25 @@ # cueme -
+## ⚠️ 仓库已迁移 -English - · -中文 +本仓库已合并至 **CueStack** monorepo。 -
- ---- - -[![npm](https://img.shields.io/npm/v/cueme?label=cueme&color=0B7285)](https://www.npmjs.com/package/cueme) -[![npm downloads](https://img.shields.io/npm/dm/cueme?color=0B7285)](https://www.npmjs.com/package/cueme) - -[![Repo: cue-stack](https://img.shields.io/badge/repo-cue--stack-111827)](https://github.com/nmhjklnm/cue-stack) -[![Repo: cue-console](https://img.shields.io/badge/repo-cue--console-111827)](https://github.com/nmhjklnm/cue-console) -[![Repo: cue-command](https://img.shields.io/badge/repo-cue--command-111827)](https://github.com/nmhjklnm/cue-command) -![License](https://img.shields.io/badge/license-Apache--2.0-1E40AF) - -[Contributing](./CONTRIBUTING.md) · [Trademark](./TRADEMARK.md) - -这是 Cue 的命令行协议适配器，兼容现有的 SQLite mailbox（`~/.cue/cue.db`）。 - -提示：发送图片功能暂不可用（开发中）。 - -## 快速开始（2 步） - -### 第 1 步：安装 cueme +- **新源码地址**: +- **安装方式不变**: ```bash npm install -g cueme ``` -### 第 2 步：把 protocol.md 配置到你的系统提示词里 - -把 `protocol.md` 的内容复制到你正在使用的 runtime 的系统提示词 / 持久规则里： - -- [`protocol.md`](https://github.com/nmhjklnm/cue-command/blob/main/protocol.md) - -如果你是通过 npm 安装的，`protocol.md` 也会包含在安装包里。 - -该文件定义了 Human Agent Protocol（HAP）规则，以及 `cueme` 的命令接口。 - -### 第 3 步：启动 UI 并连接 - -`cueme` 会与 UI 共用同一个 SQLite mailbox（`~/.cue/cue.db`）。先启动 UI： - -```bash -npm install -g cue-console -cue-console start -``` - -打开 `http://localhost:3000`，然后在你的 runtime 聊天里输入： - -`cue` - -## 用法 - -### join - -```bash -cueme join -``` - -### recall - -```bash -cueme recall -``` - -### cue - -```bash -cueme cue - -``` - -### pause - -```bash -cueme pause - -``` +--- -所有命令都以纯文本输出到 stdout。 +## ⚠️ Repository migrated -### fix（Claude Code 权限） +This repository has been merged into the **CueStack** monorepo. -如果 Claude Code 每次执行 `cueme` 都要确认，运行： +- **New source location**: +- **Installation (unchanged)**: ```bash -cueme fix claude_permissions +npm install -g cueme ``` - -它会把 `Bash` 写入 `~/.claude/settings.json`。 - ---- - -## QQ 群 - -

- QQ 群二维码 -