Initial commit — npx brandlint

Open source CLI that scans codebases for off-brand UI copy.
Pick a voice, bring your own API key, get a score, share it.

Co-Authored-By: Claude Opus 4.6 <[email protected]>

Author: zeronelabs

.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: Publish to npm
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org
+
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm build
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+*.tgz

LICENSE

@@ -0,0 +1,172 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/zeronelabs/brandlint-cli/main/logo.png" width="64" height="64" alt="Brandlint logo">
+</p>
+
+<h1 align="center">Brandlint</h1>
+
+<p align="center"><strong>Scan your codebase for off-brand UI copy. Get a score. Share it.</strong></p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/brandlint"><img src="https://img.shields.io/npm/v/brandlint" alt="npm version"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/License-AGPL--3.0-blue.svg" alt="License: AGPL-3.0"></a>
+  <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E%3D18-brightgreen" alt="Node.js >= 18"></a>
+</p>
+
+<p align="center">
+  <a href="https://brandlint.com"><strong>Website</strong></a> · <a href="https://brandlint.com/docs">Docs</a> · <a href="https://github.com/zeronelabs/brandlint-cli/issues/new">Feedback</a>
+</p>
+
+&nbsp;
+
+Like ESLint, but for your product voice. Brandlint scans your codebase for off-brand copy — inconsistent tone, vague messages, wrong casing — and tells you exactly where to fix it, with file and line number.
+
+```
+npx brandlint
+```
+
+You bring your own API key (Anthropic or OpenAI). Nothing is sent to Brandlint servers except the final score summary if you choose to share it.
+
+&nbsp;
+
+## How It Works
+
+1. **Pick a voice** — Professional, Casual, or Technical
+2. **Scan** — Extracts user-facing strings from your codebase
+3. **Analyze** — AI checks each string against your brand voice guidelines
+4. **Report** — See your score, issues by file/line, and top problem categories
+5. **Share** — Generate a score card at `brandlint.com/score/<id>` with one keypress
+
+<!-- TODO: Replace with actual terminal screenshot -->
+<img src="https://raw.githubusercontent.com/zeronelabs/brandlint-cli/main/screen.png" width="800" alt="Brandlint CLI">
+
+&nbsp;
+
+## Requirements
+
+- Node.js 18+
+- An API key from [Anthropic](https://console.anthropic.com/) or [OpenAI](https://platform.openai.com/)
+
+Set your key as an environment variable to skip the prompt on every run:
+
+```bash
+export ANTHROPIC_API_KEY=sk-ant-...
+# or
+export OPENAI_API_KEY=sk-...
+```
+
+&nbsp;
+
+## Voice Templates
+
+| Template | Style | Example guideline |
+|---|---|---|
+| **Professional** | Clear, confident, helpful | "Enter your email to continue" not "Fill in the required field" |
+| **Casual** | Friendly, warm, conversational | "Looks like something broke" not "Error 500: Internal failure" |
+| **Technical** | Precise, direct, informative | "Request timed out after 30s" not "Something went wrong!" |
+
+&nbsp;
+
+## What Gets Scanned
+
+Brandlint extracts user-facing strings from:
+
+| Category | File types |
+|---|---|
+| **JS / TS** | `.ts` `.tsx` `.js` `.jsx` `.mjs` `.cjs` |
+| **Frameworks** | `.vue` `.svelte` |
+| **Markup** | `.html` `.htm` |
+| **Templates** | `.ejs` `.hbs` `.pug` `.erb` `.slim` `.haml` `.twig` |
+| **Backend** | `.php` `.py` `.cshtml` `.razor` |
+| **Content** | `.json` `.yaml` `.yml` `.md` `.mdx` |
+
+It finds strings in JSX text, UI attributes (`label`, `placeholder`, `title`, `error`, `description`), i18n functions (`t()`, `$t()`, `gettext()`), and template literals with user-facing content.
+
+`node_modules`, `dist`, `build`, `.next`, `.git`, and similar directories are ignored automatically.
+
+&nbsp;
+
+## Score Card
+
+After scanning, Brandlint offers to create a shareable score card at `brandlint.com/score/<id>`:
+
+- Color-coded score with issue breakdown
+- Top problem categories (tone, clarity, casing, etc.)
+- Open Graph image that unfurls on X, Slack, and Discord
+- One-click share to X with pre-filled tweet
+
+The only data sent is the summary (score, counts, categories, voice template). Your source code never leaves your machine.
+
+&nbsp;
+
+## Continuous Monitoring
+
+The CLI gives you a one-time scan. For automated brand voice checks on every pull request, set up [Brandlint as a GitHub App](https://brandlint.com/signin) — it reviews PRs and comments inline with suggestions.
+
+&nbsp;
+
+## Development
+
+```bash
+git clone https://github.com/zeronelabs/brandlint-cli.git
+cd brandlint-cli
+pnpm install
+pnpm build       # Build to dist/cli.mjs
+pnpm dev         # Build with watch mode
+```
+
+&nbsp;
+
+## Testing Locally
+
+**Run from source:**
+
+```bash
+pnpm build
+node dist/cli.mjs
+```
+
+**Test as if installed via npx:**
+
+```bash
+pnpm pack                       # Creates brandlint-0.1.0.tgz
+npx ./brandlint-0.1.0.tgz      # Runs exactly like npx brandlint would
+```
+
+**Test score card upload against local web app:**
+
+```bash
+BRANDLINT_API_URL=http://localhost:3000/api/score-card node dist/cli.mjs
+```
+
+&nbsp;
+
+## Releasing
+
+Releases are automated via GitHub Actions. When you push a version tag, the workflow builds and publishes to npm.
+
+**One-time setup:**
+
+1. Generate an npm access token at [npmjs.com](https://www.npmjs.com/) → Access Tokens → Classic → Automation
+2. Add it as `NPM_TOKEN` in repo Settings → Secrets → Actions
+
+**To release:**
+
+```bash
+npm version patch               # 0.1.0 → 0.1.1 (or minor / major)
+git push && git push --tags     # Triggers publish workflow
+```
+
+After a few seconds, `npx brandlint` serves the new version globally.
+
+**First publish** (before any tags exist):
+
+```bash
+npm login
+pnpm build && npm publish
+```
+
+&nbsp;
+
+## License
+
+[AGPL-3.0](LICENSE)

README.md

@@ -0,0 +1,49 @@
+{
+  "name": "brandlint",
+  "version": "0.1.1",
+  "description": "Scan your codebase for brand voice consistency",
+  "license": "AGPL-3.0",
+  "author": {
+    "name": "Brandlint",
+    "url": "https://brandlint.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zeronelabs/brandlint-cli.git"
+  },
+  "homepage": "https://brandlint.com",
+  "keywords": [
+    "brand",
+    "voice",
+    "copy",
+    "linter",
+    "ux-writing",
+    "microcopy",
+    "brand-consistency",
+    "cli"
+  ],
+  "type": "module",
+  "bin": {
+    "brandlint": "./dist/cli.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  },
+  "dependencies": {
+    "@anthropic-ai/sdk": "^0.72.0",
+    "@clack/prompts": "^0.9.1",
+    "fast-glob": "^3.3.3",
+    "open": "^10.1.0",
+    "openai": "^4.96.0",
+    "picocolors": "^1.1.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "tsup": "^8.4.0",
+    "typescript": "^5.9.0"
+  }
+}