Getting Started

Installation

Option 1: Global Installation

npm install -g threadlines

Then use directly: threadlines check

Option 2: Use with npx

npx threadlines check

For AI assistants (Cursor, GitHub Copilot): Use npx --yes threadlines check to avoid confirmation prompts.

Option 3: Project Dependency

npm install --save-dev threadlines

Ensures consistent version across your team.

Quick Start

1. Initialize Your First Threadline

npx threadlines init

This creates a /threadlines directory and generates a template file.

2. Configure Your API Key

Create a .env.local file in your project root:

THREADLINE_API_KEY=your-api-key-here
THREADLINE_ACCOUNT=your-email@example.com

Important: Add .env.local to your .gitignore.

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 Your First Check

npx threadlines check

Threadline will analyze your git changes against all threadlines in the /threadlines directory.

Self-Hosting

Want to run your own Threadline server? The codebase is open source. See the GitHub repository for setup instructions.