finch-shell-go 0.1.2 → 0.1.3
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 +24 -40
- package/dist/index.js +1861 -751
- package/dist/ui/{panel.js → assets/index-C7RoDbgP.js} +6382 -854
- package/dist/ui/assets/index-Zw5vGntZ.css +1646 -0
- package/dist/ui/index.html +13 -0
- package/finch.json +7 -6
- package/package.json +8 -3
- package/skills/shell-go/SKILL.md +64 -42
- package/dist/ui/panel.css +0 -1357
- package/dist/ui/panel.html +0 -38
- package/docs/logo.png +0 -0
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html lang="zh-CN">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8" />
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
6
|
+
<title>小终端</title>
|
|
7
|
+
<script type="module" crossorigin src="./assets/index-C7RoDbgP.js"></script>
|
|
8
|
+
<link rel="stylesheet" crossorigin href="./assets/index-Zw5vGntZ.css">
|
|
9
|
+
</head>
|
|
10
|
+
<body>
|
|
11
|
+
<div id="app" class="app-root"></div>
|
|
12
|
+
</body>
|
|
13
|
+
</html>
|
package/finch.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"manifestVersion": 1,
|
|
3
|
-
"minVersion": "1.
|
|
4
|
-
"name": "
|
|
3
|
+
"minVersion": "1.8.0",
|
|
4
|
+
"name": "小终端",
|
|
5
5
|
"miniToolType": "community",
|
|
6
6
|
"categories": ["developer", "terminal", "automation"],
|
|
7
7
|
"main": "dist/index.js",
|
|
@@ -11,13 +11,13 @@
|
|
|
11
11
|
"tools": true,
|
|
12
12
|
"skills": true,
|
|
13
13
|
"appPanel": {
|
|
14
|
-
"icon": "square-terminal",
|
|
15
|
-
"viewType": "shell-go.
|
|
14
|
+
"icon": "lucide:square-terminal",
|
|
15
|
+
"viewType": "shell-go.panel",
|
|
16
16
|
"instanceMode": "single",
|
|
17
17
|
"showInLauncher": true,
|
|
18
18
|
"source": {
|
|
19
19
|
"type": "local",
|
|
20
|
-
"path": "dist/ui/
|
|
20
|
+
"path": "dist/ui/index.html"
|
|
21
21
|
}
|
|
22
22
|
}
|
|
23
23
|
},
|
|
@@ -26,5 +26,6 @@
|
|
|
26
26
|
"network": true,
|
|
27
27
|
"shell": true,
|
|
28
28
|
"agentEvents": "full"
|
|
29
|
-
}
|
|
29
|
+
},
|
|
30
|
+
"description": "在可见终端里执行 Agent 命令,输出与退出码回传;会话绑定,可与内置 Bash 混看。"
|
|
30
31
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "finch-shell-go",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "在可见终端里执行 Agent 命令,输出与退出码回传,会话绑定、可与内置 Bash 混看",
|
|
5
5
|
"homepage": "https://yicode.tech",
|
|
6
6
|
"license": "MIT",
|
|
@@ -10,12 +10,15 @@
|
|
|
10
10
|
"dist/",
|
|
11
11
|
"i18n/",
|
|
12
12
|
"skills/",
|
|
13
|
-
"docs/",
|
|
14
13
|
"icon.png",
|
|
15
14
|
"README.md"
|
|
16
15
|
],
|
|
17
16
|
"type": "module",
|
|
18
17
|
"main": "dist/index.js",
|
|
18
|
+
"scripts": {
|
|
19
|
+
"build": "bun ../../scripts/runFinch/build.js",
|
|
20
|
+
"dev": "bun ../../scripts/runFinch/dev.js"
|
|
21
|
+
},
|
|
19
22
|
"dependencies": {
|
|
20
23
|
"@xterm/addon-fit": "^0.11.0",
|
|
21
24
|
"@xterm/addon-unicode11": "^0.9.0",
|
|
@@ -29,6 +32,8 @@
|
|
|
29
32
|
},
|
|
30
33
|
"devDependencies": {
|
|
31
34
|
"@lydell/node-pty": "1.2.0-beta.18",
|
|
32
|
-
"finch-
|
|
35
|
+
"finch-framework": "0.0.0",
|
|
36
|
+
"finch-shared": "0.0.0",
|
|
37
|
+
"vue": "^3.5.45"
|
|
33
38
|
}
|
|
34
39
|
}
|
package/skills/shell-go/SKILL.md
CHANGED
|
@@ -1,78 +1,100 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: shell-go
|
|
3
|
-
description: shellGo 的操作手册。用 shell_go
|
|
3
|
+
description: shellGo 的操作手册。用 shell_go 执行终端命令、起常驻服务、读回日志之前先读它,尤其是默认终端与全局终端的分工、run 与 open 的用法边界、改完代码怎么重启服务、单行命令与 stdin 限制、超时后为什么会被拒绝写新命令。
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# shellGo
|
|
7
7
|
|
|
8
|
-
`shell_go`
|
|
8
|
+
`shell_go` 把命令放进**用户看得见的 bash** 里执行,输出与退出码回传。核心是一条分工,先记住它,其余都是细节:
|
|
9
|
+
|
|
10
|
+
> **默认终端跑命令,全局终端跑服务。**
|
|
11
|
+
|
|
12
|
+
## 两条跑道
|
|
13
|
+
|
|
14
|
+
| | 默认终端(`run`) | 全局终端(`open`) |
|
|
15
|
+
| -------- | ------------------------------------------------------ | ------------------------------------------------ |
|
|
16
|
+
| 用途 | Finch 内部命令、一次性命令、实时命令、要结果回传的命令 | 需要长期运行的服务 |
|
|
17
|
+
| 典型 | `git`、构建、检查、`rg`、读文件、跑脚本、系统查询 | 前端开发模式、本地接口服务、`--watch`、`tail -f` |
|
|
18
|
+
| 生命周期 | 当前会话,关面板即停 | 跨会话共享,关会话面板也不死 |
|
|
19
|
+
| 是否阻塞 | 串行等待,拿输出与退出码 | 立即返回,服务在后台继续跑 |
|
|
20
|
+
| 数量 | 每个会话一条 | 按目录各一条,面板里各占一个标签 |
|
|
21
|
+
|
|
22
|
+
判定口径只有一句:**跑完就要结果的,走默认终端;跑起来不打算停的,走全局终端。** 不要用 `run` 起服务(会被超时占住 shell),也不要用 `open` 跑构建(服务标签里塞一次性命令,人就找不到服务了)。
|
|
23
|
+
|
|
24
|
+
`open` 还有第三种落法:`scope: "session"` 把进程只挂在当前会话上,关掉面板它就停,不进全局终端标签。需要「跑一会儿、只在这次会话里有意义」的后台进程(临时盯一下日志、跑个附属任务)用它;要长期留着、跨会话共享的服务仍然走全局终端。
|
|
9
25
|
|
|
10
26
|
## 心智模型
|
|
11
27
|
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
- **面板里出现 `[finch bash · …]`
|
|
28
|
+
- **默认终端每个会话一条。** 同一会话里命令串行执行,cwd、变量、别名都保持;不同会话互不影响。
|
|
29
|
+
- **全局终端按目录一条。** 同目录再起服务会复用那条终端,不会越开越多。
|
|
30
|
+
- **用户随时可能插手。** 两条跑道都是真终端,用户能直接在里面敲命令,你不是唯一使用者。
|
|
31
|
+
- **面板里出现 `[finch bash · …]` 的暗色块不是你的终端。** 那是内置 Bash 的执行镜像,只读。
|
|
16
32
|
|
|
17
33
|
## 五个动作
|
|
18
34
|
|
|
19
|
-
| action | 什么时候用
|
|
20
|
-
| ------------- |
|
|
21
|
-
| `run`(默认) | 一次性命令:构建、检查、git、读文件、跑一段脚本
|
|
22
|
-
| `open` |
|
|
23
|
-
| `read` |
|
|
24
|
-
| `interrupt` |
|
|
25
|
-
| `close` |
|
|
35
|
+
| action | 什么时候用 | 返回 |
|
|
36
|
+
| ------------- | ----------------------------------------------------------------------------- | ---------------------------- |
|
|
37
|
+
| `run`(默认) | 一次性命令:构建、检查、git、读文件、跑一段脚本 | 清理后的输出 + 退出码 + 耗时 |
|
|
38
|
+
| `open` | 常驻服务:dev server、接口服务、`--watch` | 落在哪条终端、是否复用 |
|
|
39
|
+
| `read` | 看终端最近的输出:`scope: "global"` 读全局终端,`scope: "session"` 读会话作业 | 输出尾部(默认 200 行) |
|
|
40
|
+
| `interrupt` | 停掉在跑的东西:`scope: "global"` 停全局终端,`scope: "session"` 停会话作业 | 是否已停 |
|
|
41
|
+
| `close` | 重建默认终端:shell 状态脏了、被超时命令占住 | 是否关掉 |
|
|
42
|
+
|
|
43
|
+
## 起服务与重启服务
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
open { command: "bun run dev", cwd: "C:/codes/proj/web" } # 起,落在该目录的全局终端
|
|
47
|
+
read { scope: "global", cwd: "C:/codes/proj/web" } # 看启动日志
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
**改完代码要重启服务时,直接再 `open` 一次同目录同命令。** 宿主会:找到该目录的全局终端 → 中断里面正在跑的服务 → 在原终端重新启动。返回里会写明「原来的服务已经中断」。
|
|
51
|
+
|
|
52
|
+
- 同目录已有活着的终端就复用,不会另起第二条(端口会撞,人也分不清哪条是哪个服务)
|
|
53
|
+
- 唯一会新建的情况:那条终端已经退出
|
|
54
|
+
- 中断是往终端送 `Ctrl+C`;服务如果忽略中断,宿主不会硬把命令塞进去,而是报错让你先 `interrupt` 或新建终端
|
|
55
|
+
- 想指名某条终端而不是按目录找,传 `id`(标签栏上那个数字)
|
|
56
|
+
|
|
57
|
+
**不要**自己拼 `kill`、`pkill`、`taskkill`,也不要为了重启去 `close` 会话。重启就是再 `open` 一次。
|
|
26
58
|
|
|
27
59
|
## 硬约束
|
|
28
60
|
|
|
29
|
-
- **`command` 必须单行**,且不能含控制字符(换行、制表符、`\x1b` 都会被拒)。多步用 `&&`、`;`、`$(...)`
|
|
61
|
+
- **`command` 必须单行**,且不能含控制字符(换行、制表符、`\x1b` 都会被拒)。多步用 `&&`、`;`、`$(...)` 或脚本文件。
|
|
30
62
|
- **读完 stdin 的命令不能 `run`**:`ssh`、`sudo -S`、`read`、`git rebase -i`、`passwd` 会把提示符输入当自己的输入吞掉,命令永远等不到结束。这类让用户在面板里手敲,或改用 `open` 起独立进程。
|
|
31
|
-
- **全屏 TUI 不能 `run`**:`vim`、`htop`、`less`
|
|
32
|
-
- **`cwd`
|
|
63
|
+
- **全屏 TUI 不能 `run`**:`vim`、`htop`、`less` 回传给你是一团控制序列。
|
|
64
|
+
- **`cwd` 必须是绝对路径**;不传就用会话工作区。`run` 传了不同目录会前置一次 `cd`,不重建 shell;`open` 用它决定复用哪条全局终端。
|
|
33
65
|
|
|
34
66
|
## 超时与占用:最容易被绊住的一处
|
|
35
67
|
|
|
36
|
-
`run` 默认等 30 秒,可用 `timeoutMs` 上调(上限 9 分钟)。超时**不杀进程**,返回里带 `[仍在运行]
|
|
68
|
+
`run` 默认等 30 秒,可用 `timeoutMs` 上调(上限 9 分钟)。超时**不杀进程**,返回里带 `[仍在运行]`,此时默认终端仍被那条命令占着。
|
|
37
69
|
|
|
38
70
|
**这期间任何新命令都会被拒绝**,报错会带上那条命令的摘要。处理方式只有两种:
|
|
39
71
|
|
|
40
|
-
1.
|
|
41
|
-
2. 认为它确实该停:调 `close` 重建 shell
|
|
72
|
+
1. 等它结束:它吐出提示符时自动解锁;
|
|
73
|
+
2. 认为它确实该停:调 `close` 重建 shell(连带杀掉它的进程),然后重新执行。
|
|
42
74
|
|
|
43
75
|
不要用 `sleep` 之类的命令去「等它结束」——那条命令同样会被拒绝。
|
|
44
76
|
|
|
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
77
|
## 判定成败
|
|
58
78
|
|
|
59
79
|
- 非零退出码**不是工具调用错误**:照常返回输出与退出码,你自己判断下一步。
|
|
60
|
-
- 只有 shell 起不来(找不到 bash、原生模块加载失败)才是 `isError
|
|
61
|
-
- 输出超过 2000 行或 128KB 会截断,末尾标
|
|
80
|
+
- 只有 shell 起不来(找不到 bash、原生模块加载失败)才是 `isError`,报错里会带候选路径。
|
|
81
|
+
- 输出超过 2000 行或 128KB 会截断,末尾标 `…(输出已截断)`;需要更多就缩小命令的范围。
|
|
62
82
|
|
|
63
83
|
## 典型用法
|
|
64
84
|
|
|
65
85
|
```
|
|
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
|
-
|
|
71
|
-
|
|
86
|
+
run "bun run check finchapp/shellGo" # 检查,要结果
|
|
87
|
+
run "git status --short && git log --oneline -5" # 组合命令
|
|
88
|
+
run "rg -n 'TODO' src | head -20" # 读文件内容
|
|
89
|
+
open "bun run dev" cwd="C:/codes/proj/web" # 起前端开发服务
|
|
90
|
+
open "bun run dev" cwd="C:/codes/proj/web" # 改完代码,同一条命令再发一次即重启
|
|
91
|
+
read scope="global" cwd="C:/codes/proj/web" lines=80 # 看启动有没有报错
|
|
92
|
+
interrupt scope="global" cwd="C:/codes/proj/web" # 停掉这个服务
|
|
72
93
|
```
|
|
73
94
|
|
|
74
95
|
## 不要做的事
|
|
75
96
|
|
|
76
|
-
-
|
|
77
|
-
-
|
|
78
|
-
-
|
|
97
|
+
- 不要用 `run` 起服务,也不要用 `open` 跑构建——两条跑道各有归属。
|
|
98
|
+
- 不要为了重启服务去 `kill` 进程或 `close` 终端,再 `open` 一次就够。
|
|
99
|
+
- 不要假设用户没在终端里操作;写入前会清掉他未提交的半行,这是设计好的行为。
|
|
100
|
+
- 不要把全局终端当草稿纸:它是用户眼里的「服务列表」,塞满一次性命令就失去意义了。
|