Skip to content
Merged
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
115 changes: 10 additions & 105 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,120 +1,25 @@
# cueme

<div align="center">
## ⚠️ Repository migrated

<strong><a href="./README.md">English</a></strong>
·
<strong><a href="./README.zh-CN.md">中文</a></strong>
This repository has been merged into the **CueStack** monorepo.

</div>

---

[![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**: <https://github.com/nmhjklnm/cue-stack/tree/main/cue-command>
- **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 <agent_runtime>
```

### recall

```bash
cueme recall <hints>
```

### cue

```bash
cueme cue <agent_id> -
```

### pause

```bash
cueme pause <agent_id> -
```

You can also provide the prompt as a positional argument:

```bash
cueme pause <agent_id> "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:
- **新源码地址**: <https://github.com/nmhjklnm/cue-stack/tree/main/cue-command>
- **安装方式不变**:

```bash
cueme fix claude_permissions
npm install -g cueme
```

This adds `Bash` to `~/.claude/settings.json`.

---

## QQ Group

<p align="center">
<img src="./assets/qq.jpg" alt="QQ group QR code" width="25%" />
</p>
97 changes: 10 additions & 87 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,102 +1,25 @@
# cueme

<div align="center">
## ⚠️ 仓库已迁移

<strong><a href="./README.md">English</a></strong>
·
<strong><a href="./README.zh-CN.md">中文</a></strong>
本仓库已合并至 **CueStack** monorepo。

</div>

---

[![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
- **新源码地址**: <https://github.com/nmhjklnm/cue-stack/tree/main/cue-command>
- **安装方式不变**:

```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 <agent_runtime>
```

### recall

```bash
cueme recall <hints>
```

### cue

```bash
cueme cue <agent_id> -
```

### pause

```bash
cueme pause <agent_id> -
```
---

所有命令都以纯文本输出到 stdout。
## ⚠️ Repository migrated

### fix(Claude Code 权限)
This repository has been merged into the **CueStack** monorepo.

如果 Claude Code 每次执行 `cueme` 都要确认,运行:
- **New source location**: <https://github.com/nmhjklnm/cue-stack/tree/main/cue-command>
- **Installation (unchanged)**:

```bash
cueme fix claude_permissions
npm install -g cueme
```

它会把 `Bash` 写入 `~/.claude/settings.json`。

---

## QQ 群

<p align="center">
<img src="./assets/qq.jpg" alt="QQ 群二维码" width="25%" />
</p>