xkat-cli 1.1.3 → 1.1.5
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 +21 -10
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
# xKat
|
|
1
|
+
# xKat Agent
|
|
2
2
|
|
|
3
|
-
xKat Agent is
|
|
4
|
-
|
|
3
|
+
xKat Agent is an AI agent for your machine. It securely connects your browser
|
|
4
|
+
to your local environment, turning the power of your computer into capabilities
|
|
5
|
+
the web experience can use.
|
|
5
6
|
|
|
6
7
|
## Features
|
|
7
8
|
|
|
8
9
|
- **Zero-install local shell bridge**: Connects the web IDE terminal in your
|
|
9
10
|
browser directly to your local shell. A single `npx xkat up` spawns a native
|
|
10
11
|
shell (PTY) with your current user permissions — no extra install or setup.
|
|
12
|
+
- **Extensible agent**: Designed to grow beyond the terminal, bridging more
|
|
13
|
+
local capabilities over the same secure channel over time.
|
|
11
14
|
- **Real-time file sync**: Watches file changes (VFS) in your local working
|
|
12
15
|
directory and syncs them with the web dashboard instantly.
|
|
13
16
|
- **Security-first design**: Binds to the 127.0.0.1 loopback and verifies the
|
|
14
17
|
request Origin to keep local control safe.
|
|
15
|
-
- **(Optional) SSH mode**: If you provide credentials (user/password), it can
|
|
16
|
-
connect to a local SSH server instead. The default is the zero-install
|
|
17
|
-
direct shell.
|
|
18
18
|
|
|
19
19
|
## Getting started
|
|
20
20
|
|
|
@@ -24,6 +24,17 @@ Run instantly via npm without a separate install:
|
|
|
24
24
|
npx xkat up
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
+
`up` starts the agent in the background and returns immediately, so your
|
|
28
|
+
terminal stays free. Manage it with:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
xkat up # start the agent in the background (alias: start)
|
|
32
|
+
xkat down # stop the background agent (alias: stop)
|
|
33
|
+
xkat status # show whether the agent is running
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Logs are written to `~/.xkat/agent.log`.
|
|
37
|
+
|
|
27
38
|
Or install globally:
|
|
28
39
|
|
|
29
40
|
```bash
|
|
@@ -34,8 +45,6 @@ xkat up
|
|
|
34
45
|
## System requirements
|
|
35
46
|
|
|
36
47
|
- **Node.js**: 16.x or newer.
|
|
37
|
-
- **OpenSSH Server (optional)**: Not needed for the default zero-install shell
|
|
38
|
-
mode. Only required when using the SSH credentials mode.
|
|
39
48
|
|
|
40
49
|
## Security guidelines
|
|
41
50
|
|
|
@@ -55,9 +64,11 @@ See `docs/xkat-agent/deployment-pipeline.md` and
|
|
|
55
64
|
```bash
|
|
56
65
|
cd apps/xkat-agent
|
|
57
66
|
npm version patch --no-git-tag-version
|
|
58
|
-
git add package.json
|
|
67
|
+
git add package.json
|
|
68
|
+
git commit -m "chore(agent): release v$(node -p "require('./package.json').version")"
|
|
69
|
+
git push origin main
|
|
59
70
|
git tag agent-v$(node -p "require('./package.json').version")
|
|
60
|
-
git push origin
|
|
71
|
+
git push origin agent-v$(node -p "require('./package.json').version")
|
|
61
72
|
```
|
|
62
73
|
|
|
63
74
|
## License
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "xkat-cli",
|
|
3
|
-
"version": "1.1.
|
|
4
|
-
"description": "xKat
|
|
3
|
+
"version": "1.1.5",
|
|
4
|
+
"description": "xKat Agent - an AI agent that securely connects your browser to your machine",
|
|
5
5
|
"main": "bin/xkat-cli.js",
|
|
6
6
|
"bin": {
|
|
7
7
|
"xkat": "bin/xkat-cli.js"
|
|
@@ -16,10 +16,10 @@
|
|
|
16
16
|
},
|
|
17
17
|
"keywords": [
|
|
18
18
|
"xkat",
|
|
19
|
-
"
|
|
20
|
-
"
|
|
21
|
-
"
|
|
22
|
-
"
|
|
19
|
+
"ai-agent",
|
|
20
|
+
"agent",
|
|
21
|
+
"local",
|
|
22
|
+
"bridge"
|
|
23
23
|
],
|
|
24
24
|
"author": "SomiLab <contact@somilab.com>",
|
|
25
25
|
"license": "MIT",
|