コンテンツにスキップ

CLI

@contextlint/cli パッケージが提供する contextlint コマンドは、ローカル開発でも CI でも同じ実行系として使えます。設定ファイルの自動検出、watch モード、機械可読な JSON 出力までを 1 つのバイナリで賄います。

インストール方法は Get Started → インストール を参照してください。本ページではインストール後の使い方の入り口を案内します。

サブコマンド用途
contextlint(デフォルト)Markdown ドキュメントを lint する
contextlint init対話形式で contextlint.config.json を生成する
contextlint compileドキュメントとルールを Claude Code 向け SKILL.md に変換する
contextlint impact <file>指定ファイルの変更が影響するドキュメントを分析する
contextlint slice <query>クエリに関連するドキュメントの最小セットを抽出する
contextlint graphドキュメント依存グラフを表示する

各サブコマンドの引数とオプションは コマンド を参照してください。

インストール後は次のコマンドでバージョンを確認できます。

Terminal window
npx contextlint --version

設定ファイルがなくても --version--help は実行できますが、lint の実行には contextlint.config.json が必要です。設定ファイルの作り方は Configuration を参照してください。