@workrail/cli 0.2.0 → 0.2.2

package/README.md

@@ -1,7 +1,151 @@
-# @workrail/cli
+# Workrail CLI
 
-Install globally:
+Track your engineering work, capture achievements, and build a career record from your terminal.
+
+## Installation
+
+Install globally using your preferred package manager:
+
+**npm:**
+
+```bash
+npm install -g @workrail/cli
+```
+
+**pnpm:**
+
+```bash
+pnpm add -g @workrail/cli
+```
+
+**bun:**
+
+```bash
+bun add -g @workrail/cli
+```
+
+**Requirements:** Node.js 18+ (automatically installed with the CLI)
+
+## Supported Platforms
+
+- **macOS** (Apple Silicon & Intel)
+- **Linux** (x64 & ARM64)
+- **Windows** (x64)
+
+The CLI automatically downloads the correct binary for your platform during installation.
+
+## Quick Start
+
+1. **Authenticate** (opens browser):
+
+   ```bash
+   workrail auth login
+   ```
+
+2. **Link your repository** to a Workrail project:
+
+   ```bash
+   workrail link
+   ```
+
+3. **Sync your work** (captures commit metadata, not source code):
+
+   ```bash
+   workrail sync
+   ```
+
+4. **Enable autosync** (optional - runs sync on a schedule):
+
+   ```bash
+   workrail autosync enable
+   ```
+
+5. **View your dashboard** at [workrail.dev](https://workrail.dev)
+
+## Common Commands
+
+| Command                     | Description                             |
+| --------------------------- | --------------------------------------- |
+| `workrail auth login`       | Authenticate via browser OAuth          |
+| `workrail auth status`      | Check authentication status             |
+| `workrail link`             | Link current repo to a Workrail project |
+| `workrail sync`             | Sync commits and create entries         |
+| `workrail status`           | View sync status and linked repos       |
+| `workrail autosync enable`  | Enable automatic syncing                |
+| `workrail autosync status`  | Check autosync status                   |
+| `workrail autosync disable` | Disable automatic syncing               |
+| `workrail --version`        | Show CLI version                        |
+| `workrail --help`           | Show all available commands             |
+
+## Privacy
+
+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).
+
+## Updating
+
+To update to the latest version:
+
+**npm:**
+
+```bash
+npm update -g @workrail/cli
+```
+
+**pnpm:**
 
 ```bash
-npm i -g @workrail/cli
+pnpm update -g @workrail/cli
+```
+
+**bun:**
+
+```bash
+bun update -g @workrail/cli
+```
+
+## Uninstalling
+
+**npm:**
+
+```bash
+npm uninstall -g @workrail/cli
+```
+
+**pnpm:**
+
+```bash
+pnpm remove -g @workrail/cli
+```
+
+**bun:**
+
+```bash
+bun remove -g @workrail/cli
+```
+
+## Troubleshooting
+
+**Installation fails or binary not found:**
+
+- Ensure Node.js 18+ is installed: `node --version`
+- Try reinstalling: `npm uninstall -g @workrail/cli && npm install -g @workrail/cli`
+
+**Authentication issues:**
+
+- Run `workrail auth login` again to re-authenticate
+- Check status with `workrail auth status`
+
+**Sync not working:**
+
+- Ensure you're in a git repository
+- Run `workrail link` to link the repo first
+- Check `workrail status` to verify repo is linked
+
+## Support
+
+- Documentation: [workrail.dev/docs](https://workrail.dev/docs)
+- Email: aimen@aviatolabs.xyz
+
+## License
 
+Proprietary - All rights reserved © 2026 AVIATOLABS FZ-LLC

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@workrail/cli",
-	"version": "0.2.0",
-	"description": "Workrail CLI installer wrapper",
+	"version": "0.2.2",
+	"description": "Workrail CLI - Track your engineering work and build a career record",
 	"license": "UNLICENSED",
 	"bin": {
 		"workrail": "bin/workrail.js"
@@ -19,5 +19,15 @@
 	},
 	"engines": {
 		"node": ">=18"
-	}
+	},
+	"keywords": [
+		"cli",
+		"career",
+		"productivity",
+		"git",
+		"engineering",
+		"achievements"
+	],
+	"author": "AVIATOLABS FZ-LLC",
+	"homepage": "https://workrail.dev"
 }

package/scripts/postinstall.mjs

@@ -1,7 +1,7 @@
+import crypto from "node:crypto";
 import fs from "node:fs";
-import path from "node:path";
 import https from "node:https";
-import crypto from "node:crypto";
+import path from "node:path";
 import { fileURLToPath } from "node:url";
 
 const __filename = fileURLToPath(import.meta.url);
@@ -98,10 +98,12 @@ async function main() {
 	const checksumsUrl = `${baseUrl}/checksums.txt`;
 	const targetPath = path.join(nativeDir, binaryName);
 
-	console.log(`[workrail] Downloading ${binaryName}...`);
+	console.log(
+		`📦 Installing Workrail CLI for ${process.platform} (${process.arch})...`,
+	);
 	await downloadToFile(binUrl, targetPath);
 
-	console.log("[workrail] Verifying checksum...");
+	console.log("🔒 Verifying download...");
 	const checksums = parseChecksums(await downloadText(checksumsUrl));
 	const expected = checksums.get(binaryName);
 
@@ -120,7 +122,8 @@ async function main() {
 		fs.chmodSync(targetPath, 0o755);
 	}
 
-	console.log("[workrail] Binary installed successfully.");
+	console.log("✅ Workrail CLI installed successfully!");
+	console.log("🚀 Run 'workrail auth login' to get started.");
 }
 
 main().catch((err) => {