はじめに
このページは、「リポジトリがある」状態から「Slipway が実際の変更を 1 つ統制している」状態までの最短ルートです。
Slipway は、いくつかの永続的なプロジェクト記録を中心に構築されています。
| Slipway のサーフェス | 役割 |
|---|---|
| 統制された変更 | artifacts/changes/<slug>/ 配下にある、境界が定められた 1 つの作業単位。 |
| コードベースマップ | ブラウンフィールド作業向けに artifacts/codebase/ 配下で共有されるリポジトリのコンテキスト。 |
| タスクエビデンス | .git/slipway/runtime/changes/<slug>/evidence/ 配下にあるランタイムの証跡。 |
| レビューエビデンス | 現在のワークトリーと一致しなければならない検証記録。 |
| AI アダプター | エージェントを Slipway CLI へ戻すよう経路づける、生成されたホストファイル。 |
権威は CLI にあります。AI ツールはアーティファクトの作成やステージの実行を支援できますが、ライフサイクルの状態を勝手に作り出したり、エビデンスを手作業で編集したりしてはいけません。
ルートを選ぶ
Section titled “ルートを選ぶ”| 状況 | ここから始める |
|---|---|
| Slipway は初めてで、小さなエンドツーエンドの実行を試したい。 | 最初の統制された変更 |
| すでに振る舞いを持つリポジトリに Slipway を追加する。 | 既存コードベースのオンボーディング |
| インストールとアダプターのコマンドだけが必要。 | インストールとアダプターの更新 |
| 変更が行き詰まったり、古くなったり、分かりにくくなったりしている。 | リカバリーとトラブルシューティング |
| 設計を評価している。 | 設計 と ワークフロー |
具体的な導入パターンについては、実世界のシナリオを参照してください。
最初のインストール
Section titled “最初のインストール”利用中のプラットフォームに合わせて、公式のリリースに基づくインストールパスを選びます。
| プラットフォーム | 推奨パス |
|---|---|
| macOS | brew install --cask signalridge/tap/slipway |
| Windows | scoop bucket add signalridge https://github.com/signalridge/scoop-bucketscoop install slipway |
| Linux | インストールの .deb、.rpm、.apk、tar.gz、AUR、またはコンテナイメージのパスを使います。 |
| Go フォールバック | go install github.com/signalridge/slipway@latest |
続いて、バイナリが認識されているか確認します。
slipway --help完全なプラットフォーム対応表、リリースアーカイブのパス、チェックサムの検証、ソースからのビルド手順はインストールに記載しています。
リポジトリを初期化する
Section titled “リポジトリを初期化する”リポジトリのルートで次を実行します。
slipway init --tools codex実際に使用するツール ID を指定します。
slipway init --tools claude,codex,opencodeslipway init --tools allslipway init --tools noneslipway init は .slipway.yaml と、必要に応じて生成される AI ツールアダプターを書き出します。アダプターは利便性のためのサーフェスであり、権威は引き続き CLI にあります。
統制された変更を 1 つ始める
Section titled “統制された変更を 1 つ始める”Slipway を手作業で動かす必要はありません。AI ツールのセッションで、変更内容を平易な言葉で記述します。
README に短い使い方メモを追加して。
slipway init が生成したアダプターが、その要求を統制されたライフサイクルへ経路づけます。エントリースキルが変更を引き継ぎ、エージェントがあなたに代わって slipway の各ステージ(インテーク、プランニング、実装、レビュー、done ゲート)を実行します。Slipway がスキルのハンドオフ、チェックポイント、ブロッカー、または done-ready 状態を提示し、あなたの対応が必要になったときだけ停止します。
変更が実際に完了したかを判断するのはエージェントではなく Slipway です。エージェントが読んでいるのと同じ状態を確認したいときは、読み取り専用のサーフェスを使います。
slipway status --jsonslipway next --json --diagnostics自分で動かす(任意)
Section titled “自分で動かす(任意)”ライフサイクルを手作業で実行したい場合は、同じ変更を平易なコマンドで作成して進められます。
slipway new "add a short usage note to README" --profile docs --preset standardslipway run --json --diagnosticsslipway run は Slipway が所有するステージだけを進め、オペレーターと向き合う各境界で停止します。スキルのハンドオフが返ってきた場合は、そのハンドオフを AI ツールで完了させ、続行する前に読み取り専用コマンドを再実行してください。
フェイルクローズしたとき
Section titled “フェイルクローズしたとき”フェイルクローズの出力は機能のひとつです。Slipway が証跡の欠落や陳腐化を検知し、次に取るべき安全なアクションを示したことを意味します。
次の順序で進めます。
slipway status --jsonslipway validateslipway next --json --diagnosticsslipway health --doctor --jsonその後、示されたリカバリーコマンドに従います。change.yaml、検証 YAML、タスクエビデンス、ライフサイクルのタイムスタンプを手作業で編集してはいけません。エビデンスが陳腐化している場合は、それを所有するステージ、レビュアー、またはタスクエビデンスのパスを再実行し、Slipway が現在のワークトリーから現在性を再導出できるようにします。
さらに進める
Section titled “さらに進める”- コピー&ペーストで試せる最初の実行は、最初の統制された変更に従ってください。
- リポジトリにエージェントが学ぶべき慣習がすでにある場合は、既存コードベースのオンボーディングに従ってください。
- 正確なコマンドと JSON サーフェスの詳細が必要なときは、コマンドを使ってください。