クイックスタート
このガイドでは、リポジトリを Nolto プロジェクトに紐付け、.nolto/roadmaps/<slug>.json と関連文書を同期します。
前提条件
- Node.js 20.11 以上
- Git リポジトリ
- Nolto アカウント
1. CLI をインストールする
npm install -g @nolto/cli
グローバルインストールせず、各コマンドを npx @nolto/cli で実行することもできます。
2. API token を用意する
設定 > API トークン で Personal API Token を発行します。token は作成時に一度だけ表示されます。
token をリポジトリへコミットしないでください。入力後はユーザー設定ファイルへ権限 0600 で保存されます。
3. リポジトリを初期化する
対象リポジトリの中で実行します。
nolto init
対話画面で Base URL、API token、同期先プロジェクトを選びます。プロジェクトがなければ、その場で作成できます。リポジトリ設定を承認すると、次のファイルと設定が準備されます。
nolto.json: Nolto project ID.nolto/roadmaps/<slug>.json: 進捗の正本(slug はファイル名)- roadmap-progress skill: AI 開発ツールが roadmap を更新するための手順
- watch registry:
nolto watchの監視対象
nolto.json と .nolto/roadmaps/<slug>.json はチームで共有するため、リポジトリへコミットしてください。
4. 現在の設定を確認する
nolto whoami
nolto link --show
5. 最初の同期を実行する
nolto sync
CLI は roadmap の形式を検証し、フェーズ/タスクから参照された Markdown 文書もまとめて送信します。同じ内容を再送しても重複せず、変更のない文書は更新されません。
同期後、プロジェクト詳細からロードマップを開くと、フェーズツリーで進捗を確認できます。各フェーズにあるプランのチップから文書を開き、整形ビューと Markdown 原文を切り替えられます。整形処理中は生成中の案内が表示され、失敗した場合も Markdown 原文を閲覧できます。