k4tron 0.2.0
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 +77 -0
- package/dist/cli.mjs +1059 -0
- package/package.json +45 -0
package/README.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# k4tron
|
|
2
|
+
|
|
3
|
+
An interactive AI coding agent that runs in your terminal — on any OS, next to
|
|
4
|
+
any editor. It reads, writes, and runs code in the folder you point it at,
|
|
5
|
+
asking for your approval before anything sensitive.
|
|
6
|
+
|
|
7
|
+
**Website**: [k4tron.com](https://k4tron.com) · **Your account**:
|
|
8
|
+
[app.k4tron.com](https://app.k4tron.com)
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
npm install -g k4tron
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Or run it directly, no install:
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
npx k4tron
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Quick start
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
cd your-project
|
|
24
|
+
k4tron
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
On first run, connect the machine to your k4tron account — grab a device token
|
|
28
|
+
at [app.k4tron.com](https://app.k4tron.com) (**Devices**), then:
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
/connect <your-token>
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Then just type. The agent works on the current folder (or `--workspace <dir>`),
|
|
35
|
+
streams its reasoning and tool calls into the feed, and shows every file change
|
|
36
|
+
as a reviewable diff.
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
k4tron [--workspace <dir>] [--session <id>]
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Commands
|
|
43
|
+
|
|
44
|
+
| Command | What it does |
|
|
45
|
+
|---|---|
|
|
46
|
+
| `/help` | show help |
|
|
47
|
+
| `/new` | start a fresh session in this workspace |
|
|
48
|
+
| `/sessions` | pick up an existing session |
|
|
49
|
+
| `/preset <slug>` | switch preset: `lite` · `basic` · `standard` · `premium` |
|
|
50
|
+
| `/mode <free\|swarm>` | switch supervisor mode |
|
|
51
|
+
| `/auto` | toggle auto-approve for gated actions |
|
|
52
|
+
| `/compact` | compact the conversation context now |
|
|
53
|
+
| `/account` | show account & credits |
|
|
54
|
+
| `/connect <token>` | connect this machine to your k4tron account |
|
|
55
|
+
| `/disconnect` | disconnect |
|
|
56
|
+
| `/clear` | clear the on-screen feed (context untouched) |
|
|
57
|
+
| `/quit` | exit |
|
|
58
|
+
|
|
59
|
+
**Keys** — `Enter` sends · `Esc` cancels the running turn. On an approval
|
|
60
|
+
prompt: `y` approve · `n` deny · `a` approve and auto-approve the rest.
|
|
61
|
+
|
|
62
|
+
## Sessions
|
|
63
|
+
|
|
64
|
+
Sessions are persistent and workspace-aware: quit, come back tomorrow, and
|
|
65
|
+
`/sessions` resumes where you left off — full context included. State (sessions,
|
|
66
|
+
preferences, auth) lives in your user data directory (`~/.k4tron` on
|
|
67
|
+
Linux/macOS, `%LOCALAPPDATA%\k4tron` on Windows), never inside your project.
|
|
68
|
+
|
|
69
|
+
## Requirements
|
|
70
|
+
|
|
71
|
+
- Node.js >= 20
|
|
72
|
+
- A k4tron account — sign up at [k4tron.com](https://k4tron.com)
|
|
73
|
+
|
|
74
|
+
## License
|
|
75
|
+
|
|
76
|
+
Proprietary. The `k4tron` CLI is free to install; usage is billed through your
|
|
77
|
+
[k4tron account](https://app.k4tron.com).
|