@agentrix/cli 0.0.3 → 0.0.4
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 +69 -0
- package/dist/index.cjs +283 -155
- package/dist/index.mjs +130 -2
- package/dist/lib.cjs +4 -4
- package/dist/lib.mjs +1 -1
- package/dist/{logger-B7C5x_8c.cjs → logger-B4-T7qDc.cjs} +29 -2
- package/dist/{logger-DAsm4mPf.mjs → logger-D0oEaCVA.mjs} +28 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,11 +8,78 @@ Agentrix CLI enables you to run AI agents (Claude or Codex) as background worker
|
|
|
8
8
|
|
|
9
9
|
## Installation
|
|
10
10
|
|
|
11
|
+
### Install from npm (Recommended)
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install -g @agentrix/cli
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Or with yarn:
|
|
18
|
+
|
|
11
19
|
```bash
|
|
20
|
+
yarn global add @agentrix/cli
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### Install from source
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
git clone https://github.com/xmz-ai/agentrix-cli.git
|
|
27
|
+
cd agentrix-cli
|
|
12
28
|
yarn install
|
|
13
29
|
yarn build
|
|
14
30
|
```
|
|
15
31
|
|
|
32
|
+
## Upgrading
|
|
33
|
+
|
|
34
|
+
### Automatic Update Check
|
|
35
|
+
|
|
36
|
+
When you run `agentrix start`, the CLI automatically checks for updates and notifies you if a newer version is available.
|
|
37
|
+
|
|
38
|
+
To disable automatic update checks, set the environment variable:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
export AGENTRIX_DISABLE_UPDATE_CHECK=true
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Or add it to your shell profile (`~/.bashrc`, `~/.zshrc`, etc.):
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
echo 'export AGENTRIX_DISABLE_UPDATE_CHECK=true' >> ~/.zshrc
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Automatic Upgrade (Recommended)
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
agentrix upgrade
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
This command will:
|
|
57
|
+
- Detect your package manager (npm or yarn)
|
|
58
|
+
- Upgrade to the latest version
|
|
59
|
+
- Automatically restart the daemon if it was running
|
|
60
|
+
|
|
61
|
+
### Manual Upgrade
|
|
62
|
+
|
|
63
|
+
You can also upgrade manually:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
# With npm
|
|
67
|
+
npm update -g @agentrix/cli
|
|
68
|
+
|
|
69
|
+
# Or with yarn
|
|
70
|
+
yarn global upgrade @agentrix/cli
|
|
71
|
+
|
|
72
|
+
# Check installed version
|
|
73
|
+
agentrix --version
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
**Note**: After manual upgrade, restart the daemon:
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
agentrix stop
|
|
80
|
+
agentrix start
|
|
81
|
+
```
|
|
82
|
+
|
|
16
83
|
## Quick Start
|
|
17
84
|
|
|
18
85
|
```bash
|
|
@@ -39,6 +106,7 @@ agentrix stop
|
|
|
39
106
|
- `agentrix start` - Start the daemon (if not running) and show status
|
|
40
107
|
- `agentrix stop` - Stop the daemon
|
|
41
108
|
- `agentrix status` - Show daemon and authentication status
|
|
109
|
+
- `agentrix upgrade` - Upgrade CLI to the latest version (auto-restarts daemon)
|
|
42
110
|
- `agentrix ls` - List active worker sessions
|
|
43
111
|
- `agentrix kill <sessionId>` - Stop a specific worker session
|
|
44
112
|
- `agentrix killall` - Clean up all runaway agentrix processes
|
|
@@ -86,6 +154,7 @@ Worker Processes (src/worker/)
|
|
|
86
154
|
| `AGENTRIX_WORKSPACE_HOME_DIR` | `~/.agentrix/workspaces` | Workspace directory |
|
|
87
155
|
| `AGENTRIX_AGENTS_HOME_DIR` | `~/.agentrix/agents` | Agent configs directory |
|
|
88
156
|
| `AGENTRIX_DISABLE_CAFFEINATE` | `false` | Disable sleep prevention |
|
|
157
|
+
| `AGENTRIX_DISABLE_UPDATE_CHECK` | `false` | Disable automatic update check on start |
|
|
89
158
|
| `DEBUG` | - | Enable debug logging |
|
|
90
159
|
|
|
91
160
|
### State Files
|