@heygaia/cli 0.5.0 → 0.7.0-beta.1
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 +47 -8
- package/dist/index.js +134 -47
- package/package.json +12 -5
package/README.md
CHANGED
|
@@ -8,14 +8,21 @@ CLI tool for setting up and managing [GAIA](https://heygaia.io).
|
|
|
8
8
|
|
|
9
9
|
- **Node.js 20+** and one package manager (npm, pnpm, or bun)
|
|
10
10
|
- **macOS or Linux** (Windows via WSL2)
|
|
11
|
-
- **Docker**
|
|
11
|
+
- **Docker** — `gaia up` offers to install it on apt-based Linux when missing
|
|
12
12
|
- **Git** installed
|
|
13
13
|
|
|
14
14
|
The CLI checks prerequisites at startup and reports what is missing.
|
|
15
15
|
|
|
16
16
|
## Installation
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
The standalone installer sets up Node.js if needed and installs the CLI:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
curl -fsSL https://heygaia.io/install.sh | sh
|
|
22
|
+
gaia up
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Or install globally with your preferred package manager:
|
|
19
26
|
|
|
20
27
|
```bash
|
|
21
28
|
npm install -g @heygaia/cli
|
|
@@ -26,21 +33,53 @@ bun add -g @heygaia/cli
|
|
|
26
33
|
## Commands
|
|
27
34
|
|
|
28
35
|
```bash
|
|
29
|
-
gaia
|
|
36
|
+
gaia up # One-command self-host: configure, pull and start
|
|
37
|
+
gaia init # Developer setup wizard (clone, configure, start)
|
|
30
38
|
gaia setup # Configure existing repo
|
|
31
39
|
gaia start # Start services in self-host mode
|
|
32
40
|
gaia dev # Developer mode (Nx TUI)
|
|
33
41
|
gaia dev full # Developer mode + workers (Nx TUI)
|
|
34
42
|
gaia logs # Stream running logs
|
|
35
43
|
gaia stop # Stop all services
|
|
36
|
-
gaia status #
|
|
44
|
+
gaia status # Services and every dependency, with latency
|
|
45
|
+
gaia doctor # Diagnose a GAIA install, with a fix per problem
|
|
46
|
+
gaia update # Move to the GAIA release this CLI ships
|
|
47
|
+
gaia backup # Dump MongoDB + PostgreSQL
|
|
48
|
+
gaia restore # Restore those dumps
|
|
37
49
|
gaia --version # Show CLI version
|
|
38
50
|
gaia --help # Show all commands
|
|
39
51
|
```
|
|
40
52
|
|
|
53
|
+
### `gaia up`
|
|
54
|
+
|
|
55
|
+
One-command self-hosted setup: checks prerequisites (installing Docker on apt-based Linux with consent), clones GAIA to `~/gaia` if needed, writes the configuration, pulls the published images and starts the stack. GAIA is served on a single port (default 3000) through a bundled Caddy proxy.
|
|
56
|
+
|
|
57
|
+
| Flag | Description |
|
|
58
|
+
|------|-------------|
|
|
59
|
+
| `--yes` | No prompts; also consents to installing Docker |
|
|
60
|
+
| `--domain <domain>` | Serve at `https://<domain>` with an automatic certificate (ports 80 and 443) |
|
|
61
|
+
| `--web-port <port>` | Host port GAIA is served on (default 3000) |
|
|
62
|
+
| `--llm-provider <name>` | AI provider to save once GAIA is up, as the setup wizard would: `openrouter`, `gemini`, `openai`, `ollama` or `custom`. Not with `--no-start` |
|
|
63
|
+
| `--llm-key <key>` | API key for `openrouter`, `gemini`, `openai` and `custom` |
|
|
64
|
+
| `--llm-base-url <url>` | Endpoint for `ollama` (default `http://host.docker.internal:11434`) or `custom` (required) |
|
|
65
|
+
| `--llm-model <model>` | Model for `ollama` (optional) or `custom` (required) |
|
|
66
|
+
| `--code-sandbox` / `--no-code-sandbox` | Run agent code in local containers through the host Docker socket (root-equivalent; saved for later starts and updates) |
|
|
67
|
+
| `--build` | Build images from the checkout instead of pulling |
|
|
68
|
+
| `--no-start` | Configure only |
|
|
69
|
+
|
|
70
|
+
### `gaia update`
|
|
71
|
+
|
|
72
|
+
Moves the install to the GAIA release this CLI version ships: pulls its `v<version>` images (nothing changes if that fails), checks out the matching `cli-v<version>` compose files, pins `GAIA_VERSION` in `infra/docker/.env`, restarts, and prints what changed. Volumes and `.env` files are preserved.
|
|
73
|
+
|
|
74
|
+
| Flag | Description |
|
|
75
|
+
|------|-------------|
|
|
76
|
+
| `--yes` | Skip the confirmation |
|
|
77
|
+
| `--version <tag>` | Pin this image tag instead of the CLI's release |
|
|
78
|
+
| `--git` | Contributors: pull the current branch and rebuild the images from source |
|
|
79
|
+
|
|
41
80
|
### `gaia init`
|
|
42
81
|
|
|
43
|
-
|
|
82
|
+
The full interactive wizard, mainly for contributors (developer mode, Infisical). Self-hosters use `gaia up`.
|
|
44
83
|
|
|
45
84
|
| Flag | Description |
|
|
46
85
|
|------|-------------|
|
|
@@ -66,7 +105,7 @@ gaia start
|
|
|
66
105
|
Optional flags:
|
|
67
106
|
|
|
68
107
|
- `--build` rebuild Docker images before starting
|
|
69
|
-
- `--pull` pull
|
|
108
|
+
- `--pull` pull the images again before starting
|
|
70
109
|
|
|
71
110
|
### `gaia dev` / `gaia dev full`
|
|
72
111
|
|
|
@@ -85,7 +124,7 @@ Stops running GAIA services.
|
|
|
85
124
|
|
|
86
125
|
### `gaia status`
|
|
87
126
|
|
|
88
|
-
Shows health and latency for
|
|
127
|
+
Shows health and latency for the services, plus every dependency the API reports at `GET /health/ready` (MongoDB, PostgreSQL, Redis, RabbitMQ, ChromaDB) with a fix for each failing one.
|
|
89
128
|
|
|
90
129
|
## Setup Modes
|
|
91
130
|
|
|
@@ -94,7 +133,7 @@ Shows health and latency for core services.
|
|
|
94
133
|
|
|
95
134
|
## Port Overrides
|
|
96
135
|
|
|
97
|
-
When port conflicts are detected, overrides are written to `infra/docker/.env`.
|
|
136
|
+
When port conflicts are detected, overrides are written to `infra/docker/.env`. In self-host mode only the proxy port (`WEB_HOST_PORT`, plus `HTTPS_HOST_PORT` with a domain) is published.
|
|
98
137
|
|
|
99
138
|
## Development
|
|
100
139
|
|