finch-shell-go 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,58 +1,42 @@
1
1
  # shellGo
2
2
 
3
- <img src="./docs/logo.png" width="96" alt="shellGo 图标" />
3
+ ![](https://static.yicode.tech/images/202611/1793772135548.png)
4
4
 
5
- 在 Finch 里开一条**看得见的终端**:Agent 的命令在这里执行,过程实时可见,输出与退出码回传;你自己也能在同一个面板里敲命令;内置 Bash 的执行会以暗色块镜像进来,一条时间线上看得到全部动作。
5
+ 在 Finch 里开一条看得见的终端:Agent 的命令在这里执行,过程实时可见,输出与退出码回传;你自己也能在同一个面板里敲命令。
6
6
 
7
- 与官方 `finch-shell` 的区别:`finch-shell` 只负责「开个终端、把命令敲进去」,不返回任何输出,Agent 拿不到结果就没法接着走。shellGo 补的就是这个缺口——**可见 + 可回传**,并且与会话绑定、支持常驻进程。
7
+ 完整手册:https://yicode.tech/#/product?code=finchShellGo
8
8
 
9
- ## 动作
9
+ ## 功能特性
10
10
 
11
- | action | 用途 |
12
- | ----------- | ----------------------------------------------------- |
13
- | `run` | 执行一条命令并等它结束,返回输出与退出码 |
14
- | `open` | 起常驻进程(dev server、`--watch`),立即返回 `jobId` |
15
- | `read` | 读常驻进程最近的输出 |
16
- | `interrupt` | 停常驻进程,连子进程一起 |
17
- | `close` | 关掉当前会话的 shell、常驻进程与面板 |
11
+ - 命令在可见终端里跑,过程实时可见,不用黑盒等结果
12
+ - 输出与退出码回传,Agent 能接着往下判断
13
+ - 起常驻进程(开发服务器、`--watch`)后随时读最近的输出,也能一键停掉连子进程一起收
14
+ - 你自己可以在同一个面板里接着敲命令,和 Agent 共用一条终端
15
+ - Finch 内置的同名能力会以暗色块镜像进来,一条时间线上看到全部动作
16
+ - 每个会话有自己的终端,互不打断;终端输出在开发档下另存一份,方便事后查
18
17
 
19
- 用法细节见随包的 `skills/shell-go/SKILL.md`。
18
+ ## 使用场景
20
19
 
21
- ## 需要什么
20
+ **让 Agent 跑检查、测试,你要看着过程**
22
21
 
23
- - **bash**:Windows 装 Git for Windows 或 MSYS2;macOS / Linux 用系统自带的。找不到会直接报错并列出试过的路径。
24
- - **64 位**:Windows 的 32 位 Finch(`setup-ia32.exe`)没有可用的原生二进制,装了也用不了。
25
- - 语法固定是 bash,不跟随 Finch 的 shell 设置,也不支持 PowerShell / cmd。
22
+ 命令在面板里逐行出输出,卡在哪一步一目了然,不用等一条汇总结果。
26
23
 
27
- ## 权限
24
+ **起一个常驻服务继续开发**
28
25
 
29
- | 权限 | 为什么 |
30
- | ----------------------- | ------------------------------------------------------------ |
31
- | `shell` | 要起真实的 bash 进程 |
32
- | `filesystem: readwrite` | 原生模块落到插件私有目录、常驻进程日志 |
33
- | `agentEvents: full` | 镜像内置 Bash 的命令与结果,否则看不到「另一条通道」在干什么 |
26
+ 开启后立刻返回,它继续在后头跑;改代码、看日志、重启都在同一个终端里。
34
27
 
35
- `agentEvents` 会读到所有会话的完整运行事件,是本应用最敏感的一项;它只用于渲染终端里的镜像块,不落盘、不外传。
28
+ **你自己也在这条终端上干活**
36
29
 
37
- ## 已知限制
30
+ Agent 跑完,你接着敲命令,历史与工作目录都在,不用重开窗口。
38
31
 
39
- - 关闭面板 = 杀掉 shell 和所有常驻进程,正在跑的 dev server 会一起停。
40
- - 需要交互输入的命令(`ssh`、`sudo -S`、`git rebase -i`)和全屏程序(vim、htop)不能用 `run`,请在面板里手敲。
41
- - 单条命令超时后 shell 会被占住,新命令会被拒绝,要么等它结束,要么 `close` 重建。
42
- - 镜像只有「命令开始 / 命令结束」两个点,没有逐行流;高负载下事件可能漏。
43
- - macOS 未做真机验证(协议层按 bash 3.2 与 POSIX 写,Linux 与 Windows 已实测)。
32
+ ## 安装使用
44
33
 
45
- ## 开发
34
+ 在 Finch 里安装「小终端」。需要本机有 `bash`:Windows 装 Git for Windows 或 MSYS2,macOS / Linux 用系统自带。
46
35
 
47
- ```bash
48
- bun scripts/devFinch/dev.js shellGo # 构建 + 软链安装 + 监听
49
- bun run check finchapp/shellGo --test # 格式、lint、单元测试
50
- bun run synctpl finchapp # 契约校验
51
- ```
36
+ 之后在对话里直接说「跑一下 bun run check」,命令会在面板里执行并把结果回传。
52
37
 
53
- 开发日志落 `~/.yicodeLogsDev/`:
38
+ ## 联系方式
54
39
 
55
- | 文件 | 内容 |
56
- | ------------------------------ | ---------------------------------------------------------------------------------------- |
57
- | `finch-shell-go.dev.log.jsonl` | 诊断事件(结构化、一次运行一份、启动清空) |
58
- | `finch-shell-go.output.log` | 面板与作业的原始输出(纯文本、剥 ANSI、命令单独一行,便于 grep;仅开发档、单次上限 8MB) |
40
+ - 官网:https://yicode.tech
41
+ - 公众号:陈随易
42
+ - 邮箱:yicode@qq.com