docs: add --draft-pr, --delete-all, sync-with-root to CLI reference

This commit is contained in:
nrslib 2026-02-20 19:58:13 +09:00
parent 01b68d1104
commit 52fb385e75
2 changed files with 12 additions and 0 deletions

View File

@ -14,6 +14,7 @@
| `-w, --piece <name or path>` | Piece 名または piece YAML ファイルのパス | | `-w, --piece <name or path>` | Piece 名または piece YAML ファイルのパス |
| `-b, --branch <name>` | ブランチ名を指定(省略時は自動生成) | | `-b, --branch <name>` | ブランチ名を指定(省略時は自動生成) |
| `--auto-pr` | PR を作成(インタラクティブ: 確認スキップ、pipeline: PR 有効化) | | `--auto-pr` | PR を作成(インタラクティブ: 確認スキップ、pipeline: PR 有効化) |
| `--draft-pr` | PR をドラフトとして作成 |
| `--skip-git` | ブランチ作成、コミット、プッシュをスキップpipeline モード、piece のみ実行) | | `--skip-git` | ブランチ作成、コミット、プッシュをスキップpipeline モード、piece のみ実行) |
| `--repo <owner/repo>` | リポジトリを指定PR 作成用) | | `--repo <owner/repo>` | リポジトリを指定PR 作成用) |
| `--create-worktree <yes\|no>` | worktree 確認プロンプトをスキップ | | `--create-worktree <yes\|no>` | worktree 確認プロンプトをスキップ |
@ -169,6 +170,9 @@ takt watch
# タスクブランチの一覧表示(マージ/削除) # タスクブランチの一覧表示(マージ/削除)
takt list takt list
# 全タスクを一括削除
takt list --delete-all
# 非インタラクティブモードCI/スクリプト向け) # 非インタラクティブモードCI/スクリプト向け)
takt list --non-interactive takt list --non-interactive
takt list --non-interactive --action diff --branch takt/my-branch takt list --non-interactive --action diff --branch takt/my-branch
@ -176,6 +180,8 @@ takt list --non-interactive --action delete --branch takt/my-branch --yes
takt list --non-interactive --format json takt list --non-interactive --format json
``` ```
インタラクティブモードでは **Sync with root** アクションも利用可能です。ルートリポジトリの HEAD をワークツリーブランチにマージし、コンフリクトが発生した場合は AI が自動解決を試みます。
### タスクディレクトリワークフロー(作成 / 実行 / 確認) ### タスクディレクトリワークフロー(作成 / 実行 / 確認)
1. `takt add` を実行し、`.takt/tasks.yaml` に pending レコードが作成されたことを確認。 1. `takt add` を実行し、`.takt/tasks.yaml` に pending レコードが作成されたことを確認。

View File

@ -14,6 +14,7 @@ This document provides a complete reference for all TAKT CLI commands and option
| `-w, --piece <name or path>` | Piece name or path to piece YAML file | | `-w, --piece <name or path>` | Piece name or path to piece YAML file |
| `-b, --branch <name>` | Specify branch name (auto-generated if omitted) | | `-b, --branch <name>` | Specify branch name (auto-generated if omitted) |
| `--auto-pr` | Create PR (interactive: skip confirmation, pipeline: enable PR) | | `--auto-pr` | Create PR (interactive: skip confirmation, pipeline: enable PR) |
| `--draft-pr` | Create PR as draft |
| `--skip-git` | Skip branch creation, commit, and push (pipeline mode, piece-only) | | `--skip-git` | Skip branch creation, commit, and push (pipeline mode, piece-only) |
| `--repo <owner/repo>` | Specify repository (for PR creation) | | `--repo <owner/repo>` | Specify repository (for PR creation) |
| `--create-worktree <yes\|no>` | Skip worktree confirmation prompt | | `--create-worktree <yes\|no>` | Skip worktree confirmation prompt |
@ -169,6 +170,9 @@ List task branches and perform actions (merge, delete, etc.).
# List task branches (merge/delete) # List task branches (merge/delete)
takt list takt list
# Delete all tasks at once
takt list --delete-all
# Non-interactive mode (for CI/scripts) # Non-interactive mode (for CI/scripts)
takt list --non-interactive takt list --non-interactive
takt list --non-interactive --action diff --branch takt/my-branch takt list --non-interactive --action diff --branch takt/my-branch
@ -176,6 +180,8 @@ takt list --non-interactive --action delete --branch takt/my-branch --yes
takt list --non-interactive --format json takt list --non-interactive --format json
``` ```
In interactive mode, `takt list` also offers a **Sync with root** action to merge the root repository's HEAD into a worktree branch, with AI-assisted conflict resolution.
### Task Directory Workflow (Create / Run / Verify) ### Task Directory Workflow (Create / Run / Verify)
1. Run `takt add` and confirm a pending record is created in `.takt/tasks.yaml`. 1. Run `takt add` and confirm a pending record is created in `.takt/tasks.yaml`.