├── .github
└── workflows
│ └── npm-publish.yml
├── .gitignore
├── .npmignore
├── README.md
├── cli.js
├── frontend
├── index.css
└── index.tsx
├── init.mjs
├── package-lock.json
├── package.json
├── pnpm-lock.yaml
├── publish.mjs
├── src
├── commander.ts
├── index.mts
├── main.mts
├── server.ts
└── shell.ts
├── tsconfig.json
└── webpack.config.js
/.github/workflows/npm-publish.yml:
--------------------------------------------------------------------------------
1 | # This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
2 | # For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
3 |
4 | name: Node.js Package
5 |
6 | on:
7 | workflow_dispatch: {}
8 | push:
9 | branches:
10 | - main
11 | release:
12 | types: [created]
13 |
14 | jobs:
15 | build:
16 | runs-on: ubuntu-latest
17 | steps:
18 | - uses: actions/checkout@v4
19 | - uses: actions/setup-node@v4
20 | with:
21 | node-version: 20
22 | - run: echo "success"
23 | # - run: npm test
24 |
25 | publish-npm:
26 | needs: build
27 | runs-on: ubuntu-latest
28 | steps:
29 | - uses: actions/checkout@v4
30 | - uses: actions/setup-node@v4
31 | with:
32 | node-version: 20
33 | registry-url: https://registry.npmjs.org/
34 | - run: npm install
35 | - run: npm publish
36 | env:
37 | NODE_AUTH_TOKEN: ${{secrets.npm_token}}
38 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | dist/
2 | node_modules/
3 | lib/
4 | build/
5 | tests/
6 | *.log
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | node_modules/
2 | frontend/
3 | src/
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ```
2 | npx -y hyper-mcp-terminal
3 | ```
4 |
5 |
6 |
7 | ## 普通安装
8 |
9 | ```
10 | command: npx
11 |
12 | args: -y hyper-mcp-terminal
13 |
14 | env:
15 | //(可选) 通过输出不变来判断是否结束 默认是 15次，检测间隔是100ms，也就是1.5s输出一直不变，表示命令结束了
16 | Terminal_End_CheckCount || 15;
17 | //(可选) 终端输出最大长度给大模型的
18 | Terminal_Output_MaxToken || 10000
19 | //(可选) 终端 5分钟 没输入挂掉
20 | Terminal_Timeout || 5 * 60 * 1000
21 | ```
22 |
23 | ### 失败解决办法
24 |
25 | 1. 很多人安装失败，可能是这个依赖微软的[node-pty](https://github.com/microsoft/node-pty?tab=readme-ov-file#dependencies)，它又依赖C++环境。[教程][node-pty](https://github.com/microsoft/node-pty?tab=readme-ov-file#dependencies)
26 |
27 | ## 使用图片
28 |
29 | 
30 |
31 | 
32 |
33 |
34 | 
35 |
36 | ## 演示视频
37 | https://www.youtube.com/watch?v=fVeUWu2Cvk0
38 |
39 | ## Usage
40 |
41 | ### hyperchat安装方式 [下载地址](https://github.com/BigSweetPotatoStudio/HyperChat)
42 |
43 | 
44 |
45 |
46 |
--------------------------------------------------------------------------------
/cli.js:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env node
2 | require('./lib/server');
3 |
4 |
--------------------------------------------------------------------------------
/frontend/index.css:
--------------------------------------------------------------------------------
1 | #root {
2 | height: calc(100%);
3 | }
4 |
5 | .container {
6 | display: flex;
7 | height: calc(100%);
8 | }
9 |
10 | #terminal {
11 | flex-grow: 1;
12 | /* width: 70%; */
13 | }
14 |
15 | #cmds {
16 | width: 350px;
17 | }
--------------------------------------------------------------------------------
/frontend/index.tsx:
--------------------------------------------------------------------------------
1 | import React, { useState, useEffect } from "react";
2 | import { createRoot } from "react-dom/client";
3 | import {
4 | Button,
5 | ConfigProvider,
6 | DatePicker,
7 | message,
8 | Input,
9 | Divider,
10 | List,
11 | Typography,
12 | } from "antd";
13 | // 由于 antd 组件的默认文案是英文，所以需要修改为中文
14 | import zhCN from "antd/lib/locale/zh_CN";
15 | import moment from "moment";
16 | import "moment/locale/zh-cn";
17 | import "antd/dist/antd.css";
18 | import "@xterm/xterm/css/xterm.css";
19 | import "./index.css";
20 | import { Terminal } from "@xterm/xterm";
21 | import { FitAddon } from "@xterm/addon-fit";
22 | import { WebLinksAddon } from "@xterm/addon-web-links";
23 |
24 | import { io } from "socket.io-client";
25 | import querystring from "querystring-es3";
26 | const TextArea = Input.TextArea;
27 | const Item = List.Item;
28 | import { PlusSquareOutlined } from "@ant-design/icons";
29 |
30 | moment.locale("zh-cn");
31 | const socket = io(document.location.origin, {
32 | path: "/bash/",
33 | auth: {
34 | passwd: querystring.parse(window.location.search.slice(1)).passwd || "",
35 | },
36 | });
37 | socket.on("connect", function () {
38 | console.log("connected");
39 | // socket.emit("shell", 'ls\n');
40 | // socket.emit("shell", 'ls -l\n');
41 | });
42 |
43 | const { Search } = Input;
44 |
45 | function concatenate(...arrays) {
46 | let totalLen = 0;
47 |
48 | for (let arr of arrays) totalLen += arr.byteLength;
49 |
50 | let res = new Uint8Array(totalLen);
51 |
52 | let offset = 0;
53 |
54 | for (let arr of arrays) {
55 | let uint8Arr = new Uint8Array(arr);
56 |
57 | res.set(uint8Arr, offset);
58 |
59 | offset += arr.byteLength;
60 | }
61 |
62 | return res.buffer;
63 | }
64 | const origin_cmds = [];
65 |
66 | let ResulData = new ArrayBuffer(0);
67 |
68 | function _translateBufferLineToStringWithWrap(
69 | lineIndex: number,
70 | trimRight: boolean,
71 | terminal: Terminal
72 | ): [string, number] {
73 | let lineString = "";
74 | let lineWrapsToNext: boolean;
75 | let prevLinesToWrap: boolean;
76 |
77 | do {
78 | const line = terminal.buffer.active.getLine(lineIndex);
79 | if (!line) {
80 | break;
81 | }
82 |
83 | if (line.isWrapped) {
84 | lineIndex--;
85 | }
86 |
87 | prevLinesToWrap = line.isWrapped;
88 | } while (prevLinesToWrap);
89 |
90 | const startLineIndex = lineIndex;
91 |
92 | do {
93 | const nextLine = terminal.buffer.active.getLine(lineIndex + 1);
94 | lineWrapsToNext = nextLine ? nextLine.isWrapped : false;
95 | const line = terminal.buffer.active.getLine(lineIndex);
96 | if (!line) {
97 | break;
98 | }
99 | lineString += line
100 | .translateToString(!lineWrapsToNext && trimRight)
101 | .substring(0, terminal.cols);
102 | lineIndex++;
103 | } while (lineWrapsToNext);
104 |
105 | return [lineString, startLineIndex];
106 | }
107 |
108 | const App = () => {
109 | let [result, setResult] = useState("");
110 | let [cmds, setCmds] = useState(origin_cmds);
111 | const [inputText, setInputText] = useState("");
112 | useEffect(function () {
113 | let dom = document.getElementById("terminal")!;
114 | var term = new Terminal({
115 | cols: 80,
116 | rows: 30,
117 | });
118 | // term.open(document.getElementById('terminal'));
119 | // term.write('Hello from \x1B[1;3;31mxterm.js\x1B[0m $ ')
120 | // return;
121 | const fitAddon = new FitAddon();
122 | term.loadAddon(fitAddon);
123 | term.loadAddon(new WebLinksAddon());
124 | term.open(dom);
125 | fitAddon.fit();
126 | window.onresize = () => {
127 | fitAddon.fit();
128 | };
129 |
130 | // setInterval(() => {
131 | // console.log(_translateBufferLineToStringWithWrap(-1, false,term));
132 | // }, 10000)
133 |
134 | term.onData(function (data) {
135 | console.log(data);
136 | socket.emit("shell", data);
137 | });
138 |
139 | socket.on("shell", (data) => {
140 | term.write(data);
141 | });
142 | socket.on("disconnect", function () {
143 | console.log("user disconnected");
144 | });
145 | }, []);
146 | return (
147 |
148 |
149 |
150 | {/*
151 |
152 | className="list"
153 | size="small"
154 | bordered
155 | dataSource={cmds}
156 | renderItem={(item) => (
157 | -
158 |
209 |
210 | )}
211 | />
212 |
218 |
235 | */}
236 |