@_xtribe/cli 2.0.4 → 2.0.6
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 +84 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# TRIBE CLI Installer
|
|
2
|
+
|
|
3
|
+
Automate your TRIBE development environment with a single command. This npm package delivers the latest TRIBE CLI binary, bootstraps required dependencies (Colima, kubectl, container runtime), and wires the CLI into your shell `PATH` so you can start managing telemetry and authentication immediately.
|
|
4
|
+
|
|
5
|
+
## Requirements
|
|
6
|
+
|
|
7
|
+
- **Operating systems:** macOS (Intel/Apple Silicon) or Linux
|
|
8
|
+
- **Node.js:** v16 or newer (the installer runs via `npx`)
|
|
9
|
+
- **Docker alternative:** The installer provisions Colima automatically; you can skip it with `--skip-cluster` if you already have a configured runtime.
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx @_xtribe/cli@latest --version
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Running the installer will:
|
|
18
|
+
|
|
19
|
+
1. Detect your platform and download the matching TRIBE CLI binary.
|
|
20
|
+
2. Install or verify Colima, kubectl, and supporting services.
|
|
21
|
+
3. Place the CLI at `~/.tribe/bin/tribe` and configure your shell `PATH` via `~/.tribe/tribe-env.sh`.
|
|
22
|
+
4. Start the local container runtime (unless it is already running).
|
|
23
|
+
|
|
24
|
+
> **Tip:** Source `~/.tribe/tribe-env.sh` to use the CLI immediately in the current shell.
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
Launch the CLI with:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
tribe --help
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Telemetry Commands
|
|
35
|
+
|
|
36
|
+
| Command | Description |
|
|
37
|
+
| -------------- | --------------------------------------------- |
|
|
38
|
+
| `tribe enable` | Start the tutor telemetry collector daemon. |
|
|
39
|
+
| `tribe disable`| Stop the collector and disable auto-start. |
|
|
40
|
+
| `tribe status` | Display OAuth status, collector health, and recent event counts. |
|
|
41
|
+
| `tribe logs` | Tail the telemetry collector log file. |
|
|
42
|
+
|
|
43
|
+
### Authentication Commands
|
|
44
|
+
|
|
45
|
+
| Command | Description |
|
|
46
|
+
| --------------- | ------------------------------------------------------------------ |
|
|
47
|
+
| `tribe login` | Launches the TRIBE OAuth flow (opens browser, handles callback, stores tokens in `~/.tribe/tutor/auth.json`). |
|
|
48
|
+
| `tribe logout` | Removes stored credentials and stops authenticated telemetry. |
|
|
49
|
+
|
|
50
|
+
### Flags
|
|
51
|
+
|
|
52
|
+
- `-localhost` — Force localhost mode (auto-starts local tutor services instead of production).
|
|
53
|
+
- `-verbose` — Emit verbose installer or runtime logs for debugging.
|
|
54
|
+
- `-beta` — Enable advanced/beta commands when available.
|
|
55
|
+
|
|
56
|
+
Combine flags with commands, for example `tribe -verbose status`.
|
|
57
|
+
|
|
58
|
+
## Typical Workflow
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
# Install (or upgrade) the CLI
|
|
62
|
+
npx @_xtribe/cli@latest --version
|
|
63
|
+
|
|
64
|
+
# Authenticate and start telemetry
|
|
65
|
+
tribe login
|
|
66
|
+
tribe status
|
|
67
|
+
|
|
68
|
+
# Review logs when troubleshooting
|
|
69
|
+
tribe logs
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Successful authentication writes fresh tokens and the collector begins pushing events to `https://tutor.tribecode.ai`. Run `tribe status` any time to confirm the collector PID, uptime, and recent event totals.
|
|
73
|
+
|
|
74
|
+
## Troubleshooting
|
|
75
|
+
|
|
76
|
+
- **OAuth callback shows a blank page:** This is expected once the CLI captures the code. Check the terminal for `✅ Authorization received` and rerun `tribe status` to confirm.
|
|
77
|
+
- **Collector reports `TOKEN_VALIDATION_FAILED`:** Refresh credentials with `tribe login` and ensure the collector restarts (`tribe disable && tribe enable`).
|
|
78
|
+
- **PATH not updated:** Source `~/.tribe/tribe-env.sh` or add `export PATH="$HOME/.tribe/bin:$PATH"` to your shell profile.
|
|
79
|
+
|
|
80
|
+
## Additional Resources
|
|
81
|
+
|
|
82
|
+
- [TRIBE CLI & Platform Docs](https://github.com/TRIBE-INC/0zen) — architecture overviews, local setup, and troubleshooting guides.
|
|
83
|
+
- [TRIBE API Reference](https://github.com/TRIBE-INC/tribe-api) — REST endpoints for retrieving telemetry, session insights, and system metadata.
|
|
84
|
+
- [TRIBE Documentation Portal](https://docs.tribecode.ai/) — centralized guides, onboarding flows, and deep dives into telemetry processing.
|