brandlint cli — Ensure consistent brand voice across…

Pitch

Description

Comments

About this project

Brandlint CLI is designed to help teams maintain their brand's voice by scanning codebases for off-brand UI copy. It identifies inconsistencies and provides actionable insights with detailed reports, allowing teams to improve user-facing messages while preserving their unique style. Streamline the way your product communicates.

Brandlint is a powerful command-line interface (CLI) tool designed to enhance product voice consistency by scanning codebases for off-brand UI copy. Similar to ESLint, Brandlint identifies issues such as inconsistent tone, vague messaging, and incorrect casing within user-facing strings. The tool provides detailed feedback, highlighting the exact locations of issues with file and line numbers, ultimately helping to improve the user experience.

Key Features

Voice Selection: Choose from three distinct voice styles - Professional, Casual, or Technical. Each style guides the tone and messaging aimed at users.
Comprehensive Scanning: Brandlint intelligently extracts user-facing strings from various file types and frameworks, ensuring thorough coverage of your codebase. It scans JavaScript, TypeScript, HTML, templates, and more, ignoring unnecessary directories such as node_modules and dist.
AI-Powered Analysis: Leveraging AI, Brandlint analyzes the extracted strings against predefined brand voice guidelines to deliver actionable insights.
Detailed Reporting: After a scan, Brandlint generates a comprehensive report, including a color-coded score, issue breakdown by file and line, and a summary of top problem categories such as tone and clarity.
Shareable Score Cards: Users can easily create shareable score cards at brandlint.com/score/<id>, complete with an Open Graph image optimized for social media sharing, and a one-click option to tweet the results.
Continuous Monitoring: Integrate Brandlint as a GitHub App for automated checks on pull requests, providing inline suggestions to maintain brand voice consistently across all contributors.

Usage Example

To initiate a brand scan, run:

npx brandlint

Set your API key from Anthropic or OpenAI as an environment variable to streamline the scanning process:

export ANTHROPIC_API_KEY=sk-ant-...
# or
export OPENAI_API_KEY=sk-...

Supported File Types

Brandlint supports a wide array of file types, ensuring compatibility with numerous frameworks and languages including:

JavaScript and TypeScript: .js, .ts, .tsx, and more.
Frameworks: .vue, .svelte.
Markup and Templates: .html, .ejs, .hbs, and others.

Getting Started

Brandlint is designed for Node.js version 18 and above. Its installation and setup process is straightforward, allowing for quick integration into existing workflows. After a one-time setup, it can consistently deliver insights to enhance brand voice across development teams.

For detailed documentation and additional resources, please visit the Brandlint website and the documentation page. Feedback can be submitted via the GitHub issues page.