CLIリファレンス
このページでは、すべてのcodeknitコマンド、その引数、およびフラグを一覧表示します。タスク指向の手順については、parseコマンドガイド、graphコマンドガイド、およびfingerprintコマンドガイドを参照してください。
コマンド概要
Section titled “コマンド概要”| コマンド | 目的 |
|---|---|
codeknit |
対話型ターミナルUIを起動します。 |
codeknit parse <input-path> [output-dir] |
シンボルと関係を.sktまたはJSON出力に抽出します。 |
codeknit graph show <input-path> |
インタラクティブなHTMLグラフを生成します。 |
codeknit graph analyze <input-path> |
構造的なグラフアルゴリズムを実行し、.sktレポートを書き出します。 |
codeknit graph hotspots <input-path> |
Git履歴とグラフ構造を使用して変更ホットスポットをランク付けします。 |
codeknit fingerprint <input-path> |
重複および近似重複コードを検出します。 |
codeknit completion <shell> |
シェル補完スクリプトを生成します。 |
5つのコマンドがソースコードを処理します: parse、graph show、graph analyze、graph hotspots、およびfingerprint。これらは共通のソース処理フラグで説明されているフラグを共有します。
グローバルフラグ
Section titled “グローバルフラグ”| フラグ | タイプ | デフォルト | 説明 |
|---|---|---|---|
--version |
bool | false |
バージョン情報を表示します。 |
-h, --help |
bool | false |
コマンドのヘルプを表示します。 |
共通のソース処理フラグ
Section titled “共通のソース処理フラグ”これらのフラグは、各ソース処理コマンドの表に表示されます。
| フラグ | タイプ | デフォルト | 許可される値 | 説明 |
|---|---|---|---|---|
--header-language |
string | c |
c、cpp |
.hファイルに使用するパーサー。 |
--include GLOB |
string, repeatable | サポートされているすべてのソース | gitignore形式のグロブ | 一致するソースパスを含めます。複数のパターンは和集合を形成します。 |
--exclude GLOB |
string, repeatable | なし | gitignore形式のグロブ | 一致するパスまたはディレクトリを除外します。 |
--max-file-size BYTES |
int | 10485760 (10 MiB) |
0以上 |
このサイズより大きいソースファイルをスキップします。0は制限を無効にします。 |
--strict |
bool | false |
— | スキャンまたは解析の診断が発生した場合、出力が書き込まれる前に失敗します。 |
--header-language
Section titled “--header-language”.hファイルにのみ適用されます。他の拡張子は通常のパーサーを保持します(.hppおよび.hxxはすでにC++を使用します)。
c(デフォルト)は、Cマクロ、typedef、およびunionの抽出を保持します。cppは、C++パーサーを選択します。.hという名前のヘッダーを持つC++プロジェクトに使用します。
TUIは、.hファイルに対してデフォルトのc選択を使用します。
codeknit parse ./src --header-language cppテストされた抽出機能と各言語の既知の制限については、言語サポートとAPI忠実度を参照してください。そのページでは、テストされた構文について説明しており、完全な言語やコンパイラのセマンティックカバレッジではありません。
- パターンは、入力ディレクトリを基準としたスラッシュ区切りのgitignore形式のグロブを使用します。単一ファイルの入力の場合、パターンはファイルのベース名に一致します。
- シェルがパターンを展開しないように、パターンを引用符で囲みます。
- 除外は包含よりも優先されます。
- 包含は、
.gitignoreルール、テストファイルのフィルタリング、または組み込みの除外を上書きしません。 - 否定パターン(
!pattern)は、--includeまたは--excludeでは受け付けられません。 - ディレクトリスキャンは、現在の作業ディレクトリに関係なく、祖先およびネストされた
.gitignoreファイルを尊重します。 - 通常のソースファイルを明示的に選択すると、無視およびテストフィルタリングがバイパスされます。包含、除外、およびサイズ制限は引き続き適用されます。
- テストファイルは、
--collect-testが設定されていない限り除外されます。
codeknit parse ./src --include '**/*.go' --exclude '**/generated/' --strict診断と--strict
Section titled “診断と--strict”- シンボリックリンク、ディレクトリシンボリックリンク、および通常でないファイルはスキップされ、報告されます。
- 読み取り不可能なパス、無視ファイルの読み取り失敗、サイズ超過のソース、および構文警告により、分析が不完全になります。
- デフォルトでは、使用可能な部分的な結果が保持されます。診断はstderrに表示されます。
parseは、JSONのerrorsまたはSKTの[errors]にも記録します。 --strictを使用すると、不完全な分析は出力が書き込まれる前に拒否されます。- サポートされているソースが選択されていない場合、またはすべてのソース読み取りが失敗した場合、実行は常に失敗します。
- TUIは同じシンボリックリンクポリシーと10 MiBのデフォルトを適用します。そのフォームでは、選択フラグとstrictフラグは公開されていません。
正確な保証については、分析信頼性を参照してください。
codeknit
Section titled “codeknit”codeknitサブコマンドなしでcodeknitを実行すると、対話型ターミナルUIが起動します。UIでは、parse、graph show、graph analyze、graph hotspots、およびfingerprintコマンドとそのオプションが提供されます。
codeknit parse
Section titled “codeknit parse”codeknit parse <input-path> [output-dir]| 引数 | 必須 | デフォルト | 説明 |
|---|---|---|---|
input-path |
はい | — | ソースディレクトリまたは単一のソースファイル。 |
output-dir |
いいえ | ./skeleton |
出力ディレクトリ。--output-modeがinlineの場合は使用されません。 |
| フラグ | タイプ | デフォルト | 許可される値 | 説明 |
|---|---|---|---|---|
--output-mode |
string | directory-flat |
inline、directory-flat、directory-tree |
出力の書き込み場所と方法。 |
--format |
string | skt |
skt、json |
出力形式。 |
--max-lines |
int | 500 |
directory-treeの場合、3以上 |
フラット出力の行ターゲット。ツリー出力の場合は、ソースチャンクのハードリミット。 |
--collect-test |
bool | false |
— | テストファイルを含めます。 |
--minify |
bool | false |
— | 辞書ベースの出力圧縮を有効にします。 |
--edges |
bool | false |
— | [edges]セクションを含めます。デフォルトではトークンを節約するためにオフになっています。 |
--clean |
bool | false |
— | 成功した生成後にのみ、以前の生成された出力を置き換えます。 |
--workers |
int | 0 (NumCPU) |
0以上 |
最大同時解析ゴルーチン数。 |
--verbose |
bool | false |
— | 進捗情報を表示します。 |
--header-language |
string | c |
c、cpp |
.hファイルに使用するパーサー。 |
--include GLOB |
string, repeatable | サポートされているすべてのソース | — | 一致するソースパスを含めます。 |
--exclude GLOB |
string, repeatable | なし | — | 一致するパスまたはディレクトリを除外します。 |
--max-file-size BYTES |
int | 10485760 |
0は制限を無効にします |
サイズの大きいソースファイルをスキップします。 |
--strict |
bool | false |
— | スキャンまたは解析の診断が発生した場合、出力前に失敗します。 |
| 値 | 動作 |
|---|---|
inline |
stdoutに書き込みます。出力ディレクトリは使用されません。 |
directory-flat |
出力ディレクトリにチャンク化されたファイルを書き込みます。ソースブロックはそのまま保持されるため、--max-linesはハードリミットではなく分割ターゲットです。 |
directory-tree |
ソーストリーをミラーリングします。名前はソース拡張子を保持します(foo.c.skt、foo.h.skt)。分割されたファイルはfoo.c_part1.sktを使用します。 |
--cleanがない場合、出力ディレクトリ内の選択された形式の既存の生成出力があるとエラーが発生します。--cleanを使用すると、古い.sktファイル(SKT形式)またはcodeknit.json(JSON形式)は、成功した生成後にのみ置き換えられます。無関係なエントリは保持されます。- JSON形式では、ディレクトリモードは
codeknit.jsonを書き込みます。JSONは単一のドキュメントであり、行数で分割されません。 dict.sktおよびwarnings.sktは予約された補助ファイル名です。- ソースディレクトリまたはその祖先の1つを出力ディレクトリとして使用しないでください。
詳細については、出力モードおよび出力形式リファレンスを参照してください。
codeknit parse ./srccodeknit parse ./src ./out --output-mode directory-treecodeknit parse ./src --output-mode inline --format json --edgescodeknit graph show
Section titled “codeknit graph show”codeknit graph show <input-path>| 引数 | 必須 | 説明 |
|---|---|---|
input-path |
はい | ソースディレクトリまたは単一のソースファイル。 |
| フラグ | タイプ | デフォルト | 許可される値 | 説明 |
|---|---|---|---|---|
-o, --output |
string | ./skeleton/codeknit-graph.html |
ファイルパス | 出力HTMLファイル。 |
--collect-test |
bool | false |
— | テストファイルを含めます。 |
--workers |
int | 0 (NumCPU) |
0以上 |
最大同時解析ゴルーチン数。 |
--verbose |
bool | false |
— | 進捗情報を表示します。 |
--header-language |
string | c |
c、cpp |
.hファイルに使用するパーサー。 |
--include GLOB |
string, repeatable | サポートされているすべてのソース | — | 一致するソースパスを含めます。 |
--exclude GLOB |
string, repeatable | なし | — | 一致するパスまたはディレクトリを除外します。 |
--max-file-size BYTES |
int | 10485760 |
0は制限を無効にします |
サイズの大きいソースファイルをスキップします。 |
--strict |
bool | false |
— | スキャンまたは解析の診断が発生した場合、出力前に失敗します。 |
このコマンドは自己完結型のHTMLファイルを書き込み、デフォルトのブラウザで開きます。ビューアは解決された関係を描画し、不確実な関係の数を表示します。
codeknit graph show ./src -o graph.htmlcodeknit graph analyze
Section titled “codeknit graph analyze”codeknit graph analyze <input-path>| 引数 | 必須 | 説明 |
|---|---|---|
input-path |
はい | ソースディレクトリまたは単一のソースファイル。 |
| フラグ | タイプ | デフォルト | 許可される値 | 説明 |
|---|---|---|---|---|
-o, --output |
string | ./skeleton/graph_analysis.skt |
ファイルパス | 出力.sktファイル。 |
--collect-test |
bool | false |
— | テストファイルを含めます。 |
--workers |
int | 0 (NumCPU) |
0以上 |
最大同時解析ゴルーチン数。 |
--verbose |
bool | false |
— | 進捗情報を表示します。 |
--fan-threshold |
int | 10 |
— | ハブシンボルとしてフラグを立てるための最小ファンインまたはファンアウト。 |
--god-threshold |
int | 15 |
— | godクラスまたは関数としてフラグを立てるための最小containsエッジ数。 |
--max-inheritance-depth |
int | 5 |
— | この値より深い継承チェーンにフラグを立てます。 |
--top-n |
int | 30 |
0 = 制限なし |
ランク付けされた出力セクションの上限。 |
--betweenness-threshold |
float | 0.001 |
— | 報告する最小媒介中心性値。 |
--propagation-cutoff |
float | 0.05 |
— | 変更伝播を続行する最小確率。 |
--header-language |
string | c |
c、cpp |
.hファイルに使用するパーサー。 |
--include GLOB |
string, repeatable | サポートされているすべてのソース | — | 一致するソースパスを含めます。 |
--exclude GLOB |
string, repeatable | なし | — | 一致するパスまたはディレクトリを除外します。 |
--max-file-size BYTES |
int | 10485760 |
0は制限を無効にします |
サイズの大きいソースファイルをスキップします。 |
--strict |
bool | false |
— | スキャンまたは解析の診断が発生した場合、出力前に失敗します。 |
依存関係メトリクスは不確実な関係およびファイル/インクルードメタデータを除外します。レポートは除外された関係の数を記録します。
codeknit graph analyze ./src -o analysis.skt --fan-threshold 15 --top-n 50codeknit graph hotspots
Section titled “codeknit graph hotspots”codeknit graph hotspots <input-path>| 引数 | 必須 | 説明 |
|---|---|---|
input-path |
はい | Gitリポジトリ内のソースディレクトリ。 |
| フラグ | タイプ | デフォルト | 許可される値 | 説明 |
|---|---|---|---|---|
-o, --output |
string | ./skeleton/hotspots.skt |
ファイルパス | 出力ファイル。 |
--format |
string | skt |
skt、json |
出力形式。 |
--since |
string | 12mo |
180d、12mo、2yなどのウィンドウ |
履歴ウィンドウ。 |
--max-commits |
int | 2000 |
— | 検査する最大コミット数。 |
--max-files-per-commit |
int | 50 |
— | この値より多くのファイルに触れるコミットを除外します。 |
--min-cochanges |
int | 3 |
— | 報告する時間的結合の最小共有コミット数。 |
--top-n |
int | 30 |
— | セクションごとの最大結果数。 |
--include-merges |
bool | false |
— | 履歴メトリクスにマージコミットを含めます。 |
--collect-test |
bool | false |
— | テストファイルを含めます。 |
--workers |
int | 0 (NumCPU) |
0以上 |
最大同時解析ゴルーチン数。 |
--verbose |
bool | false |
— | 進捗情報を表示します。 |
--header-language |
string | c |
c、cpp |
.hファイルに使用するパーサー。 |
--include GLOB |
string, repeatable | サポートされているすべてのソース | — | 一致するソースパスを含めます。 |
--exclude GLOB |
string, repeatable | なし | — | 一致するパスまたはディレクトリを除外します。 |
--max-file-size BYTES |
int | 10485760 |
0は制限を無効にします |
サイズの大きいソースファイルをスキップします。 |
--strict |
bool | false |
— | スキャンまたは解析の診断が発生した場合、出力前に失敗します。 |
このコマンドは、コミット頻度、行の変更量、および新しさをファイルレベルのPageRank、推移的ファンイン、および媒介中心性と組み合わせます。また、一緒に変更されるファイル間の時間的結合も報告します。デフォルトではマージコミットは除外されます。
codeknit graph hotspots ./src --since 2y --format json -o hotspots.jsoncodeknit fingerprint
Section titled “codeknit fingerprint”codeknit fingerprint <input-path>| 引数 | 必須 | 説明 |
|---|---|---|
input-path |
はい | ソースディレクトリまたは単一のソースファイル。 |
| フラグ | タイプ | デフォルト | 許可される値 | 説明 |
|---|---|---|---|---|
-o, --output |
string | ./skeleton/fingerprints.skt |
ファイルパス | 出力.sktファイル。 |
--min-similarity |
int | 65 |
0–100 |
報告する最小類似度。 |
--max-similarity |
int | 95 |
0–100 |
報告する最大類似度。 |
--show-all |
bool | false |
— | 生のトークンデータを含む[fingerprints]セクションも出力します。 |
--rerank |
bool | false |
— | セマンティックな近傍を見つけ、Ollama埋め込みで候補を再ランク付けします。ollama serveおよびollama pull qwen3-embedding:0.6bが必要です。 |
--model |
string | qwen3-embedding:0.6b |
Ollamaモデル名 | --rerankで使用するOllama埋め込みモデル。 |
--collect-test |
bool | false |
— | テストファイルを含めます。 |
--workers |
int | 0 (NumCPU) |
0以上 |
最大同時解析ゴルーチン数。 |
--verbose |
bool | false |
— | 進捗情報を表示します。 |
--header-language |
string | c |
c、cpp |
.hファイルに使用するパーサー。 |
--include GLOB |
string, repeatable | サポートされているすべてのソース | — | 一致するソースパスを含めます。 |
--exclude GLOB |
string, repeatable | なし | — | 一致するパスまたはディレクトリを除外します。 |
--max-file-size BYTES |
int | 10485760 |
0は制限を無効にします |
サイズの大きいソースファイルをスキップします。 |
--strict |
bool | false |
— | スキャンまたは解析の診断が発生した場合、出力前に失敗します。 |
デフォルトの範囲である65–95%は、100%の一致を除外します。完全な正規化トークンの一致を報告するには、両方の境界を100に設定します:
codeknit fingerprint ./src --min-similarity 100 --max-similarity 100完全な正規化トークンの候補は完全です。500以上の対象シンボルがある場合、他の近似重複候補は近似トップ50の近傍検索を使用します。--rerankは、構造的に完全な候補を削除する可能性があります。詳細については、分析信頼性を参照してください。
codeknit completion
Section titled “codeknit completion”codeknit completion <shell>| 引数 | 必須 | 許可される値 | 説明 |
|---|---|---|---|
shell |
はい | bash、zsh、fish、powershell |
補完スクリプトを生成するシェル。 |
スクリプトはstdoutに書き込まれます。
codeknit completion zsh >> ~/.zshrc