クイックスタート

必要なのは Node 22.18 以降だけです。ビルドも依存パッケージもありません。

sh
npx yokoten install  # PC ごとに一度cd your-projectnpx yokoten init  # プロジェクトごとに一度npx yokoten doctor  # 今いる関所と、次の一手

最初の npm リリース(10 月 24 日)までは、clone からインストールしてください。

最後の行の doctor が、今いる段階と次の一手をひとつ示します。あとは AI エージェントでプロジェクトを開くだけです。エージェントなしでも使えます。

clone からインストール

sh
git clone https://github.com/yokoten-labs/yokotennode yokoten/bin/yokoten.ts install  # PC ごとに一度cd your-projectnode ~/.local/share/yokoten/bin/yokoten.ts init  # プロジェクトごとに一度node ~/.local/share/yokoten/bin/yokoten.ts doctor  # 今いる関所と、次の一手

clone からインストールした場合、PATH に yokoten コマンドは入りません。install がシェルの設定ファイル用の alias の行を表示するので、それを追加してから新しいシェルを開いてください。

動作を確認する

プロジェクトで doctor を実行します。道のり全体を表示し、次の一手に印をつけます:

sh
npx yokoten doctoryokoten 0.1.0, self-test okthe road: stage 1 of 5, safety net  1. safety net    done        rules    done        tool-hook    done        commit-check    done        runtime    next        tests: CI does not run the tests; add a step that runs `npm test` …  2. issues and pull requests    …

一部省略しています。表示される手順はプロジェクトによって異なります。

何も実行せずに番人が止める様子を見るには、架空のツール呼び出しを渡してみてください:

sh
echo '{"tool_name":"Bash","tool_input":{"command":"git push --tags"}}' | node .yokoten/bin/yokoten.ts hookyokoten: git push --tags pushes tags. Only the owner decides when to release. If the owner asked for this, they start the session with YOKOTEN_RELEASE_APPROVAL set.

何も push されません。フックは呼び出しを読むだけです。終了コード 2 は「ブロックした」という意味です。

もっと知る