@cydm/pie 1.0.0 → 1.0.1

package/README.md

@@ -1,153 +1,179 @@
 # @cydm/pie
 
-Pie AI Agent CLI - 命令行交互界面
+`@cydm/pie` is a minimal, powerful, embeddable agent suite for game developers.
 
-## 安装
+It gives you a terminal-first agent experience out of the box, while staying modular enough to embed into other runtimes and products. Pie is designed for teams that want a small surface area, strong defaults, persistent sessions, tool use, and a clean path from CLI usage to deeper integration.
+
+Pie is heavily inspired by `pi`, while evolving in its own direction around modularity, embeddability, and a compact developer-facing workflow.
+
+Pie is developed by [cydream](https://cydream.tech).
+
+## Why Pie
+
+- Minimal interface, low ceremony
+- Powerful coding-agent workflow in the terminal
+- Embeddable architecture built on reusable `@pie/*` packages
+- Persistent sessions, slash commands, and skill loading
+- Works well as both a daily CLI and a building block for custom agent products
+
+## Install
 
 ```bash
 npm install -g @cydm/pie
 ```
 
-## 使用
-
-### 环境变量
+## Quick Start
 
-设置 API Key：
+Set an API key for the provider you want to use:
 
 ```bash
 export KIMI_API_KEY="your-kimi-api-key"
-# 或
+# or
 export BIGMODEL_API_KEY="your-bigmodel-api-key"
 ```
 
-或创建配置文件 `~/.pie/config.json`：
+You can also configure defaults in:
 
-```json
-{
-  "provider": "kimi-cn",
-  "modelId": "kimi-k2.5"
-}
-```
+- `~/.pie/settings.json`
+- `~/.pie/models.json`
+- `~/.pie/config.json` for legacy-compatible defaults
 
-也可以在 `~/.pie/models.json` 的 `providers.<provider>.apiKey` 中为特定 provider 配置 API Key。
+Start Pie in interactive mode:
 
-### 命令
+```bash
+pie
+```
 
-#### Print 模式（默认）
+Or pass an initial prompt:
+
+```bash
+pie chat "Summarize this repository"
+```
 
-直接输入 prompt，获取结果后退出：
+Use Pie in one-shot mode:
 
 ```bash
-pie "请列出当前目录的文件"
-pie chat "帮我写一个快速排序的 Python 代码"
+pie "List the files in the current directory"
+pie chat "Write a quick Python script for merge sort"
 ```
 
-#### Interactive 模式
+## Core Ideas
 
-启动交互式 TUI 界面：
+Pie is not just a chat CLI. It is a compact agent suite with a terminal UI on top of a reusable runtime.
+
+- The CLI is intentionally small and fast to learn
+- The agent can work with files, shell commands, sessions, and skills
+- The architecture is modular, so the same foundation can be embedded into other apps and environments
+
+If you want an agent that feels lightweight but still has serious capability, that is the design target for Pie.
+
+## Interactive Experience
+
+Run:
 
 ```bash
 pie
-# 或
+# or
 pie chat
 ```
 
-快捷键：
-- `Enter` - 提交消息
-- `Shift+Enter` / `Ctrl+Enter` - 换行（需 CSI u 支持的终端）
-- `\` + `Enter` - 换行（兼容所有终端）
-- `Ctrl+C` - 退出
+Main key bindings:
 
-#### 帮助
+- `Enter` submit message
+- `Shift+Enter` insert a new line
+- `\` + `Enter` insert a new line in terminals without modified-enter support
+- `Ctrl+C` exit
+- `Ctrl+D` exit
+- `Ctrl+O` expand or collapse tool output
+- `/` open the slash command menu
 
-```bash
-pie help
-pie --help
+Direct shell mode:
+
+```text
+!!git status
+!!npm test
 ```
 
-## 功能特性
+Commands prefixed with `!!` run directly in the shell without going through the agent.
 
-- **Print 模式**：快速单次查询，适合脚本调用
-- **Interactive TUI**：完整的终端交互界面
-  - 实时流式响应显示
-  - 多行编辑器（Shift+Enter 换行）
-  - 工具执行状态透明展示
-  - Thinking 过程显示
-  - 主题系统（dark/light）
-- **工具支持**：read、write、edit、ls、grep、find、bash
-- **Session 管理**：自动保存对话历史
+## Slash Commands
 
-### Session 管理
+Pie uses a hierarchical slash-command menu. The current built-in commands include:
 
-Session 文件保存在 `~/.pie/sessions/` 目录。
+| Command | Description |
+| --- | --- |
+| `/sessions/compact` | Summarize history and create a compact checkpoint |
+| `/sessions/new` | Start a new session |
+| `/sessions/resume` | Resume a different session |
+| `/sessions/tree` | Navigate the session tree |
+| `/sessions/info` | Show session information |
+| `/sessions/fork` | Fork from an earlier message |
+| `/settings` | Open the settings menu |
+| `/settings/model` | Choose a model |
+| `/settings/theme` | Change the theme |
+| `/settings/thinking` | Set reasoning depth |
+| `/settings/yolo` | Toggle less restricted filesystem mode |
+| `/settings/hotkeys` | Show keyboard shortcuts |
+| `/settings/quit` | Exit Pie |
+| `/skills/list` | List available skills |
+| `/skills/use` | Use a skill |
+| `/skills/reload` | Reload skills from disk |
+| `/tools/subagent` | Spawn a subagent for a task |
+| `/debugs/cache-test` | Test context caching |
+| `/debugs/context` | Dump raw context for debugging |
+| `/debugs/package` | Dump raw request and response payloads |
 
-#### Slash 命令
+Pie can also load extension-provided commands at runtime.
 
-在 Interactive 模式下输入 `/` 显示命令菜单：
+## Sessions
 
-| 命令 | 说明 |
-|------|------|
-| `/new` | 创建新 Session（保存当前并开启新的对话） |
-| `/resume` | 恢复之前的 Session（显示交互式选择器） |
-| `/session` | 显示当前 Session 信息 |
-| `/fork` | 从当前 Session 分叉创建新 Session |
-| `/tree` | 显示 Session 树状结构 |
-| `/settings` | 设置菜单（主题、思考级别） |
-| `/hotkeys` | 显示键盘快捷键 |
-| `/quit` | 退出 |
+Pie keeps persistent sessions so you can come back to earlier work.
 
-#### 使用示例
+- Sessions are stored in `~/.pie/sessions/`
+- You can switch sessions from the command menu
+- You can fork a session to branch off a previous line of work
+- You can compact long sessions to keep context focused
 
-```bash
-# 启动交互模式
-pie chat
+This makes Pie useful for ongoing coding tasks, not just one-off prompts.
 
-# 聊几句...
-> 你好，我叫 Bob
-> 我喜欢用 TypeScript
+## Skills And Extensibility
 
-# 创建新 Session（之前的对话会被保存）
-/new
+Pie supports Markdown-based skills and built-in extensions.
 
-# 在新 Session 中聊天
-> 你好
+- Built-in skills ship with the CLI
+- User skills can live under `~/.pie/skills`
+- Project-local skills can live under `.pie/skills`
+- Extensions can register additional commands and workflows
 
-# 恢复之前的 Session
-/resume
-# 使用 ↑↓ 选择，Enter 确认
+That is part of what makes Pie embeddable: the CLI is only one interface on top of a broader agent toolkit.
 
-# AI 会记得之前的对话内容
-> 我叫什么名字？
-# AI: 你叫 Bob，之前告诉过我你喜欢 TypeScript
-```
+## Output Modes
 
-#### 快捷键
+For non-interactive usage, Pie supports structured output options:
+
+```bash
+pie "summarize this file" --raw-output
+pie "summarize this file" --json-output
+pie "continue previous task" --session-id my-session
+```
 
-| 快捷键 | 说明 |
-|--------|------|
-| `Enter` | 发送消息 |
-| `Shift+Enter` | 换行（需 CSI u 支持） |
-| `Ctrl+C` (按一次) | 清空编辑器 |
-| `Ctrl+C` (快速按两次) | 退出 |
-| `ESC` | 取消 / 返回上一级 |
-| `/` | 显示命令菜单 |
+## Terminal Notes
 
-## 终端要求
+For the best multiline editing experience, use a terminal with good modified-key support, such as:
 
-对于完整的按键支持（Shift/Ctrl+Enter），推荐使用：
 - [Kitty](https://sw.kovidgoyal.net/kitty/)
-- [iTerm2](https://iterm2.com/)（启用 "Report modifier keys using CSI u"）
+- [iTerm2](https://iterm2.com/)
 - [Ghostty](https://ghostty.org/)
 
-## 开发
+## Development
 
 ```bash
 cd products/cli
 npm install
 npm run build
-npm test
+npm run test:offline
 ```
 
-## 许可证
+## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cydm/pie",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"description": "Pie AI Agent CLI",
 	"type": "module",
 	"bin": {