インストール¶
要件¶
Python 3.13 以上
Git（diff モード・PR モードで必要）
グローバルインストール（uv tool install）¶
uv tool install を使うと、仮想環境を明示的にアクティベートせずに 8moku / hachimoku コマンドをグローバルに利用できます。
Git URL からインストール¶
リポジトリを直接指定してインストールします:
uv tool install git+https://github.com/drillan/hachimoku.git
ローカルクローンからインストール¶
リポジトリをクローンしてからインストールします:
git clone https://github.com/drillan/hachimoku.git
cd hachimoku
uv tool install .
uv sync との使い分け¶
方法 |
対象 |
用途 |
|---|---|---|
|
利用者 |
グローバルにコマンドをインストールしてレビューツールとして使用 |
|
開発者 |
プロジェクトディレクトリ内で開発・テスト・デバッグ |
利用者:
uv tool installでインストールすれば、任意のディレクトリから8mokuコマンドを実行できます開発者:
uv syncでプロジェクトの仮想環境に依存関係を同期し、uv run経由でコマンドを実行します
アップグレード¶
Git URL からインストールした場合¶
uv tool install --reinstall git+https://github.com/drillan/hachimoku.git
ローカルクローンからインストールした場合¶
cd hachimoku
git pull
uv tool install --reinstall .
注釈
uv tool install は既にインストール済みの場合、何も行いません。
--reinstall フラグにより、全パッケージを強制的に再インストールします。
このフラグは --refresh（キャッシュ無効化）を含意するため、
リモートリポジトリから確実に最新のコードを取得します。
ソースからインストール（開発用）¶
リポジトリをクローンして依存関係を同期します:
git clone https://github.com/drillan/hachimoku.git
cd hachimoku
uv sync
開発用ツール（テスト、リンター、型チェッカー）も含める場合:
uv sync --group dev
セットアップ¶
インストール後、プロジェクトディレクトリで初期化を行います:
cd your-project
8moku init
以下のファイルが .hachimoku/ ディレクトリに作成されます:
config.toml- 設定ファイル（全オプションがコメントアウトされたテンプレート）agents/*.toml- ビルトインエージェント定義のコピーreviews/- レビュー結果の JSONL 蓄積ディレクトリ.gitignoreへの/.hachimoku/エントリ自動追加（Git リポジトリ内のみ。未登録の場合のみ）
設定の詳細は 設定 を参照してください。
動作確認¶
# ヘルプの表示
8moku --help
# エージェント一覧の確認
8moku agents
hachimoku コマンドも同じ機能を提供します:
hachimoku --help