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.
node_modules and dist.brandlint.com/score/<id>, complete with an Open Graph image optimized for social media sharing, and a one-click option to tweet the results.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-...
Brandlint supports a wide array of file types, ensuring compatibility with numerous frameworks and languages including:
.js, .ts, .tsx, and more..vue, .svelte..html, .ejs, .hbs, and others.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.
No comments yet.
Sign in to be the first to comment.