From b15fdd2b3feb4a3f56efa70ffbdd7394b5f43d15 Mon Sep 17 00:00:00 2001 From: lc <284264018@qq.com> Date: Tue, 1 Sep 2026 11:22:27 +0800 Subject: [PATCH] docs: add terminal usage guides --- docs/cn/meta.json | 2 + docs/cn/reference/meta.json | 2 +- docs/cn/{reference => terminal}/cli.mdx | 6 +- docs/cn/terminal/meta.json | 5 + docs/cn/terminal/tui.mdx | 289 +++++++++++++++++++++++ docs/en/meta.json | 2 + docs/en/reference/meta.json | 2 +- docs/en/{reference => terminal}/cli.mdx | 6 +- docs/en/terminal/meta.json | 5 + docs/en/terminal/tui.mdx | 292 ++++++++++++++++++++++++ 10 files changed, 603 insertions(+), 8 deletions(-) rename docs/cn/{reference => terminal}/cli.mdx (69%) create mode 100644 docs/cn/terminal/meta.json create mode 100644 docs/cn/terminal/tui.mdx rename docs/en/{reference => terminal}/cli.mdx (68%) create mode 100644 docs/en/terminal/meta.json create mode 100644 docs/en/terminal/tui.mdx diff --git a/docs/cn/meta.json b/docs/cn/meta.json index a3e0e9b89..941399ba3 100644 --- a/docs/cn/meta.json +++ b/docs/cn/meta.json @@ -6,6 +6,8 @@ "...start", "---[Monitor]桌面端---", "...desktop", + "---[Terminal]终端---", + "...terminal", "---[Brain]记忆---", "...memory", "---[MessageSquare]渠道---", diff --git a/docs/cn/reference/meta.json b/docs/cn/reference/meta.json index 2c1267b56..839fef3da 100644 --- a/docs/cn/reference/meta.json +++ b/docs/cn/reference/meta.json @@ -1,5 +1,5 @@ { "title": "参考", "icon": "Library", - "pages": ["cli", "openai-api", "memory-api", "local-api", "ports"] + "pages": ["openai-api", "memory-api", "local-api", "ports"] } diff --git a/docs/cn/reference/cli.mdx b/docs/cn/terminal/cli.mdx similarity index 69% rename from docs/cn/reference/cli.mdx rename to docs/cn/terminal/cli.mdx index ba8c21415..32e60578a 100644 --- a/docs/cn/reference/cli.mdx +++ b/docs/cn/terminal/cli.mdx @@ -1,13 +1,13 @@ --- -title: memmy CLI +title: CLI 命令参考 icon: Terminal --- | 命令 | 说明 | | --- | --- | | `memmy` | 进入交互式聊天 | -| `memmy onboard` | 初始化配置和 workspace | -| `memmy onboard --wizard` | 终端菜单式配置 | +| `memmy onboard` | 终端菜单式配置 | +| `memmy onboard --defaults` | 非交互式初始化配置和 workspace | | `memmy status` | 查看配置、workspace、模型和 Provider 状态 | | `memmy agent --message "..."` | 发送单轮消息 | | `memmy serve` | 启动 OpenAI 兼容 API | diff --git a/docs/cn/terminal/meta.json b/docs/cn/terminal/meta.json new file mode 100644 index 000000000..d87a25fb0 --- /dev/null +++ b/docs/cn/terminal/meta.json @@ -0,0 +1,5 @@ +{ + "title": "终端", + "icon": "Terminal", + "pages": ["tui", "cli"] +} diff --git a/docs/cn/terminal/tui.mdx b/docs/cn/terminal/tui.mdx new file mode 100644 index 000000000..24f185ab6 --- /dev/null +++ b/docs/cn/terminal/tui.mdx @@ -0,0 +1,289 @@ +--- +title: TUI 使用指南 +icon: Terminal +--- + +Memmy TUI 是 Memmy 的全屏终端界面。安装桌面端，或只安装 CLI，都可以在终端执行 `memmy` 使用它。 + +![image.png](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/3BMqYy5xagvDGqwZ/img/ed3cfb80-ad6a-4403-afa4-03e6ea01ee68.png) + +## 一、安装 Memmy TUI + +### 方式一：安装 Memmy 桌面端 + +适用于 macOS 和 Windows。桌面端会提供 `memmy` 命令，并负责启动本地 Memory 和 Agent Gateway。 + +1. 从 [Memmy 官网](https://memmy.cn/) 或 [GitHub Releases](https://github.com/MemTensor/memmy-agent/releases) 下载并安装桌面端。 + +2. 启动 Memmy，完成账号模式或 API Key 模式配置。 + +3. 打开一个新的终端，检查命令是否可用： + +```plaintext +memmy --help +memmy --version +``` + +- macOS 用户需要先把应用拖入 `/Applications`，并至少启动一次。若终端提示找不到 `memmy`，打开新终端或执行： + +```plaintext +source ~/.zshrc +``` + +- Windows 用户安装完成后，请打开新的 PowerShell 或 Windows Terminal。 + +使用桌面端提供的 TUI 时，请保持 Memmy 桌面端运行。关闭桌面端后，它管理的 Gateway 也会停止。 + +### 方式二：只安装 Memmy CLI + +适用于不需要桌面端的 Linux x64 或 arm64 环境。需要 Node.js `22` 或更高版本，并且系统支持 `systemd --user`。 + +```plaintext +curl -fsSL https://raw.githubusercontent.com/MemTensor/memmy-agent/main/scripts/install.sh | bash +``` + +安装完成后执行： + +```plaintext +memmy +``` + +首次运行如果还没有可用模型，Memmy 会打开配置向导。CLI 安装器会管理 Memory 和 Gateway 服务；退出 TUI 或关闭终端后，服务仍会运行。 + +查看服务状态： + +```plaintext +systemctl --user status memmy-memory.service +systemctl --user status memmy-gateway.service +``` + +## 二、首次配置 + +如果桌面端已经完成首次引导，可以跳过本节。CLI 用户建议执行： + +```plaintext +memmy onboard --defaults +memmy onboard +memmy status +``` + +- `memmy onboard --defaults`：创建或刷新配置文件和 workspace，非交互式配置。 + +- `memmy onboard`：配置模型、Provider、Gateway、Memory 和工具，交互式配置。 + +- `memmy status`：检查当前配置、workspace、模型和 Provider。 + +默认位置： + +- 配置文件：`~/.memmy/config.yaml` + +- workspace：`~/.memmy/workspace` + +## 三、打开 TUI + +直接执行： + +```plaintext +memmy +``` + +这会打开默认的 `cli:direct` 会话。输入消息后按 `Enter` 发送。 + +### 恢复或创建会话 + +```plaintext +# 恢复已有会话 +memmy --session cli:work +# 创建新的独立会话 +memmy --standalone +# 创建绑定到项目目录的会话 +memmy --project /path/to/project +``` + +`--session`、`--standalone` 和 `--project` 只能选择一个。 + +查看已有会话： + +```plaintext +memmy sessions list +``` + +### `memmy` 与 `memmy agent` + +要打开本教程介绍的全屏 TUI，请使用裸 `memmy`。 + +`memmy agent` 适合单轮任务或传统终端交互： + +```plaintext +# 单轮任务 +memmy agent --message "介绍一下当前工作区" +# 从标准输入发送一轮任务 +echo "总结这个项目" | memmy agent +``` + +## 四、发送任务 + +在 `❯` 后面输入内容，按 `Enter` 发送。TUI 当前没有桌面端工作台的 `Shift + Enter` 换行操作，`Enter` 始终表示提交。 + +长文本可以在终端中自动视觉换行，但不会插入多行内容。需要发送多行文本时，请使用： + +```plaintext +memmy agent --message $'第一行\n第二行' +``` + +或： + +```plaintext +printf '第一行\n第二行\n' | memmy agent +``` + +### 任务运行时继续输入 + +- `Enter`：排队发送下一轮任务。 + +- `Tab`：当当前回合由这个 TUI 执行时，把内容追加到当前回合。 + +如果当前回合来自桌面端或其他 IM 渠道，TUI 不会接管它；请使用 `Enter` 排队。 + +队列中有任务时，界面会显示排队数量、消息预览和消息来源。 + +## 五、键盘操作 + +基础操作在 macOS、Windows 和 Linux 上一致；行编辑组合键的主修饰键不同： + +| **操作** | **macOS** | **Windows** | **Linux** | +| --- | --- | --- | --- | +| 发送；运行中排队下一轮 | `Enter` | `Enter` | `Enter` | +| 追加到当前由 TUI 执行的回合 | `Tab` | `Tab` | `Tab` | +| 移动一个字符 | `←` / `→` | `←` / `→` | `←` / `→` | +| 按单词移动 | `⌘ + ←` / `⌘ + →` | `Ctrl + ←` / `Ctrl + →` | `Ctrl + ←` / `Ctrl + →` | +| 移到输入开头 | `Home` 或 `Ctrl + A` | `Home` 或 `Ctrl + A` | `Home` 或 `Ctrl + A` | +| 移到输入末尾 | `End`、`Ctrl + E` 或 `⌘ + E` | `End` 或 `Ctrl + E` | `End` 或 `Ctrl + E` | +| 删除光标前内容至行首 | `Ctrl + U` 或 `⌘ + U`；`⌘ + Backspace` / `⌘ + Delete` | `Ctrl + U` | `Ctrl + U` | +| 删除光标后内容至行尾 | `Ctrl + K` 或 `⌘ + K` | `Ctrl + K` | `Ctrl + K` | +| 删除前一个单词 | `Ctrl + W` 或 `⌘ + W` | `Ctrl + W` / `Ctrl + Backspace` | `Ctrl + W` / `Ctrl + Backspace` | +| 删除字符 | `Backspace` / `Delete` | `Backspace` / `Delete` | `Backspace` / `Delete` | +| 停止自己执行的回合并退出 | `Ctrl + C` | `Ctrl + C` | `Ctrl + C` | + +在 macOS 上，`⌘` 是 Command 键；Windows/Linux 使用 `Ctrl` 作为主要组合键。`Shift + Enter` 在所有平台上都不会插入换行，而是提交当前消息。 + +也可以输入以下任意命令退出： + +```plaintext +exit +quit +/exit +/quit +:q +``` + +如果任务由其他渠道执行，`Ctrl + C` 只会退出当前 TUI，不会停止其他渠道的任务。 + +## 六、Slash 命令 + +![Slash 命令菜单](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/3BMqYy5xagvDGqwZ/img/62ea1bed-2894-42ef-826c-18b68447798e.png) + +TUI 支持 Slash 命令候选菜单。在输入区输入 `/` 即可打开菜单，继续输入命令名称（例如 `/go`）会筛选候选命令。输入空格进入参数或子命令后，候选菜单会关闭。 + +- `↑` / `↓`：切换候选命令。 + +- `Tab`：补全当前选中的命令入口，不会补全子命令或参数。 + +- `Enter`：如果当前输入是命令前缀，先确认补全；命令入口已经完整时执行命令。 + +- `Esc`：关闭候选菜单。 + +如果 `Enter` 只是完成了命令补全，再按一次 `Enter` 即可执行。 + +- 候选菜单显示当前可用的命令，以及该命令提供的参数或子命令提示。 + +- 参数和子命令不会分别生成候选项，例如 `/model list` 可以先补全 `/model`，再手动输入 `list`。 + +- `/stop` 只有在当前回合由该 TUI 执行时才显示。 + +- `/restart` 不显示，也不能在 TUI 中执行。 + +- `exit`、`quit`、`/exit`、`/quit`、`:q` 可以退出，但只有 `/quit` 出现在菜单中。 + +- `/history-dag` 和 `/dream*` 是否出现取决于对应功能是否启用。 + +- 初始最多显示 8 个候选项，可继续输入命令前缀筛选其他命令。 + +| **命令** | **参数** | **作用** | +| --- | --- | --- | +| `/help` | 无 | 查看当前命令帮助 | +| `/status` | 无 | 查看运行状态、Provider 和渠道状态 | +| `/model` | 无 | 查看当前模型配置 | +| `/model list` | 无 | 列出模型预设 | +| `/model ` | 模型预设名 | 切换模型预设，例如 `/model fast` | +| `/history` | 无 | 查看会话历史 | +| `/history ` | 消息数量 | 查看最近 `n` 条历史消息 | +| `/history-dag` | 无 | 查看会话历史 DAG | +| `/new` | 无 | 停止当前任务并开始新对话 | +| `/stop` | 无 | 停止当前由这个 TUI 执行的回合；不会停止其他渠道的任务 | +| `/restart` | 无 | TUI 不接受此控制命令；请退出后重启 Gateway | +| `/last-compaction` | 无 | 查看当前会话最近一次上下文压缩摘要 | +| `/quit` | 无 | 退出 TUI，不停止其他渠道正在执行的回合 | +| `/goal` | 无 | 查看当前持久目标 | +| `/goal status` | 无 | 查看持久目标状态 | +| `/goal help` | 无 | 查看 Goal 子命令帮助 | +| `/goal ` | 目标内容 | 创建持久目标的简写形式 | +| `/goal create ` | 目标内容 | 创建持久目标 | +| `/goal pause` | 无 | 暂停目标 | +| `/goal resume` | 无 | 恢复目标 | +| `/goal edit ` | 新目标内容 | 修改目标 | +| `/goal budget ` | 数字或 `none` | 设置或清除目标预算 | +| `/goal clear` | 无 | 清除目标 | +| `/dream` | 无 | 执行记忆整理 | +| `/dream-log` | 无 | 查看记忆整理记录 | +| `/dream-log ` | Dream 版本 SHA | 查看指定记忆整理版本的变更 | +| `/dream-restore` | 无 | 列出可恢复的记忆整理版本 | +| `/dream-restore ` | Dream 版本 SHA | 恢复到指定记忆整理版本 | +| `/pairing` | 无 | 查看或管理渠道配对 | +| `/pairing list` | 无 | 查看渠道配对请求 | +| `/pairing approve ` | 配对码 | 批准配对请求 | +| `/pairing deny ` | 配对码 | 拒绝配对请求 | +| `/pairing revoke ` | 用户 ID | 撤销用户配对 | + +`/history-dag`、`/dream*` 等命令是否可用，取决于对应功能是否在配置中启用。 + +## 七、常见问题 + +### `memmy: command not found` + +- macOS：确认 Memmy 已拖入 `/Applications` 并启动过一次，然后打开新终端或执行 `source ~/.zshrc`。 + +- Windows：打开新的 PowerShell 或 Windows Terminal。 + +- Linux：确认安装器执行成功，并检查 `~/.local/bin` 是否在 PATH 中。 + +### 没有可用模型 + +```plaintext +memmy onboard +memmy status +``` + +确认模型、Provider 和凭据已保存后，再执行 `memmy`。 + +### Gateway 不可用 + +- 使用桌面端：确认 Memmy 桌面端正在运行。 + +- 使用 Linux CLI：检查 `memmy-gateway.service`。 + +- 使用源码或手动运行的 CLI：在另一个终端执行 `memmy gateway`。 + +默认 Gateway WebSocket 端口是 `18980`。Linux 用户可以查看日志： + +```plaintext +journalctl --user -u memmy-gateway.service +``` + +### 为什么 `memmy agent` 没有打开全屏界面 + +这是正常的。`memmy agent` 是单轮或传统终端入口；需要全屏 TUI 时执行： + +```plaintext +memmy +``` diff --git a/docs/en/meta.json b/docs/en/meta.json index 4e0057d60..27e92b1d8 100644 --- a/docs/en/meta.json +++ b/docs/en/meta.json @@ -5,6 +5,8 @@ "...start", "---[Monitor]Desktop---", "...desktop", + "---[Terminal]Terminal---", + "...terminal", "---[Brain]Memory---", "...memory", "---[MessageSquare]Channels---", diff --git a/docs/en/reference/meta.json b/docs/en/reference/meta.json index c644a3733..30f1f937d 100644 --- a/docs/en/reference/meta.json +++ b/docs/en/reference/meta.json @@ -1,5 +1,5 @@ { "title": "Reference", "icon": "Library", - "pages": ["cli", "openai-api", "memory-api", "local-api", "ports"] + "pages": ["openai-api", "memory-api", "local-api", "ports"] } diff --git a/docs/en/reference/cli.mdx b/docs/en/terminal/cli.mdx similarity index 68% rename from docs/en/reference/cli.mdx rename to docs/en/terminal/cli.mdx index 974a18b6b..15d41a87c 100644 --- a/docs/en/reference/cli.mdx +++ b/docs/en/terminal/cli.mdx @@ -1,13 +1,13 @@ --- -title: memmy CLI +title: CLI Command Reference icon: Terminal --- | Command | Description | | --- | --- | | `memmy` | Start an interactive chat | -| `memmy onboard` | Initialize config and workspace | -| `memmy onboard --wizard` | Terminal menu-driven setup | +| `memmy onboard` | Terminal menu-driven setup | +| `memmy onboard --defaults` | Initialize config and workspace non-interactively | | `memmy status` | Check config, workspace, model, and provider status | | `memmy agent --message "..."` | Send a single-turn message | | `memmy serve` | Start the OpenAI-compatible API | diff --git a/docs/en/terminal/meta.json b/docs/en/terminal/meta.json new file mode 100644 index 000000000..32f2fb592 --- /dev/null +++ b/docs/en/terminal/meta.json @@ -0,0 +1,5 @@ +{ + "title": "Terminal", + "icon": "Terminal", + "pages": ["tui", "cli"] +} diff --git a/docs/en/terminal/tui.mdx b/docs/en/terminal/tui.mdx new file mode 100644 index 000000000..5475eca82 --- /dev/null +++ b/docs/en/terminal/tui.mdx @@ -0,0 +1,292 @@ +--- +title: TUI User Guide +icon: Terminal +--- + +Memmy TUI is Memmy's full-screen terminal interface. Whether you install the desktop app or just the CLI, you can run `memmy` in your terminal to use it. + +![image.png](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/3BMqYy5xagvDGqwZ/img/ed3cfb80-ad6a-4403-afa4-03e6ea01ee68.png) + +## Installing Memmy TUI + +### Option 1: Install the Memmy desktop app + +For macOS and Windows. The desktop app provides the `memmy` command and takes care of starting the local Memory and Agent Gateway services. + +1. Download and install the desktop app from the [Memmy official website](https://memmy.cn/en/) or [GitHub Releases](https://github.com/MemTensor/memmy-agent/releases). + +2. Launch Memmy and complete setup in either account mode or API key mode. + +3. Open a new terminal and check that the command is available: + +```bash +memmy --help +memmy --version +``` + +- **macOS:** drag the app into `/Applications` and launch it at least once. If your terminal reports that `memmy` cannot be found, open a new terminal or run: + +```bash +source ~/.zshrc +``` + +- **Windows**: after installation, open a new PowerShell or Windows Terminal window. + +When using the TUI provided by the desktop app, keep the Memmy desktop app running. Closing it also stops the Gateway it manages. + +### Option 2: Install only the Memmy CLI + +For Linux x64 or arm64 environments that don't need the desktop app. Requires **Node.js 22** or later and a system with `systemd --user` support. + +```bash +curl -fsSL https://raw.githubusercontent.com/MemTensor/memmy-agent/main/scripts/install.sh | bash +``` + +Once installation finishes, run: + +```bash +memmy +``` + +On first run, if no model is available yet, Memmy opens the setup wizard. The CLI installer manages the Memory and Gateway services; they keep running after you exit the TUI or close the terminal. + +Check service status: + +```bash +systemctl --user status memmy-memory.service +systemctl --user status memmy-gateway.service +``` + +## First Time Setup + +If you already completed onboarding in the desktop app, you can skip this section. CLI users should run: + +```bash +memmy onboard --defaults +memmy onboard +memmy status +``` + +- `memmy onboard --defaults` — creates or refreshes the config file and workspace, non-interactively. + +- `memmy onboard` — configures models, providers, Gateway, Memory, and tools interactively. + +- `memmy status` — checks the current configuration, workspace, model, and provider. + +Default locations: + +- Config file: `~/.memmy/config.yaml` + +- Workspace: `~/.memmy/workspace` + +## Opening the TUI + +Run: + +```bash +memmy +``` + +This opens the default `cli:direct` session. Type a message and press `Enter` to send it. + +**Resuming or creating sessions:** + +```bash +# Resume an existing session +memmy --session cli:work + +# Create a new standalone session +memmy --standalone + +# Create a session bound to a project directory +memmy --project /path/to/project +``` + +`--session`, `--standalone`, and `--project` are mutually exclusive — pick one. + +List existing sessions: + +```bash +memmy sessions list +``` + +### `memmy` vs. `memmy agent` + +To open the full-screen TUI covered in this guide, use bare `memmy`. + +`memmy agent` is for single-turn tasks or conventional terminal interaction: + +```bash +# Single-turn task +memmy agent --message "Give me an overview of the current workspace" + +# Send a single turn from stdin +echo "Summarize this project" | memmy agent +``` + +## Sending Tasks + +Type after the `❯` prompt and press `Enter` to send. The TUI does not currently support the desktop workbench's `Shift + Enter` newline; `Enter` always submits. + +Long text wraps visually in the terminal, but you cannot insert multiple lines. To send multi-line text, use: + +```bash +memmy agent --message $'first line\nsecond line' +``` + +or: + +```bash +printf 'first line\nsecond line\n' | memmy agent +``` + +### Typing while a task is running + +- `Enter` — queue the next turn. + +- `Tab` — append your input to the current turn, when that turn is being executed by this TUI. + +If the current turn came from the desktop app or another IM channel, the TUI will not take it over; use `Enter` to queue instead. + +When there are queued tasks, the interface shows the queue count, a message preview, and the message source. + +## Keyboard Controls + +Basic controls are the same on macOS, Windows, and Linux; the primary modifier for line-editing combinations differs: + +| **Action** | **macOS** | **Windows** | **Linux** | +| --- | --- | --- | --- | +| Send; queue next turn while running | `Enter` | `Enter` | `Enter` | +| Append to the current TUI executed turn | `Tab` | `Tab` | `Tab` | +| Move one character | `←` / `→` | `←` / `→` | `←` / `→` | +| Move by word | `⌘ + ←` / `⌘ + →` | `Ctrl + ←` / `Ctrl + →` | `Ctrl + ←` / `Ctrl + →` | +| Move to start of input | `Home` / `Ctrl + A` | `Home` / `Ctrl + A` | `Home` / `Ctrl + A` | +| Move to end of input | `End` / `Ctrl + E` / `⌘ + E` | `End` / `Ctrl + E` | `End` / `Ctrl + E` | +| Delete from cursor to start of line | `Ctrl + U` / `⌘ + U` / `⌘ + Backspace` / `⌘ + Delete` | `Ctrl + U` | `Ctrl + U` | +| Delete from cursor to end of line | `Ctrl + K` / `⌘ + K` | `Ctrl + K` | `Ctrl + K` | +| Delete previous word | `Ctrl + W` / `⌘ + W` | `Ctrl + W` / `Ctrl + Backspace` | `Ctrl + W` / `Ctrl + Backspace` | +| Delete a character | `Backspace` / `Delete` | `Backspace` / `Delete` | `Backspace` / `Delete` | +| Stop your own running turn and exit | `Ctrl + C` | `Ctrl + C` | `Ctrl + C` | + +On macOS, `⌘` is the Command key; Windows and Linux use `Ctrl` as the primary modifier. `Shift + Enter` never inserts a newline on any platform — it submits the current message. + +You can also exit by typing any of the following: + +```bash +exit +quit +/exit +/quit +:q +``` + +If the task is being executed by another channel, `Ctrl + C` only exits the current TUI; it does not stop the task on that channel. + +## Slash Commands + +![Slash command menu](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/3BMqYy5xagvDGqwZ/img/62ea1bed-2894-42ef-826c-18b68447798e.png) + +The TUI has a slash-command suggestion menu. Type `/` in the input area to open it, and keep typing a command name (for example `/go`) to filter the suggestions. The menu closes once you type a space to enter an argument or subcommand. + +- `↑` / `↓` — move between suggestions. + +- `Tab` — complete the selected command entry; it does not complete subcommands or arguments. + +- `Enter` — if the current input is a command prefix, completes it first; if the command entry is already complete, runs the command. + +- `Esc` — close the suggestion menu. + +If `Enter` only completed the command, press `Enter` again to run it. + +- The menu shows the commands currently available, along with hints for that command's arguments or subcommands. + +- Arguments and subcommands do not get their own suggestions — for example, with `/model list` you complete `/model` first and then type `list` manually. + +- `/stop` appears only when the current turn is being executed by this TUI. + +- `/restart` is not shown and cannot be run from the TUI. + +- `exit`, `quit`, `/exit`, `/quit`, and `:q` all exit, but only `/quit` appears in the menu. + +- Whether `/history-dag` and `/dream*` appear depends on whether the corresponding features are enabled. + +- Up to 8 suggestions are shown initially; keep typing a command prefix to filter down to others. + +| **Command** | **Arguments** | **Purpose** | +| --- | --- | --- | +| `/help` | none | Show help for the available commands | +| `/status` | none | Show runtime status, provider, and channel status | +| `/model` | none | Show the current model configuration | +| `/model list` | none | List model presets | +| `/model ` | model preset name | Switch model preset, e.g. `/model fast` | +| `/history` | none | Show session history | +| `/history ` | number of messages | Show the last `n` history messages | +| `/history-dag` | none | Show the session history DAG | +| `/new` | none | Stop the current task and start a new conversation | +| `/stop` | none | Stop the turn currently executed by this TUI; does not stop tasks on other channels | +| `/restart` | none | Not accepted by the TUI; exit and restart the Gateway instead | +| `/last-compaction` | none | Show the most recent context-compaction summary for this session | +| `/quit` | none | Exit the TUI without stopping turns running on other channels | +| `/goal` | none | Show the current persistent goal | +| `/goal status` | none | Show persistent goal status | +| `/goal help` | none | Show help for the goal subcommands | +| `/goal ` | goal text | Shorthand for creating a persistent goal | +| `/goal create ` | goal text | Create a persistent goal | +| `/goal pause` | none | Pause the goal | +| `/goal resume` | none | Resume the goal | +| `/goal edit ` | new goal text | Edit the goal | +| `/goal budget ` | a number or `none` | Set or clear the goal budget | +| `/goal clear` | none | Clear the goal | +| `/dream` | none | Run memory consolidation | +| `/dream-log` | none | Show the memory-consolidation log | +| `/dream-log ` | Dream version SHA | Show the changes in a specific memory consolidation version | +| `/dream-restore` | none | List restorable memory consolidation versions | +| `/dream-restore ` | Dream version SHA | Restore a specific memory consolidation version | +| `/pairing` | none | View or manage channel pairings | +| `/pairing list` | none | List channel pairing requests | +| `/pairing approve ` | pairing code | Approve a pairing request | +| `/pairing deny ` | pairing code | Deny a pairing request | +| `/pairing revoke ` | user ID | Revoke a user's pairing | + +Whether commands such as `/history-dag` and `/dream*` are available depends on whether the corresponding features are enabled in your configuration. + +## FAQ + +### `memmy: command not found` + +- **macOS**: make sure Memmy has been moved into `/Applications` and launched at least once, then open a new terminal or run `source ~/.zshrc`. + +- **Windows**: open a new PowerShell or Windows Terminal window. + +- **Linux**: confirm the installer completed successfully, and check that `~/.local/bin` is on your `PATH`. + +### No model available + +```bash +memmy onboard +memmy status +``` + +Confirm that the model, provider, and credentials have been saved, then run `memmy`. + +### Gateway unavailable + +- **Desktop app**: make sure the Memmy desktop app is running. + +- **Linux CLI**: check `memmy-gateway.service`. + +- **Running the CLI from source or manually**: run `memmy gateway` in another terminal. + +The default Gateway WebSocket port is `18980`. On Linux you can check the logs: + +```bash +journalctl --user -u memmy-gateway.service +``` + +### Why doesn't `memmy agent` open the full-screen interface? + +That's expected. `memmy agent` is the single-turn / conventional terminal entry point. For the full-screen TUI, run: + +```bash +memmy +```