@workrail/cli 0.2.0 → 0.2.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.
Files changed (3) hide show
  1. package/README.md +105 -3
  2. package/package.json +13 -3
  3. package/scripts/postinstall.mjs +8 -5
package/README.md CHANGED
@@ -1,7 +1,109 @@
1
- # @workrail/cli
1
+ # Workrail CLI
2
2
 
3
- Install globally:
3
+ Track your engineering work, capture achievements, and build a career record from your terminal.
4
+
5
+ ## Installation
6
+
7
+ Install globally with npm:
4
8
 
5
9
  ```bash
6
- npm i -g @workrail/cli
10
+ npm install -g @workrail/cli
11
+ ```
12
+
13
+ **Requirements:** Node.js 18+ (automatically installed with the CLI)
14
+
15
+ ## Supported Platforms
16
+
17
+ - **macOS** (Apple Silicon & Intel)
18
+ - **Linux** (x64 & ARM64)
19
+ - **Windows** (x64)
20
+
21
+ The CLI automatically downloads the correct binary for your platform during installation.
22
+
23
+ ## Quick Start
24
+
25
+ 1. **Authenticate** (opens browser):
26
+
27
+ ```bash
28
+ workrail auth login
29
+ ```
30
+
31
+ 2. **Link your repository** to a Workrail project:
32
+
33
+ ```bash
34
+ workrail link
35
+ ```
36
+
37
+ 3. **Sync your work** (captures commit metadata, not source code):
38
+
39
+ ```bash
40
+ workrail sync
41
+ ```
42
+
43
+ 4. **Enable autosync** (optional - runs sync on a schedule):
44
+
45
+ ```bash
46
+ workrail autosync enable
47
+ ```
48
+
49
+ 5. **View your dashboard** at [workrail.dev](https://workrail.dev)
50
+
51
+ ## Common Commands
52
+
53
+ | Command | Description |
54
+ | --------------------------- | --------------------------------------- |
55
+ | `workrail auth login` | Authenticate via browser OAuth |
56
+ | `workrail auth status` | Check authentication status |
57
+ | `workrail link` | Link current repo to a Workrail project |
58
+ | `workrail sync` | Sync commits and create entries |
59
+ | `workrail status` | View sync status and linked repos |
60
+ | `workrail autosync enable` | Enable automatic syncing |
61
+ | `workrail autosync status` | Check autosync status |
62
+ | `workrail autosync disable` | Disable automatic syncing |
63
+ | `workrail --version` | Show CLI version |
64
+ | `workrail --help` | Show all available commands |
65
+
66
+ ## Privacy
67
+
68
+ Workrail syncs **metadata only** (commit hashes, timestamps, messages). Your source code never leaves your machine. [Read more about our privacy practices](https://workrail.dev/privacy).
69
+
70
+ ## Updating
71
+
72
+ To update to the latest version:
73
+
74
+ ```bash
75
+ npm update -g @workrail/cli
76
+ ```
77
+
78
+ ## Uninstalling
79
+
80
+ ```bash
81
+ npm uninstall -g @workrail/cli
82
+ ```
83
+
84
+ ## Troubleshooting
85
+
86
+ **Installation fails or binary not found:**
87
+
88
+ - Ensure Node.js 18+ is installed: `node --version`
89
+ - Try reinstalling: `npm uninstall -g @workrail/cli && npm install -g @workrail/cli`
90
+
91
+ **Authentication issues:**
92
+
93
+ - Run `workrail auth login` again to re-authenticate
94
+ - Check status with `workrail auth status`
95
+
96
+ **Sync not working:**
97
+
98
+ - Ensure you're in a git repository
99
+ - Run `workrail link` to link the repo first
100
+ - Check `workrail status` to verify repo is linked
101
+
102
+ ## Support
103
+
104
+ - Documentation: [workrail.dev/docs](https://workrail.dev/docs)
105
+ - Email: aimen@aviatolabs.xyz
106
+
107
+ ## License
7
108
 
109
+ Proprietary - All rights reserved © 2026 AVIATOLABS FZ-LLC
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@workrail/cli",
3
- "version": "0.2.0",
4
- "description": "Workrail CLI installer wrapper",
3
+ "version": "0.2.1",
4
+ "description": "Workrail CLI - Track your engineering work and build a career record",
5
5
  "license": "UNLICENSED",
6
6
  "bin": {
7
7
  "workrail": "bin/workrail.js"
@@ -19,5 +19,15 @@
19
19
  },
20
20
  "engines": {
21
21
  "node": ">=18"
22
- }
22
+ },
23
+ "keywords": [
24
+ "cli",
25
+ "career",
26
+ "productivity",
27
+ "git",
28
+ "engineering",
29
+ "achievements"
30
+ ],
31
+ "author": "AVIATOLABS FZ-LLC",
32
+ "homepage": "https://workrail.dev"
23
33
  }
package/scripts/postinstall.mjs CHANGED
@@ -1,7 +1,7 @@
1
+ import crypto from "node:crypto";
1
2
  import fs from "node:fs";
2
- import path from "node:path";
3
3
  import https from "node:https";
4
- import crypto from "node:crypto";
4
+ import path from "node:path";
5
5
  import { fileURLToPath } from "node:url";
6
6
 
7
7
  const __filename = fileURLToPath(import.meta.url);
@@ -98,10 +98,12 @@ async function main() {
98
98
  const checksumsUrl = `${baseUrl}/checksums.txt`;
99
99
  const targetPath = path.join(nativeDir, binaryName);
100
100
 
101
- console.log(`[workrail] Downloading ${binaryName}...`);
101
+ console.log(
102
+ `📦 Installing Workrail CLI for ${process.platform} (${process.arch})...`,
103
+ );
102
104
  await downloadToFile(binUrl, targetPath);
103
105
 
104
- console.log("[workrail] Verifying checksum...");
106
+ console.log("🔒 Verifying download...");
105
107
  const checksums = parseChecksums(await downloadText(checksumsUrl));
106
108
  const expected = checksums.get(binaryName);
107
109
 
@@ -120,7 +122,8 @@ async function main() {
120
122
  fs.chmodSync(targetPath, 0o755);
121
123
  }
122
124
 
123
- console.log("[workrail] Binary installed successfully.");
125
+ console.log("✅ Workrail CLI installed successfully!");
126
+ console.log("🚀 Run 'workrail auth login' to get started.");
124
127
  }
125
128
 
126
129
  main().catch((err) => {