コンテンツにスキップ

CLI コマンド

similarity-goは、GoプロジェクトでのコードPRAG類似性を分析するためのCLIコマンドの包括的なセットを提供します。すべてのコマンドは、分析動作をカスタマイズするためのさまざまなオプションとフラグをサポートしています。

これらのフラグはすべてのコマンドで使用できます:

フラグ短縮説明デフォルト
--help-hコマンドのヘルプを表示
--version-vバージョン情報を表示
--config-c設定ファイルのパス.similarity-go.yaml
--verbose詳細出力を有効化false
--quiet-q非必須出力を抑制false

Go コードの類似性を分析します。

Terminal window
similarity-go analyze [paths...] [flags]
  • paths...: 分析する1つ以上のパス(ファイルまたはディレクトリ)
フラグ説明デフォルト
--thresholdfloat類似性しきい値 (0.0-1.0)0.8
--formatstring出力形式 (detailed, json, yaml)detailed
--outputstring出力ファイルパスstdout
--ignore[]string無視するパターン[]
--include[]string含めるパターン[]
--parallelint並列ワーカー数CPU コア数
--cachebool結果キャッシュを有効化true
Terminal window
# 現在ディレクトリの基本解析
similarity-go analyze ./
# カスタムしきい値で特定ディレクトリを解析
similarity-go analyze ./cmd ./internal --threshold 0.9
# 結果をJSONにエクスポート
similarity-go analyze ./ --format json --output results.json
# テストファイルとvendorディレクトリを無視
similarity-go analyze ./ --ignore "**/*_test.go" --ignore "vendor/**"

設定ファイルと設定を管理します。

Terminal window
similarity-go config [subcommand]

新しい設定ファイルを初期化:

Terminal window
similarity-go config init [--force]

現在のディレクトリに.similarity-go.yamlファイルを作成します。

設定ファイルを検証:

Terminal window
similarity-go config validate [--config path]

現在の設定を表示:

Terminal window
similarity-go config show [--config path]

分析キャッシュを管理します。

Terminal window
similarity-go cache [subcommand]

分析キャッシュをクリア:

Terminal window
similarity-go cache clear

キャッシュ情報を表示:

Terminal window
similarity-go cache info

古いキャッシュエントリを削除:

Terminal window
similarity-go cache prune [--days int]

一般的な問題を診断し、環境を検証します。

Terminal window
similarity-go doctor

このコマンドは以下をチェックします:

  • Goのインストールとバージョン
  • プロジェクト構造
  • 設定の有効性
  • ファイルの権限
  • 使用可能なメモリとディスク容量

バージョン情報を表示:

Terminal window
similarity-go version [--format string]

形式をサポート: text(デフォルト)、jsonyaml

similarity-goは標準的な終了コードを使用します:

コード意味
0成功
1一般的なエラー
2設定エラー
3分析エラー
4ファイルシステムエラー