finch-shell-go 0.0.0-stage → 0.1.1
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 +57 -2
- package/dist/index.js +10087 -0
- package/dist/ui/panel.css +1357 -0
- package/dist/ui/panel.html +42 -0
- package/dist/ui/panel.js +17699 -0
- package/docs/logo.png +0 -0
- package/finch.json +30 -0
- package/i18n/zh-CN.json +10 -0
- package/icon.png +0 -0
- package/package.json +33 -5
- package/skills/shell-go/SKILL.md +78 -0
package/docs/logo.png
ADDED
|
Binary file
|
package/finch.json
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
{
|
|
2
|
+
"manifestVersion": 1,
|
|
3
|
+
"minVersion": "1.6.1",
|
|
4
|
+
"name": "shellGo",
|
|
5
|
+
"miniToolType": "community",
|
|
6
|
+
"categories": ["developer", "terminal", "automation"],
|
|
7
|
+
"main": "dist/index.js",
|
|
8
|
+
"activationEvents": ["onStartup"],
|
|
9
|
+
"systemPrompt": "执行终端命令、跑构建或起常驻进程时用 shell_go,它在可见终端里跑并回传输出。",
|
|
10
|
+
"contributes": {
|
|
11
|
+
"tools": true,
|
|
12
|
+
"skills": true,
|
|
13
|
+
"appPanel": {
|
|
14
|
+
"icon": "square-terminal",
|
|
15
|
+
"viewType": "shell-go.terminal",
|
|
16
|
+
"instanceMode": "single",
|
|
17
|
+
"showInLauncher": true,
|
|
18
|
+
"source": {
|
|
19
|
+
"type": "local",
|
|
20
|
+
"path": "dist/ui/panel.html"
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
},
|
|
24
|
+
"permissions": {
|
|
25
|
+
"filesystem": "readwrite",
|
|
26
|
+
"network": false,
|
|
27
|
+
"shell": true,
|
|
28
|
+
"agentEvents": "full"
|
|
29
|
+
}
|
|
30
|
+
}
|
package/i18n/zh-CN.json
ADDED
package/icon.png
ADDED
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,34 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
2
|
+
"name": "finch-shell-go",
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "在可见终端里执行 Agent 命令,输出与退出码回传,会话绑定、可与内置 Bash 混看",
|
|
5
|
+
"homepage": "https://yicode.tech",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"author": "陈随易 <bimostyle@qq.com>",
|
|
8
|
+
"files": [
|
|
9
|
+
"finch.json",
|
|
10
|
+
"dist/",
|
|
11
|
+
"i18n/",
|
|
12
|
+
"skills/",
|
|
13
|
+
"docs/",
|
|
14
|
+
"icon.png",
|
|
15
|
+
"README.md"
|
|
16
|
+
],
|
|
17
|
+
"type": "module",
|
|
18
|
+
"main": "dist/index.js",
|
|
19
|
+
"dependencies": {
|
|
20
|
+
"@xterm/addon-fit": "^0.11.0",
|
|
21
|
+
"@xterm/addon-unicode11": "^0.9.0",
|
|
22
|
+
"@xterm/addon-webgl": "^0.19.0",
|
|
23
|
+
"@xterm/xterm": "^6.0.0",
|
|
24
|
+
"collapse-white-space": "^2.1.0",
|
|
25
|
+
"read-last-lines": "^1.10.0",
|
|
26
|
+
"string-byte-slice": "^3.0.1",
|
|
27
|
+
"strip-ansi": "^7.2.0",
|
|
28
|
+
"unbash": "^6.0.4"
|
|
29
|
+
},
|
|
30
|
+
"devDependencies": {
|
|
31
|
+
"@lydell/node-pty": "1.2.0-beta.18",
|
|
32
|
+
"finch-shared": "0.0.0"
|
|
33
|
+
}
|
|
34
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: shell-go
|
|
3
|
+
description: shellGo 的操作手册。用 shell_go 执行终端命令、起常驻进程、读回日志之前先读它,尤其是 run 与 open 的分工、单行命令与 stdin 限制、超时后为什么会被拒绝写新命令,以及面板与镜像块分别代表什么。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# shellGo
|
|
7
|
+
|
|
8
|
+
`shell_go` 把命令放进一条**用户看得见的 bash** 里执行,输出与退出码回传给你。命令落在当前会话的终端面板里,用户能实时看到过程;他也能在同一个面板里自己敲命令。
|
|
9
|
+
|
|
10
|
+
## 心智模型
|
|
11
|
+
|
|
12
|
+
- **一个会话一条 shell。** 同一会话里命令串行执行,cwd、变量、别名都保持;不同会话互不影响。
|
|
13
|
+
- **面板关掉就什么都没了。** 关面板会杀掉 shell 与所有常驻进程,下次执行时重建,历史输出也会丢。
|
|
14
|
+
- **你不是唯一的使用者。** 用户可能在同一面板里手敲,写入前会清掉他未提交的半行。
|
|
15
|
+
- **面板里出现 `[finch bash · …]` 的暗色块不是你的 shell。** 那是内置 Bash 的执行镜像,只读,别把它当历史。
|
|
16
|
+
|
|
17
|
+
## 五个动作
|
|
18
|
+
|
|
19
|
+
| action | 什么时候用 | 返回 |
|
|
20
|
+
| ------------- | ----------------------------------------------- | ---------------------------- |
|
|
21
|
+
| `run`(默认) | 一次性命令:构建、检查、git、读文件、跑一段脚本 | 清理后的输出 + 退出码 + 耗时 |
|
|
22
|
+
| `open` | 常驻进程:dev server、`--watch`、`tail -f` | `jobId`、pid、日志路径 |
|
|
23
|
+
| `read` | 看常驻进程最近的输出 | 日志尾部(默认 200 行) |
|
|
24
|
+
| `interrupt` | 停常驻进程(连它的子进程一起) | 是否已停 |
|
|
25
|
+
| `close` | 主动重建:shell 状态脏了、被超时命令占住 | 是否关掉 |
|
|
26
|
+
|
|
27
|
+
## 硬约束
|
|
28
|
+
|
|
29
|
+
- **`command` 必须单行**,且不能含控制字符(换行、制表符、`\x1b` 都会被拒)。多步用 `&&`、`;`、`$(...)` 或脚本文件(如 `bash -c '…'`)。
|
|
30
|
+
- **读完 stdin 的命令不能 `run`**:`ssh`、`sudo -S`、`read`、`git rebase -i`、`passwd` 会把提示符输入当自己的输入吞掉,命令永远等不到结束。这类让用户在面板里手敲,或改用 `open` 起独立进程。
|
|
31
|
+
- **全屏 TUI 不能 `run`**:`vim`、`htop`、`less` 输出的是控制序列,回传给你也是一团乱码。
|
|
32
|
+
- **`cwd` 必须是绝对路径**;不传就用会话工作区。传了不同的目录会在 shell 里前置一次 `cd`,不重建 shell。
|
|
33
|
+
|
|
34
|
+
## 超时与占用:最容易被绊住的一处
|
|
35
|
+
|
|
36
|
+
`run` 默认等 30 秒,可用 `timeoutMs` 上调(上限 9 分钟)。超时**不杀进程**,返回里带 `[仍在运行]`,此时 shell 仍被那条命令占着。
|
|
37
|
+
|
|
38
|
+
**这期间任何新命令都会被拒绝**,报错会带上那条命令的摘要。处理方式只有两种:
|
|
39
|
+
|
|
40
|
+
1. 等它结束:它吐出提示符时会自动解锁,之后再发新命令即可;
|
|
41
|
+
2. 认为它确实该停:调 `close` 重建 shell(会连带杀掉它的进程),然后重新执行。
|
|
42
|
+
|
|
43
|
+
不要用 `sleep` 之类的命令去「等它结束」——那条命令同样会被拒绝。
|
|
44
|
+
|
|
45
|
+
## 常驻进程
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
open { command: "bun run dev" } → job 1,pid 12345
|
|
49
|
+
read { jobId: 1, lines: 50 } → 最近的输出
|
|
50
|
+
interrupt { jobId: 1 } → 连子进程一起停
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
- 常驻进程**不在 shell 里跑**,所以不会堵住后续 `run`。它的输出会实时进面板,同时写日志文件。
|
|
54
|
+
- 不传 `jobId` 时,`read` / `interrupt` 取该会话最近一个作业。
|
|
55
|
+
- 面板里按 `Ctrl+C` 打不到它(它不在 shell 的作业表里),要停就用 `interrupt`。
|
|
56
|
+
|
|
57
|
+
## 判定成败
|
|
58
|
+
|
|
59
|
+
- 非零退出码**不是工具调用错误**:照常返回输出与退出码,你自己判断下一步。
|
|
60
|
+
- 只有 shell 起不来(找不到 bash、原生模块加载失败)才是 `isError`,报错里会带候选路径,可以据此告诉用户装 Git for Windows 或 MSYS2。
|
|
61
|
+
- 输出超过 2000 行或 128KB 会截断,末尾标 `…(输出已截断)`;需要更多就缩小命令的范围(`| tail -n`、`--filter`)。
|
|
62
|
+
|
|
63
|
+
## 典型用法
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
run "bun run check finchapp/shellGo" # 检查
|
|
67
|
+
run "git status --short && git log --oneline -5" # 组合命令
|
|
68
|
+
run "rg -n 'TODO' src | head -20" # 读文件内容
|
|
69
|
+
open "bun run dev" # 起开发服务
|
|
70
|
+
read "lines: 80" # 看启动是否成功
|
|
71
|
+
interrupt # 停了它
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## 不要做的事
|
|
75
|
+
|
|
76
|
+
- 不要把长跑任务塞进 `run`(靠超时兜底只会让 shell 被占住)。
|
|
77
|
+
- 不要用 `run` 起服务再等它超时——那正是 `open` 的场景。
|
|
78
|
+
- 不要假设用户没在面板里操作;写入前会被清行,这是设计好的行为。
|