opencode-planpilot 0.2.3 → 0.3.0

package/README.md

@@ -1,24 +1,55 @@
 # opencode-planpilot
 
-Planpilot for OpenCode. Provides plan/step/goal workflow with auto-continue for AI steps and a native `planpilot` tool.
+Chinese version: [README.zh-CN.md](README.zh-CN.md)
 
-## Features
-- Plan/step/goal hierarchy with status auto-propagation upward (goals -> steps -> plan)
-- SQLite storage with markdown plan snapshots
-- Native OpenCode tool for plan/step/goal operations
-- Auto-continue on `session.idle` when next step is assigned to `ai`
+Planpilot adds a structured execution loop to OpenCode so multi-step work stays organized, visible, and easier to complete.
 
-## Install
+## Why Teams Use Planpilot
 
-Add to `opencode.json`:
+- Turn complex work into a clear `plan -> step -> goal` workflow.
+- Keep momentum by auto-continuing when the next pending step is assigned to `ai`.
+- Persist progress locally (database + markdown snapshots) so context is never lost.
+- Keep collaboration natural: you describe intent in plain language, and Planpilot keeps execution structured.
 
-```json
+## Installation
+
+Add the plugin to your OpenCode config file `opencode.json`:
+
+- Unix/macOS: `~/.config/opencode/opencode.json`
+- Windows: `%USERPROFILE%\\.config\\opencode\\opencode.json` (for example: `C:\\Users\\<your-user>\\.config\\opencode\\opencode.json`)
+
+```jsonc
 {
   "plugin": ["opencode-planpilot"]
 }
 ```
 
-OpenCode installs npm plugins automatically at startup.
+OpenCode installs npm plugins automatically when the session starts.
+
+## Quick Start with Natural Language
+
+Example prompt:
+
+```text
+Use planpilot.
+```
+
+## OpenCode Studio Experience
+
+Planpilot ships first-class OpenCode Studio integration:
+
+- Learn more: [opencode-studio](https://github.com/canxin121/opencode-studio)
+
+- Runtime context in the Studio sidebar (active plan, next step, progress state).
+- A Studio settings panel for Planpilot runtime and auto-continue controls.
+- A Studio bridge for reading/writing runtime and configuration state.
+
+If you already run multi-step work in OpenCode, using OpenCode Studio is the fastest way to monitor flow, tune behavior, and keep your team aligned from one UI.
+
+## Details
+
+Detailed configuration schema, bridge actions, parameter-level behavior, and event/trigger rules are documented in `DETAIL.md`.
 
 ## License
+
 MIT

package/README.zh-CN.md

@@ -0,0 +1,55 @@
+# opencode-planpilot
+
+English version: [README.md](README.md)
+
+Planpilot 为 OpenCode 提供结构化执行循环，让多步骤工作更有条理、更可追踪，也更容易持续推进。
+
+## 为什么选择 Planpilot
+
+- 将复杂任务拆解为清晰的 `plan -> step -> goal` 流程。
+- 当下一个待执行步骤归属 `ai` 时自动续跑，保持执行节奏。
+- 本地持久化进度（数据库 + Markdown 快照），上下文不丢失。
+- 你只需用自然语言下达目标，Planpilot 负责保持执行结构。
+
+## 安装
+
+在 OpenCode 配置文件 `opencode.json` 中添加插件：
+
+- Unix/macOS: `~/.config/opencode/opencode.json`
+- Windows: `%USERPROFILE%\\.config\\opencode\\opencode.json` (for example: `C:\\Users\\<your-user>\\.config\\opencode\\opencode.json`)
+
+```jsonc
+{
+  "plugin": ["opencode-planpilot"]
+}
+```
+
+OpenCode 会在会话启动时自动安装 npm 插件。
+
+## 自然语言快速开始
+
+示例提示：
+
+```text
+使用 planpilot。
+```
+
+## OpenCode Studio 集成体验
+
+Planpilot 提供一流的 OpenCode Studio 集成体验：
+
+- 项目地址：[opencode-studio](https://github.com/canxin121/opencode-studio)
+
+- 在 Studio 侧边栏查看运行态上下文（活动计划、下一步、进度状态）。
+- 使用 Studio 设置面板调整运行态和自动续跑配置。
+- 通过 Studio bridge 读取与写入运行态和配置状态。
+
+如果你已经在 OpenCode 中处理多步骤工作，OpenCode Studio 是最快的统一控制台，可用于监控流程、调优行为并保持团队协同。
+
+## 详细说明
+
+更细的配置结构、bridge action、参数级行为和触发规则，见 `DETAIL.zh-CN.md`。
+
+## 许可证
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { Plugin } from '@opencode-ai/plugin';
+
+declare const PlanpilotPlugin: Plugin;
+
+export { PlanpilotPlugin, PlanpilotPlugin as default };