What it does
Enforce brand writing guidelines in Claude Code — PostToolUse hook + MCP server
- Connects パソコンで動く
- Account or key No key needed
- Category マーケティング・SNS
一緒に使える
この種の作業を AI に教える Skill。これと一緒に使えます
この順位の理由
一覧は利用スコア(100 点満点)で並びます。内訳は次のとおり
| 人気 | 0/80 | GitHub スターか週間ダウンロード数。大きい方を 60、小さい方を 20 で数えます |
|---|---|---|
| 新しさ | 3/12 | 30 日以内のリリースかコード更新で満点 |
| 応答中 | 0/8 | 前回の確認でクラウドのエンドポイントが応答 |
| 利用スコア | 3/100 |
品質: 基本チェック 3/3 項目に合格(表示のみ、並び順には不使用) · 勢い: データなし (「急上昇」タブでのみ使用)
インストール
使っているAIアプリを選んで、設定をコピーしてください。
ひとことで AI にインストールしてもらう
Brand Voice をインストールして。https://mcp.popnx.com/i/zoharbabin-brand-voice.md に従い、コマンドを見せて、私が OK するまで実行しないで。パソコンで作業できる AI(Claude Code や Cursor など)に貼り付けます。手順を読み、コマンドを見せて、あなたの OK を待ちます。キー不要・登録不要。 · AI が読む全文を見る
チェック 3/3 合格 · あなたのパソコンで動きます · ✓ コマンド確認済み 2026年11月13日
まず:どの AI を使っていますか?
使っているアプリを選ぶと、下に手順が表示されます。
Claude につなげますが、先に準備が必要です
先にパソコンへ Node.js を入れてください(1 回だけ) · パソコン版 Claude アプリ(Windows または Mac)のみ。Web やスマホでは使えません
AI にインストールしてもらう
このメッセージを Claude のチャットに貼り付けます。AI がパソコンを確認し、変更するファイルを伝え、毎回あなたの了承を待ちます。
このパソコンの Claude に MCP server Brand Voice を入れてください。順番に:1) node -v で Node.js があるか確認。なければ https://nodejs.org/en/download から入れるよう私に伝え、自分では入れない。2) この設定だけを使う(PopNx MCP の確認済み):{ "mcpServers": { "brand-voice": { "command": "npx", "args": [ "-y", "brand-voice" ] } } } 3) 変更するファイルのフルパスか実行するコマンドを伝えて、私の了承を待つ。4) キーは不要。5) 了承した内容を実行し、Brand Voice のツールが本当に表示されるか確認する。このメッセージにあなたのキーは含まれません。キーが必要な場合は、AI がファイルやアプリの入力欄にご自身で貼るよう案内します。
Node.js を入れる(まだなければ)
もう入っていますか?先に確認 · ターミナルを開き、このコマンドを入力して Enter
node -v- バージョン番号(例 v26.13.1)が出る = 入っています。この手順は飛ばせます
- "command not found"(Windows では "is not recognized")が出る = まだ入っていないか、入れた直後でターミナルを開き直す必要があります
ターミナルの開き方
Mac:⌘ + Space を押し、Terminal と入力して Enter
Windows:スタートメニューを開き、Windows PowerShell と入力して「開く」
まだ入っていない場合: 公式ダウンロードページで LTS 版と、クリックで進むインストーラーを選びます:Mac は .pkg、Windows は .msi。ダブルクリックして最後まで進めるだけで、curl コマンドは不要です
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です:
node -v一度入れれば、Node.js を使うすべてのツールで使えます
パソコン版 Claude アプリの設定ファイルを開く
SettingsDeveloperEdit Config
この設定を貼り付けて保存
{ "mcpServers": { "brand-voice": { "command": "npx", "args": [ "-y", "brand-voice" ] } } }Claude を終了してもう一度開く
試してみる
Brand Voice を使って、私に何ができるか教えて、1 つやってみせて✓ Claude が Brand Voice を使っていると言うか、回答に Brand Voice のツール名が出れば接続成功です
メニュー名は 2026年11月11日 に Anthropic のヘルプページで確認 · アプリのバージョンにより画面が少し違うことがあります
ChatGPT はまだ Brand Voice につなげません
Brand Voice はパソコンに入れて使うものですが、ChatGPT は Web 上で動くサーバーにしかつなげません
代わりにできること
A · Brand Voice につなげるアプリを使う
- 先にパソコンへ Node.js を入れてください(1 回だけ) · パソコン版 Claude アプリ(Windows または Mac)のみ。Web やスマホでは使えません
- 先にパソコンへ Node.js を入れてください(1 回だけ)
- 先にパソコンへ Node.js を入れてください(1 回だけ)
- 先にパソコンへ Node.js を入れてください(1 回だけ)
B · マーケティング・SNS の中で ChatGPT につなげる別のサーバー
同じカテゴリでよく使われているものから、キーなしでアドレスだけでつなげるものを選びました
- Google Ads + Meta Ads + SEO/GEO MCP✓ ChatGPT
- Cargo✓ ChatGPT
- NotFair✓ ChatGPT
Claude Code につなげますが、先に準備が必要です
先にパソコンへ Node.js を入れてください(1 回だけ)
AI にインストールしてもらう
このメッセージを Claude Code のチャットに貼り付けます。AI がパソコンを確認し、変更するファイルを伝え、毎回あなたの了承を待ちます。
このパソコンの Claude Code に MCP server Brand Voice を入れてください。順番に:1) node -v で Node.js があるか確認。なければ https://nodejs.org/en/download から入れるよう私に伝え、自分では入れない。2) この設定だけを使う(PopNx MCP の確認済み):claude mcp add --scope user brand-voice -- npx -y brand-voice 3) 変更するファイルのフルパスか実行するコマンドを伝えて、私の了承を待つ。4) キーは不要。5) 了承した内容を実行し、Brand Voice のツールが本当に表示されるか確認する。このメッセージにあなたのキーは含まれません。キーが必要な場合は、AI がファイルやアプリの入力欄にご自身で貼るよう案内します。
Node.js を入れる(まだなければ)
もう入っていますか?先に確認 · ターミナルを開き、このコマンドを入力して Enter
node -v- バージョン番号(例 v26.13.1)が出る = 入っています。この手順は飛ばせます
- "command not found"(Windows では "is not recognized")が出る = まだ入っていないか、入れた直後でターミナルを開き直す必要があります
ターミナルの開き方
Mac:⌘ + Space を押し、Terminal と入力して Enter
Windows:スタートメニューを開き、Windows PowerShell と入力して「開く」
まだ入っていない場合: 公式ダウンロードページで LTS 版と、クリックで進むインストーラーを選びます:Mac は .pkg、Windows は .msi。ダブルクリックして最後まで進めるだけで、curl コマンドは不要です
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です:
node -v一度入れれば、Node.js を使うすべてのツールで使えます
ターミナルを開く
Mac:Command+スペースで Terminal と入力 · Windows:PowerShell を開く
このコマンドを貼り付けて Enter
claude mcp add --scope user brand-voice -- npx -y brand-voiceClaude Code で /mcp と入力
Brand Voice が一覧にあり、接続済みと表示されれば OK です
試してみる
Brand Voice を使って、私に何ができるか教えて、1 つやってみせて✓ Claude Code が Brand Voice を使っていると言うか、回答に Brand Voice のツール名が出れば接続成功です
メニュー名は 2026年11月11日 に Anthropic のヘルプページで確認 · アプリのバージョンにより画面が少し違うことがあります
Cursor につなげますが、先に準備が必要です
先にパソコンへ Node.js を入れてください(1 回だけ)
AI にインストールしてもらう
このメッセージを Cursor のチャットに貼り付けます。AI がパソコンを確認し、変更するファイルを伝え、毎回あなたの了承を待ちます。
このパソコンの Cursor に MCP server Brand Voice を入れてください。順番に:1) node -v で Node.js があるか確認。なければ https://nodejs.org/en/download から入れるよう私に伝え、自分では入れない。2) この設定だけを使う(PopNx MCP の確認済み):{ "mcpServers": { "brand-voice": { "command": "npx", "args": [ "-y", "brand-voice" ] } } } 3) 変更するファイルのフルパスか実行するコマンドを伝えて、私の了承を待つ。4) キーは不要。5) 了承した内容を実行し、Brand Voice のツールが本当に表示されるか確認する。このメッセージにあなたのキーは含まれません。キーが必要な場合は、AI がファイルやアプリの入力欄にご自身で貼るよう案内します。
Node.js を入れる(まだなければ)
もう入っていますか?先に確認 · ターミナルを開き、このコマンドを入力して Enter
node -v- バージョン番号(例 v26.13.1)が出る = 入っています。この手順は飛ばせます
- "command not found"(Windows では "is not recognized")が出る = まだ入っていないか、入れた直後でターミナルを開き直す必要があります
ターミナルの開き方
Mac:⌘ + Space を押し、Terminal と入力して Enter
Windows:スタートメニューを開き、Windows PowerShell と入力して「開く」
まだ入っていない場合: 公式ダウンロードページで LTS 版と、クリックで進むインストーラーを選びます:Mac は .pkg、Windows は .msi。ダブルクリックして最後まで進めるだけで、curl コマンドは不要です
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です:
node -v一度入れれば、Node.js を使うすべてのツールで使えます
Cursor の AI チャットを Agent モードで開く
試してみる
Brand Voice を使って、私に何ができるか教えて、1 つやってみせて✓ Cursor が Brand Voice を使っていると言うか、回答に Brand Voice のツール名が出れば接続成功です
メニュー名は 2026年11月11日 に Cursor のヘルプページで確認 · アプリのバージョンにより画面が少し違うことがあります
VS Code につなげますが、先に準備が必要です
先にパソコンへ Node.js を入れてください(1 回だけ)
AI にインストールしてもらう
このメッセージを VS Code のチャットに貼り付けます。AI がパソコンを確認し、変更するファイルを伝え、毎回あなたの了承を待ちます。
このパソコンの VS Code に MCP server Brand Voice を入れてください。順番に:1) node -v で Node.js があるか確認。なければ https://nodejs.org/en/download から入れるよう私に伝え、自分では入れない。2) この設定だけを使う(PopNx MCP の確認済み):{ "servers": { "brand-voice": { "type": "stdio", "command": "npx", "args": [ "-y", "brand-voice" ] } } } 3) 変更するファイルのフルパスか実行するコマンドを伝えて、私の了承を待つ。4) キーは不要。5) 了承した内容を実行し、Brand Voice のツールが本当に表示されるか確認する。このメッセージにあなたのキーは含まれません。キーが必要な場合は、AI がファイルやアプリの入力欄にご自身で貼るよう案内します。
Node.js を入れる(まだなければ)
もう入っていますか?先に確認 · ターミナルを開き、このコマンドを入力して Enter
node -v- バージョン番号(例 v26.13.1)が出る = 入っています。この手順は飛ばせます
- "command not found"(Windows では "is not recognized")が出る = まだ入っていないか、入れた直後でターミナルを開き直す必要があります
ターミナルの開き方
Mac:⌘ + Space を押し、Terminal と入力して Enter
Windows:スタートメニューを開き、Windows PowerShell と入力して「開く」
まだ入っていない場合: 公式ダウンロードページで LTS 版と、クリックで進むインストーラーを選びます:Mac は .pkg、Windows は .msi。ダブルクリックして最後まで進めるだけで、curl コマンドは不要です
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です:
node -v一度入れれば、Node.js を使うすべてのツールで使えます
VS Code の AI チャットを Agent モードで開く
試してみる
Brand Voice を使って、私に何ができるか教えて、1 つやってみせて✓ VS Code が Brand Voice を使っていると言うか、回答に Brand Voice のツール名が出れば接続成功です
メニュー名は 2026年11月11日 に VS Code のヘルプページで確認 · アプリのバージョンにより画面が少し違うことがあります
Windsurf、Zed、Gemini CLI など MCP を使える他のアプリは追加方法がそれぞれ違います。アプリ一覧で確認してください
JSON 設定は下の「開発者向け」にあります
開発者向け:ターミナルのコマンドと JSON 設定
パソコンにインストール
Claude Code
claude mcp add --scope user brand-voice -- npx -y brand-voiceClaude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"brand-voice": {
"command": "npx",
"args": [
"-y",
"brand-voice"
]
}
}
}Cursor (~/.cursor/mcp.json)
{
"mcpServers": {
"brand-voice": {
"command": "npx",
"args": [
"-y",
"brand-voice"
]
}
}
}VS Code (mcp.json)
{
"servers": {
"brand-voice": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"brand-voice"
]
}
}
}この設定は、作者のレジストリ登録情報から作成しています。READMEと違う場合は、READMEに従ってください。
ひと目でわかる
使えるアプリ
このサーバーのつなぎ方と、各アプリの公式ドキュメントに基づきます。2026年11月10日に確認。
パソコン上で動かせるアプリ
ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast
できること
パソコンで動くサーバーです。インストールすると、ツール一覧がAIアプリに表示されます。
基本チェックi
誰でも見られる情報をチェックしており、コードは読んでいません。当てはまらない項目は数に入れていません。 · 2026年11月19日にチェック
- ✓ 合格
作者とリポジトリが一致
レジストリ名は、リポジトリを所有するGitHubアカウント zoharbabin で確認済みです
- ✓ 合格
今もメンテナンスされている
コードの最終更新:5 か月前
- ✓ 合格
ライセンスがある
MITを使用
- – 対象外
エンドポイントが応答する
これはパソコンで動くため、インターネット上のエンドポイントはありません
- – 対象外
OAuthでサインイン
パソコンで動き、代わりにローカルの設定を使います
- … 未チェック
ツールの説明に隠れた指示がない
パソコンで動くサーバーです。ツール一覧を読み取れるのは、インターネット上のエンドポイントがある場合だけです
公開済みの脆弱性(OSV.dev)
OSV.dev に brand-voice@0.1.8 の登録はありません
このバージョンのパッケージ本体のみ確認。すべての依存関係ではありません · 確認日 2026年11月16日
作者の方へ:再確認の依頼・情報の誤りの報告
作者向け:README にバッジを付ける
作者の方は、このコードを README に貼れます。バッジはこのページにリンクします。
[](https://mcp.popnx.com/en/servers/zoharbabin-brand-voice)話し合い
質問、コツの共有、使えないことの報告ができます。「役に立った」の多い順です。
ユーザーレビュー
まだレビューはありません
マーケティング・SNSのほかのサーバーとの比較i
- このカテゴリのほかの4175件のうち0%よりスターが多い
- このカテゴリのほかの4175件のうち12%より最近レジストリに公開
- 基本チェックの結果が、このカテゴリのほかの4175件のうち99%と同じかそれ以上
レジストリでこのカテゴリにある有効なすべてのサーバーと比較しています。スターは、公開者がリポジトリの所有者である場合だけ数えます。
よくある質問
Brand Voiceは安全ですか?
当てはまる基本チェック3項目のうち3項目に合格しました。コードは読んでいません。キーやトークンを追加する前に、サーバーがどんなアクセスを求めているかを確認し、必要な権限だけを持つキーを使ってください。
どんなキーやコードが必要ですか?
レジストリには必須のキーは載っていません。ただし、最初に使うときにサインインを求めるサーバーもあります。
パソコンで動きますか、それともクラウドですか?
あなたのパソコンで動きます。必要なときにAIアプリが起動し、データは作者のサーバーを通りません(サーバー自体がオンラインサービスを呼び出す場合を除きます)。
今もメンテナンスされていますか?
GitHubリポジトリの最終更新は5 か月前、最新バージョン(0.1.8)がレジストリに届いたのは5 か月前です。
どのアプリで使えますか?
Claude Desktop、Claude Code、Cursor、VS CodeなどのMCP対応アプリで使えます。パソコンにNode.jsも必要です。
代わりに使えるものは?
同じカテゴリには:Relaticle, ChatbotX, X (Twitter) MCP Server by Xquik, Betterlytics, BibiGPT YouTube Video Summarizer
似た働きのほかの候補
同じカテゴリでほかの作者のもの。コマンドは確認済み。公式を先に、次にスター順。
カードの見方:↓ 週あたりのダウンロードi★ GitHubスターi3つの柱:レビュー · チェック · 利用状況i更新=最新バージョンをレジストリに公開した日i
Relaticle
Open-source CRM your AI agents can write to: companies, people, opportunities, tasks and notes.
ChatbotX
Omnichannel customer messaging, CRM contacts, flows, sequences, broadcasts, and AI automation.
X (Twitter) MCP Server by Xquik
Xquik is the world's fastest and cheapest X (Twitter) data API with the most complete X data.
Betterlytics
Query your Betterlytics web analytics from AI agents: traffic, funnels, journeys, errors, uptime.
BibiGPT YouTube Video Summarizer
AI video summarizer: summarize and transcribe YouTube, Bilibili, TikTok and podcast videos.
| これ Brand Voice | Relaticle | ChatbotX | X (Twitter) MCP Server by Xquik | Betterlytics | BibiGPT YouTube Video Summarizer | |
|---|---|---|---|---|---|---|
| 動く場所 | パソコンにインストールが必要 | クラウドで動き、インストール不要 | クラウドで動き、インストール不要 | クラウドで動き、インストール不要 | クラウドで動き、インストール不要 | クラウドで動き、インストール不要 |
| キーが必要 | いいえ | いいえ | いいえ | いいえ | はい | いいえ |
| Claude で + から追加 | いいえ | いいえ | いいえ | いいえ | いいえ | いいえ |
| 基本チェック | 3/3 | 4/4 | 4/4 | 4/4 | 4/4 | 4/4 |
| ライセンス | MIT | AGPL-3.0 | NOASSERTION | MIT | AGPL-3.0 | MIT |
| 料金 | 登録情報に費用の記載なし | 登録情報に費用の記載なし | 登録情報に費用の記載なし | 登録情報に費用の記載なし | 登録情報に費用の記載なし | 登録情報に費用の記載なし |
作者のREADME
READMEを開く
作者のリポジトリから書かれたとおりにコピーしたものです。PopNx MCPは内容を確認・推奨していません。HTML、画像、スクリプトは取り除いています。リンクはこのサイトの外へ移動します。
brand-voice
Brand writing enforcement for Claude Code — automatic, configurable, zero-friction.
Every time Claude writes or edits a Markdown file, brand-voice checks it against your brand guidelines and signals Claude to fix violations before the file saves. No manual review. No rule reminders in every prompt.
Claude reads the violation list, corrects the file, and retries the write — automatically.
Why brand-voice?
Your brand guidelines live in a doc somewhere. Claude doesn't read them unless you paste them into every prompt. Even then, the rules drift over time.
brand-voice makes the rules structural:
- Works for any company — configure your own vocabulary, voice, and visual identity
- Auto-corrects, doesn't just report — the PostToolUse hook blocks bad writes and triggers a retry
- Covers the full stack — hook for Claude Code, MCP server for on-demand checks, CLI for CI pipelines
- Smart about code — ignores fenced blocks, indented code, inline code spans, and table cells
- Escape hatches —
.brand-voice-ignorefor whole files,for individual lines - Visual identity included — colors, fonts, logo URLs live in the same guidelines file
Install
npm install -g brand-voice
Or run without installing:
npx brand-voice@latest check
Requires Node.js 18+.
Quick Start
Option A — Guided setup in Claude Code (recommended)
Run the setup skill inside any Claude Code session:
/brand-voice-setup
The skill does everything:
- Asks whether you have existing brand docs or want to answer four questions
- Optionally researches your brand automatically via web
- Writes
brand-guidelines.mdto your project - Injects a summary block into
CLAUDE.md - Registers the PostToolUse hook in
.claude/settings.json - Registers the MCP server in
.mcp.json
After setup, every .md and .mdx file Claude touches is checked automatically.
Option B — Manual setup
# 1. Install
npm install -g brand-voice
2. Create brand-guidelines.md in your project root (see schema below)
3. Register the hook
brand-voice setup
How It Works
Three components work together:
| Component | What it does |
|---|---|
PostToolUse hook (brand-voice-check) | Runs after every Write/Edit/MultiEdit on .md/.mdx; exits 2 with violations so Claude auto-corrects, exits 0 when clean |
MCP server (brand-voice-mcp) | Exposes analyze_readability and apply_suggestions for on-demand analysis and word-level fixes |
CLI (brand-voice) | Standalone checker for CI pipelines, ratchet baselines, and GitHub PR annotations |
What gets checked
| Rule | Severity | Description |
|---|---|---|
| Forbidden terms | error | Whole-word, case-insensitive match — blocks the write |
| Avoid terms | warning | Same matching — signals a preferred alternative |
| Sentence length | warning | Configurable max words per sentence (default: 25) |
| Passive voice | warning | Auxiliary + past-participle pattern detection |
| Readability grade | warning | Flesch-Kincaid grade per sentence vs. your target |
Code blocks, inline code, indented blocks, and table rows are never checked — only prose.
Never checked: physical line length or line breaks. The CLAUDE.md injection always includes a formatting rule telling Claude to write continuous paragraphs and let the renderer word-wrap, but the analyzer itself has no line-width rule and never will — sentence length is measured in words, not characters or lines, so hard-wrapped and unwrapped prose score identically.
PostToolUse hook exit codes
| Code | Meaning |
|---|---|
0 | No violations — file accepted |
2 | Violations found — Claude reads output, corrects, and retries |
Exit 1 is never used (it aborts the session rather than triggering a retry).
brand-guidelines.md
One Markdown file holds your entire brand configuration. Keep it under 600 words so it fits cleanly in context.
# Brand Guidelines
Persona
Who you are and who you write for.
Tone & Voice
- Direct, honest, clear
- Person: second ← "first" | "second" | "third"
- Voice: active ← "active" | "passive"
- Sentences: max 25 words
- Contractions: yes ← "yes" | "no"
- Exclamation marks: no
Vocabulary
Always use: Acme, Acme Platform, APIs Avoid: leverage, utilize, synergy, seamless Forbidden: [competitor names, unverified claims]
On-Tone Examples
Connect your data in minutes — Acme handles the routing.
Off-Tone Examples
Leverage our cutting-edge platform to seamlessly integrate.
Visual Identity
- Primary color: #006EFA
- Secondary color: #0050C3
- Accent color: #FF9DFF
- Background color: #FFFFFF
- Text color: #282828
- Logo (light): https://cdn.example.com/logo-light.svg
- Logo (dark): https://cdn.example.com/logo-dark.svg
- Heading font: Inter
- Body font: Source Sans Pro
Formatting Rules
- Heading style: sentence case
- Oxford comma: yes
- Readability target: 8th grade
Quick Reference
Repeat your top 5 rules here. This section appears last — where LLM attention is highest — to reinforce critical rules against context-window attention drop-off.
See example/brand-guidelines.md for a complete working example.
Section aliases
## On-Brand Examples and ## Off-Brand Examples are accepted as aliases for ## On-Tone Examples / ## Off-Tone Examples. All other section names are case-insensitive exact matches.
Search path
The hook and CLI search for brand-guidelines.md in this order:
- Current working directory
~/.claude/brand-guidelines.md(user scope — enforces rules across all your projects)- Parent directories up to the git root
Suppressing Violations
Skip files or directories — .brand-voice-ignore
Create a .brand-voice-ignore file in your project root. Uses gitignore-style patterns:
# Auto-generated content
dist/ CHANGELOG.md
Agent prompt files — intentional brand vocabulary exceptions
data/prompts/**
Vendor docs
vendor/
Skip a single line — inline comment
<!-- brand-voice-disable-line -->
Add this comment anywhere on a line to suppress all violations on that line. Useful for one-off exceptions where the violation is intentional.
MCP Server
analyze_readability
Check a file or inline text for violations and readability scores.
Inputs:
| Field | Type | Required | Description |
|---|---|---|---|
file | string | one of file/text | Absolute or relative path to a .md/.mdx file |
text | string | one of file/text | Inline Markdown to analyze |
cwd | string | no | Working directory for locating brand-guidelines.md |
Returns: { filePath, passed, violations[], readabilityScores, visualIdentity }
apply_suggestions
Apply safe word-level substitutions for forbidden/avoid terms. Does not fix sentence length, passive voice, or grade — those need human judgment.
Inputs:
| Field | Type | Required | Description |
|---|---|---|---|
file | string | yes | Path to the file to fix |
dryRun | boolean | no | Preview diff without writing (default: false) |
Returns: diff + change list (dry run) or confirmation + change list (live)
Tip: Run dryRun: true first to preview, then apply.
CI Integration
brand-voice works independently of Claude Code — add it to any pipeline.
Check all `.md` files:
npx brand-voice@latest check
Check only files changed in the current branch:
npx brand-voice@latest check --changed-only
GitHub Actions inline annotations (PR diff comments):
npx brand-voice@latest check --reporter github-pr-review
Ratchet enforcement — block regressions without requiring a clean slate:
# Run once, commit the file
npx brand-voice@latest baseline --save
In CI: fail only if violations increase above baseline
npx brand-voice@latest check --baseline .brand-voice-baseline.json
Example GitHub Actions workflow:
name: Brand Voice
on: pull_request: paths: ['.md', '.mdx']
jobs: prose: runs-on: ubuntu-latest steps:
- uses: actions/checkout@v4 with: { fetch-depth: 0 }
- run: npx brand-voice@latest check --changed-only --reporter github-pr-review
Exit 0 = clean or within baseline. Exit 1 = errors found or baseline exceeded.
CLI Reference
brand-voice <command> [options]
Commands: check [file] Check a file or all .md files in cwd setup Print instructions to run /brand-voice-setup in Claude Code import Normalize a brand-guidelines.md into cwd baseline --save Save current violation count as ratchet baseline vale-sync Check that the Vale binary is available
Check options: --changed-only Only check files changed in git (requires git) --baseline Compare against a baseline JSON file (ratchet check) --reporter github-pr-review Emit GitHub Actions annotation format
Programmatic API
import { parseGuidelines, analyzeText, loadGuidelines } from 'brand-voice';
const guidelines = loadGuidelines(process.cwd()); if (guidelines) { const result = analyzeText(markdownString, 'doc.md', guidelines); console.log(result.violations); // Violation[] console.log(result.readabilityScores); // ReadabilityScores console.log(result.passed); // false if any error-severity violations }
See src/types.ts for full type definitions.
Distribution Patterns
| Scenario | What to do |
|---|---|
| Solo developer | Run /brand-voice-setup once per project; commit brand-guidelines.md |
| Team | Commit brand-guidelines.md, .claude/settings.json, and .mcp.json; teammates get enforcement on git pull |
| Global (all projects) | Run /brand-voice-setup with the global flag; writes to ~/.claude/brand-guidelines.md |
| claude.ai (browser) | Setup skill outputs a paste block for Claude Project instructions — no hook or MCP needed |
| Enterprise / CI | Use brand-voice check in pipelines; commit .brand-voice-baseline.json for ratchet enforcement |
Requirements
- Node.js 18+
- `brand-guidelines.md` — created by
/brand-voice-setupor written manually - Vale — optional; only required for
vale-sync
Contributing
Bug reports, feature requests, and pull requests are welcome. See CONTRIBUTING.md for setup instructions, key invariants to preserve, and code style guidance.
License
MIT — see LICENSE.