@_xtribe/cli 2.2.19 → 2.2.21

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.
Files changed (2) hide show
  1. package/README.md +233 -50
  2. package/package.json +14 -8
package/README.md CHANGED
@@ -1,84 +1,267 @@
1
- # TRIBE CLI Installer
1
+ # TRIBE CLI - Privacy-First AI Development Analytics
2
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.
3
+ > **Your AI development data stays on your machine.** Self-host your telemetry, skip authentication entirely, or run completely offline. Full control, zero data sharing.
4
4
 
5
- ## Requirements
5
+ **Key Privacy Features:**
6
+ • 🔒 **Local-only operation** - No data leaves your machine
7
+ • 🏠 **Self-hosting ready** - Run your own telemetry infrastructure
8
+ • 🚫 **Skip authentication** - Test and develop without accounts
9
+ • 📊 **Offline analytics** - Full functionality without internet
6
10
 
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.
11
+ ---
10
12
 
11
- ## Installation
13
+ ## Quick Start (Privacy-First)
12
14
 
15
+ ### Option 1: Local-Only Mode (Recommended for Privacy)
13
16
  ```bash
14
- npx @_xtribe/cli@latest --version
17
+ # Install and run locally - no authentication required
18
+ npx @_xtribe/cli@latest --skip-auth status
19
+
20
+ # Your data never leaves your machine
21
+ npx @_xtribe/cli@latest --localhost enable
22
+ ```
23
+
24
+ ### Option 2: Self-Hosted Infrastructure
25
+ ```bash
26
+ # Download your own telemetry server
27
+ curl -L https://github.com/TRIBE-INC/tutor-server-community-release/releases/latest/download/tutor-server-darwin-arm64 -o tutor-server
28
+ chmod +x tutor-server && ./tutor-server
29
+
30
+ # Connect CLI to YOUR server
31
+ npx @_xtribe/cli@latest --tutor-local enable
32
+ ```
33
+
34
+ ### Option 3: Cloud Service (Optional)
35
+ ```bash
36
+ # Only if you want to use our hosted service
37
+ npx @_xtribe/cli@latest login # Connects to tutor.tribecode.ai
38
+ ```
39
+
40
+ ---
41
+
42
+ ## Privacy & Data Control
43
+
44
+ ### Privacy Flags Reference
45
+ | Flag | Privacy Level | Description |
46
+ |------|---------------|-------------|
47
+ | `--skip-auth` | **Maximum** | No authentication, anonymous usage |
48
+ | `--localhost` | **High** | Force localhost mode for dashboard |
49
+ | `--tutor-local` | **High** | Use local tutor server (localhost:8080) |
50
+ | `--tutor-live` | Standard | Use cloud service (default) |
51
+
52
+ ### Environment Variables for Maximum Privacy
53
+ ```bash
54
+ # Override server URLs for complete control
55
+ export TRIBE_TUTOR_SERVER_URL=http://localhost:8080
56
+ export TRIBE_DASHBOARD_URL=http://localhost:3000
57
+
58
+ # Skip authentication by default
59
+ export TRIBE_SKIP_AUTH=true
15
60
  ```
16
61
 
17
- Running the installer will:
62
+ ### Data Storage Locations
63
+ - **Local telemetry**: `~/.tribe/tutor/` (your machine only)
64
+ - **Anonymous sessions**: `~/.tribe/anonymous-session.json` (skip-auth mode)
65
+ - **Self-hosted**: Your configured server only
66
+ - **Cloud service**: tutor.tribecode.ai (only if you explicitly opt-in)
18
67
 
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).
68
+ ---
23
69
 
24
- > **Tip:** Source `~/.tribe/tribe-env.sh` to use the CLI immediately in the current shell.
70
+ ## Self-Hosting Your Telemetry Infrastructure
25
71
 
26
- ## Usage
72
+ ### Why Self-Host?
73
+ - **Complete data sovereignty** - You own and control all analytics data
74
+ - **Custom analytics** - Modify telemetry collection for your needs
75
+ - **Team deployment** - Private analytics for your organization
76
+ - **Compliance ready** - Meet strict data governance requirements
27
77
 
28
- Launch the CLI with:
78
+ ### Quick Self-Host Setup
29
79
 
80
+ **1. Download Tutor Server** (choose your platform):
30
81
  ```bash
31
- tribe --help
82
+ # macOS Apple Silicon
83
+ curl -L https://github.com/TRIBE-INC/tutor-server-community-release/releases/latest/download/tutor-server-darwin-arm64 -o tutor-server
84
+
85
+ # macOS Intel
86
+ curl -L https://github.com/TRIBE-INC/tutor-server-community-release/releases/latest/download/tutor-server-darwin-amd64 -o tutor-server
87
+
88
+ # Linux x64
89
+ curl -L https://github.com/TRIBE-INC/tutor-server-community-release/releases/latest/download/tutor-server-linux-amd64 -o tutor-server
32
90
  ```
33
91
 
34
- ### Telemetry Commands
92
+ **2. Run Your Private Server**:
93
+ ```bash
94
+ chmod +x tutor-server
95
+ ./tutor-server # Starts on http://localhost:8080
96
+ ```
35
97
 
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. |
98
+ **3. Connect CLI to Your Server**:
99
+ ```bash
100
+ npx @_xtribe/cli@latest --tutor-local enable
101
+ npx @_xtribe/cli@latest --tutor-local status
102
+ ```
42
103
 
43
- ### Authentication Commands
104
+ ---
44
105
 
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. |
106
+ ## Usage Examples
49
107
 
50
- ### Flags
108
+ ### Local Development (No Authentication)
109
+ ```bash
110
+ # Start local telemetry collection without any authentication
111
+ npx @_xtribe/cli@latest --skip-auth enable
51
112
 
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.
113
+ # View your local analytics dashboard
114
+ npx @_xtribe/cli@latest --skip-auth logs
55
115
 
56
- Combine flags with commands, for example `tribe -verbose status`.
116
+ # Check session information (anonymous mode)
117
+ npx @_xtribe/cli@latest --skip-auth config show
118
+ ```
57
119
 
58
- ## Typical Workflow
120
+ ### Self-Hosted Team Workflow
121
+ ```bash
122
+ # Team lead: Start private telemetry server
123
+ ./tutor-server --port 8080
59
124
 
125
+ # Team members: Connect to private server
126
+ TRIBE_TUTOR_SERVER_URL=http://your-server:8080 npx @_xtribe/cli@latest enable
127
+ ```
128
+
129
+ ### Testing Without Data Sharing
60
130
  ```bash
61
- # Install (or upgrade) the CLI
131
+ # Test CLI functionality without any external connections
132
+ npx @_xtribe/cli@latest --skip-auth --localhost status
133
+
134
+ # Reset anonymous session for clean testing
135
+ npx @_xtribe/cli@latest --skip-auth reset-session
136
+ ```
137
+
138
+ ---
139
+
140
+ ## Installation & Commands
141
+
142
+ ### Requirements
143
+ - **Operating systems:** macOS (Intel/Apple Silicon) or Linux
144
+ - **Node.js:** v16 or newer (for npx installation)
145
+ - **Docker:** Optional (only needed for advanced Kubernetes features)
146
+
147
+ ### Core Commands
148
+
149
+ #### Telemetry Commands
150
+ | Command | Description |
151
+ |---------|-------------|
152
+ | `tribe enable` | Start telemetry collection |
153
+ | `tribe disable` | Stop telemetry collection |
154
+ | `tribe status` | Show connection status and recent events |
155
+ | `tribe logs` | View real-time telemetry dashboard |
156
+
157
+ #### Authentication Commands (Optional)
158
+ | Command | Description |
159
+ |---------|-------------|
160
+ | `tribe login` | Authenticate to cloud service |
161
+ | `tribe logout` | Clear stored credentials |
162
+
163
+ #### Privacy Commands
164
+ | Command | Description |
165
+ |---------|-------------|
166
+ | `tribe --skip-auth status` | Check status without authentication |
167
+ | `tribe config show` | View current configuration and privacy settings |
168
+ | `tribe reset-session` | Create new anonymous session (skip-auth mode) |
169
+
170
+ ---
171
+
172
+ ## Privacy Verification & Troubleshooting
173
+
174
+ ### Verify Local-Only Operation
175
+ ```bash
176
+ # Confirm skip-auth mode is active
177
+ npx @_xtribe/cli@latest --skip-auth status
178
+ # Should show: "Authentication: Skip-auth mode (anonymous)"
179
+
180
+ # Check no cloud connections in localhost mode
181
+ npx @_xtribe/cli@latest --localhost status
182
+ # Should show: "Telemetry Mode: Local-only (no remote data)"
183
+ ```
184
+
185
+ ### Common Privacy Configuration Issues
186
+
187
+ **Skip-auth not working?**
188
+ ```bash
189
+ # Ensure you're using the latest version
62
190
  npx @_xtribe/cli@latest --version
63
191
 
64
- # Authenticate and start telemetry
65
- tribe login
66
- tribe status
192
+ # Check skip-auth flag is recognized
193
+ npx @_xtribe/cli@latest --help | grep skip-auth
194
+ ```
195
+
196
+ **Local server connection problems?**
197
+ ```bash
198
+ # Test local tutor server
199
+ curl http://localhost:8080/api/health
67
200
 
68
- # Review logs when troubleshooting
69
- tribe logs
201
+ # Check CLI configuration
202
+ npx @_xtribe/cli@latest config show
70
203
  ```
71
204
 
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.
205
+ **Data location verification:**
206
+ ```bash
207
+ # Check where your data is stored
208
+ ls -la ~/.tribe/tutor/
209
+ ls -la ~/.tribe/anonymous-session.json
210
+ ```
211
+
212
+ ---
213
+
214
+ ## Documentation & Community
215
+
216
+ ### Privacy & Self-Hosting Resources
217
+ - 📖 **[Tutor Server Repository](https://github.com/TRIBE-INC/tutor-server-community-release)** - Open source telemetry server
218
+ - 🚀 **[Latest CLI Releases](https://github.com/TRIBE-INC/releases)** - Download server binaries and release notes
219
+ - 🔧 **[TRIBE Platform Docs](https://github.com/TRIBE-INC/0zen)** - Architecture and self-hosting guides
220
+ - 📊 **[API Documentation](https://github.com/TRIBE-INC/tribe-api)** - REST endpoints for your self-hosted server
221
+
222
+ ### Community & Support
223
+ - 💬 **Community:** Join discussions about privacy-first AI analytics
224
+ - 🐛 **Issues:** [Report bugs or request privacy features](https://github.com/TRIBE-INC/releases/issues)
225
+ - 📧 **Privacy Questions:** Contact us about data sovereignty and self-hosting
226
+ - 📚 **Documentation Portal:** [tribecode.ai/docs](https://tribecode.ai/docs) - Comprehensive guides
227
+
228
+ ---
229
+
230
+ ## Privacy Commitment
231
+
232
+ 🔒 **Your data sovereignty matters.** TRIBE CLI is designed with privacy-first principles:
73
233
 
74
- ## Troubleshooting
234
+ - **Local-by-default**: Core functionality works without data sharing
235
+ - **Self-hosting ready**: Complete control over your analytics infrastructure
236
+ - **Open source**: Transparent telemetry collection you can audit
237
+ - **Anonymous operation**: Skip authentication for testing and development
238
+ - **Zero tracking**: No analytics about your usage patterns in local mode
75
239
 
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.
240
+ ### Data Control Features
241
+ - ✅ **Export your data** anytime in JSON format
242
+ - ✅ **Delete cloud data** on demand (if using cloud service)
243
+ - ✅ **Audit telemetry** - see exactly what data is collected
244
+ - ✅ **Modify collection** - customize telemetry for your needs
79
245
 
80
- ## Additional Resources
246
+ **Questions about privacy?** We're committed to transparency about data handling and self-hosting options.
247
+
248
+ ---
249
+
250
+ ## Typical Privacy-First Workflow
251
+
252
+ ```bash
253
+ # 1. Install and verify local operation
254
+ npx @_xtribe/cli@latest --skip-auth --version
255
+
256
+ # 2. Start anonymous telemetry collection
257
+ npx @_xtribe/cli@latest --skip-auth enable
258
+
259
+ # 3. View your local analytics
260
+ npx @_xtribe/cli@latest --skip-auth logs
261
+
262
+ # 4. Check data stays local
263
+ npx @_xtribe/cli@latest --skip-auth status
264
+ # Confirms: "Telemetry Mode: Local-only (no remote data)"
265
+ ```
81
266
 
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.
267
+ *Want cloud convenience with privacy protection? Our hosted service includes data deletion, export tools, and privacy controls. Local-first operation is always available.*
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@_xtribe/cli",
3
- "version": "2.2.19",
4
- "description": "TRIBE - Track, measure and optimize your AI coding agents to become 10x faster",
3
+ "version": "2.2.21",
4
+ "description": "TRIBE - Privacy-first AI development analytics. Self-host your telemetry, skip authentication, or run completely offline. Your data stays on your machine.",
5
5
  "main": "install-tribe.js",
6
6
  "bin": {
7
7
  "tribe": "./tribe.js",
@@ -10,19 +10,25 @@
10
10
  "setup-path": "./setup-path.js"
11
11
  },
12
12
  "scripts": {
13
- "test": "echo \"Error: no test specified\" && exit 1"
13
+ "test": "echo \"Error: no test specified\" && exit 1",
14
+ "prepublishOnly": "cp README.md README-GITHUB.md && cp NPX-README.md README.md",
15
+ "postpublish": "cp README-GITHUB.md README.md && rm -f README-GITHUB.md"
14
16
  },
15
17
  "keywords": [
16
18
  "tribe",
17
19
  "cli",
18
- "kubernetes",
19
- "docker",
20
- "colima",
21
- "multi-agent",
20
+ "privacy-first",
21
+ "self-hosted",
22
+ "telemetry",
23
+ "analytics",
24
+ "local-only",
22
25
  "ai",
23
26
  "development",
24
27
  "autonomous",
25
- "agents"
28
+ "agents",
29
+ "kubernetes",
30
+ "docker",
31
+ "colima"
26
32
  ],
27
33
  "engines": {
28
34
  "node": ">=16.0.0"