threadlines 0.1.4 → 0.1.6

package/README.md

@@ -2,6 +2,26 @@
 
 Threadline CLI - AI-powered linter based on your natural language documentation.
 
+## Why Threadline?
+
+Getting teams to follow consistent quality standards is **hard**. Really hard.
+
+- **Documentation** → Nobody reads it. Or it's outdated before you finish writing it.
+- **Linting** → Catches syntax errors, but misses nuanced stuff.
+- **AI Code Reviewers** → Powerful, but you can't trust them. Did they actually check what you care about? Can you customize them with your team's specific rules?
+
+**Threadline solves this** by running **separate, parallel, highly focused AI-powered reviews** - each focused on a single, specific concern. Your coding standards live in your repository as markdown files, version-controlled and always in sync with your codebase. Each threadline gets its own dedicated AI check, ensuring focused attention on what matters to your team.
+
+### What Makes Threadline Different?
+
+- **🎯 Focused Reviews** - Instead of one AI trying to check everything, Threadline runs multiple specialized AI reviewers in parallel. Each threadline focuses on one thing and does it well.
+
+- **📝 Documentation That Lives With Your Code** - Your coding standards live in your repo, in a `/threadlines` folder. They're version-controlled, reviewable, and always in sync with your codebase.
+
+- **🔍 Fully Auditable** - Every AI review decision is logged and traceable. You can see exactly what was checked, why it passed or failed, and have confidence in the results.
+
+- **⚡ Fast & Parallel** - Multiple threadlines run simultaneously, so you get comprehensive feedback in seconds, not minutes.
+
 ## Installation
 
 ```bash
@@ -14,14 +34,72 @@ Or use with npx:
 npx threadlines check
 ```
 
+## Quick Start
+
+### 1. Initialize Your First Threadline
+
+```bash
+npx threadlines init
+```
+
+This command:
+- Creates a `/threadlines` directory in your project root
+- Generates `threadlines/example.md` with a template threadline
+- Provides instructions for setting up your API key
+
+### 2. Configure API Key
+
+Create a `.env.local` file in your project root:
+
+```bash
+THREADLINE_API_KEY=your-api-key-here
+```
+
+**Important:** Make sure `.env.local` is in your `.gitignore` file!
+
+For CI/CD environments, set `THREADLINE_API_KEY` as an environment variable in your platform settings.
+
+### 3. Edit Your Threadline
+
+Edit `threadlines/example.md` with your coding standards, then rename it to something descriptive (e.g., `error-handling.md`).
+
+### 4. Run Checks
+
+```bash
+npx threadlines check
+```
+
 ## Usage
 
+### Initialize Threadline Template
+
+```bash
+threadlines init
+```
+
+Creates a template threadline file to get you started. The command will:
+- Create the `/threadlines` directory if it doesn't exist
+- Generate `threadlines/example.md` with boilerplate content
+- Display instructions for API key configuration
+
+### Check Code Against Threadlines
+
 ```bash
 threadlines check
 ```
 
+Analyzes your git changes against all threadlines in the `/threadlines` directory.
+
+**Options:**
+- `--api-url <url>` - Override the server URL (default: http://localhost:3000)
+
 ## Configuration
-BANANA
+
+### Environment Variables
+
+- `THREADLINE_API_KEY` - **Required.** Your Threadline API key for authentication
+  - Can be set in `.env.local` file (recommended for local development)
+  - Or as an environment variable (required for CI/CD)
 - `THREADLINE_API_URL` - Server URL (default: http://localhost:3000)
   - Can also be set with `--api-url` flag: `npx threadlines check --api-url http://your-server.com`
 

package/dist/commands/check.js

@@ -40,12 +40,26 @@ exports.checkCommand = checkCommand;
 const experts_1 = require("../validators/experts");
 const diff_1 = require("../git/diff");
 const client_1 = require("../api/client");
+const config_1 = require("../utils/config");
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const chalk_1 = __importDefault(require("chalk"));
 async function checkCommand(options) {
     const repoRoot = process.cwd();
     console.log(chalk_1.default.blue('🔍 Threadline: Checking code against your threadlines...\n'));
+    // Get and validate API key
+    const apiKey = (0, config_1.getThreadlineApiKey)();
+    if (!apiKey) {
+        console.error(chalk_1.default.red('❌ Error: THREADLINE_API_KEY is required'));
+        console.log('');
+        console.log(chalk_1.default.yellow('To fix this:'));
+        console.log(chalk_1.default.white('  1. Create a .env.local file in your project root'));
+        console.log(chalk_1.default.gray('  2. Add: THREADLINE_API_KEY=your-api-key-here'));
+        console.log(chalk_1.default.gray('  3. Make sure .env.local is in your .gitignore'));
+        console.log('');
+        console.log(chalk_1.default.gray('For CI/CD: Set THREADLINE_API_KEY as an environment variable in your platform settings.'));
+        process.exit(1);
+    }
     try {
         // 1. Find and validate threadlines
         console.log(chalk_1.default.gray('📋 Finding threadlines...'));
@@ -63,6 +77,17 @@ async function checkCommand(options) {
             console.log(chalk_1.default.yellow('⚠️  No changes detected. Make some code changes and try again.'));
             process.exit(0);
         }
+        // Check for zero diff (files changed but no actual code changes)
+        if (!gitDiff.diff || gitDiff.diff.trim() === '') {
+            console.log(chalk_1.default.blue('ℹ️  No code changes detected. Diff contains zero lines added or removed.'));
+            console.log(chalk_1.default.gray(`   ${gitDiff.changedFiles.length} file(s) changed but no content modifications detected.`));
+            console.log('');
+            console.log(chalk_1.default.bold('Results:\n'));
+            console.log(chalk_1.default.gray(`${threadlines.length} threadlines checked`));
+            console.log(chalk_1.default.gray(`  ${threadlines.length} not relevant`));
+            console.log('');
+            process.exit(0);
+        }
         console.log(chalk_1.default.green(`✓ Found ${gitDiff.changedFiles.length} changed file(s)\n`));
         // 3. Read context files for each threadline
         const threadlinesWithContext = threadlines.map(threadline => {
@@ -92,7 +117,8 @@ async function checkCommand(options) {
         const response = await client.review({
             threadlines: threadlinesWithContext,
             diff: gitDiff.diff,
-            files: gitDiff.changedFiles
+            files: gitDiff.changedFiles,
+            apiKey
         });
         // 6. Display results
         displayResults(response);
@@ -106,7 +132,11 @@ async function checkCommand(options) {
     }
 }
 function displayResults(response) {
-    const { results, metadata } = response;
+    const { results, metadata, message } = response;
+    // Display informational message if present (e.g., zero diffs)
+    if (message) {
+        console.log('\n' + chalk_1.default.blue('ℹ️  ' + message));
+    }
     console.log('\n' + chalk_1.default.bold('Results:\n'));
     console.log(chalk_1.default.gray(`${metadata.totalThreadlines} threadlines checked`));
     const notRelevant = results.filter((r) => r.status === 'not_relevant').length;

package/dist/commands/init.js

@@ -94,6 +94,15 @@ async function initCommand() {
         console.log(chalk_1.default.blue('Next steps:'));
         console.log(chalk_1.default.gray('  1. Edit threadlines/example.md with your coding standards'));
         console.log(chalk_1.default.gray('  2. Rename it to something descriptive (e.g., error-handling.md)'));
+        console.log('');
+        console.log(chalk_1.default.yellow('⚠️  IMPORTANT: API Key Setup Required'));
+        console.log(chalk_1.default.white('   To use threadlines check, you need a THREADLINE_API_KEY.'));
+        console.log('');
+        console.log(chalk_1.default.white('   Create a .env.local file in your project root with:'));
+        console.log(chalk_1.default.gray('     THREADLINE_API_KEY=your-api-key-here'));
+        console.log('');
+        console.log(chalk_1.default.white('   Make sure .env.local is in your .gitignore file!'));
+        console.log('');
         console.log(chalk_1.default.gray('  3. Run: npx threadlines check'));
     }
     catch (error) {

package/dist/index.js

@@ -1,6 +1,51 @@
 #!/usr/bin/env node
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+// Load .env.local from project root before anything else
+const dotenv_1 = __importDefault(require("dotenv"));
+const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
+const projectRoot = process.cwd();
+const envLocalPath = path.join(projectRoot, '.env.local');
+if (fs.existsSync(envLocalPath)) {
+    dotenv_1.default.config({ path: envLocalPath });
+}
 const commander_1 = require("commander");
 const check_1 = require("./commands/check");
 const init_1 = require("./commands/init");

package/dist/utils/config.js

@@ -0,0 +1,63 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getThreadlineApiKey = getThreadlineApiKey;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const dotenv_1 = __importDefault(require("dotenv"));
+/**
+ * Loads environment variables from .env.local file in the project root
+ * (where the user runs the command, not the CLI package directory)
+ */
+function loadEnvLocal() {
+    const projectRoot = process.cwd();
+    const envLocalPath = path.join(projectRoot, '.env.local');
+    if (fs.existsSync(envLocalPath)) {
+        dotenv_1.default.config({ path: envLocalPath });
+    }
+}
+/**
+ * Gets THREADLINE_API_KEY from environment.
+ * Priority: process.env.THREADLINE_API_KEY → .env.local file
+ */
+function getThreadlineApiKey() {
+    // Load .env.local if it exists (doesn't override existing env vars)
+    loadEnvLocal();
+    // Check environment variable (from shell or CI/CD)
+    return process.env.THREADLINE_API_KEY;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "threadlines",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "Threadline CLI - AI-powered linter based on your natural language documentation",
   "main": "dist/index.js",
   "bin": {
@@ -23,7 +23,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ngrootscholten/threadline.git",
+    "url": "git+https://github.com/ngrootscholten/threadline.git",
     "directory": "packages/cli"
   },
   "scripts": {
@@ -34,6 +34,7 @@
   },
   "dependencies": {
     "commander": "^12.1.0",
+    "dotenv": "^16.4.7",
     "simple-git": "^3.27.0",
     "axios": "^1.7.9",
     "chalk": "^4.1.2",