Playbook

再利用できる進め方を検索、authoring、publish、共有、保存、改善します。

探して読む

epismo playbook search --query "release review" --category operations
epismo playbook get <playbook-id-or-reference>
epismo playbook version list <playbook-id>
epismo playbook version get <playbook-id> <version-id>
epismo playbook starred

playbook get は UUID、pb:alias、pb:handle/alias などの Playbook reference を受け取ります。search では text、category、page size、cursor、server-side filter expression、aggregation option を指定できます。結果を使う前に、input schema、resource hint、expected output を含む Definition 全体を確認してください。

create と publish

完全な Definition は file で渡します。

{
	"ownerId": "<account-id>",
	"acl": ["<user-or-project-id>"],
	"definition": {
		"schemaVersion": 1,
		"title": "Release review",
		"description": "Review a release before publication.",
		"category": "operations",
		"inputSchema": {
			"type": "object",
			"required": ["repository"],
			"properties": { "repository": { "type": "string" } }
		},
		"steps": [
			{
				"title": "Inspect the change",
				"instructions": "Review scope, tests, risks, and rollback plan.",
				"resourceHints": [
					{ "kind": "document", "ref": "https://example.com/release-policy" }
				],
				"expectedOutputs": [{ "title": "Decision and evidence", "format": "markdown" }]
			}
		]
	}
}

epismo playbook create --input @playbook.json
epismo playbook version publish <playbook-id> \
  --base-version-id <latest-version-id> --input @next-version.json

新しい Step では ID を省略します。同じ論理 Step に限り既存の4文字 ID を維持してください。publish は immutable な Version を作ります。base-version conflict 後は base ID だけを変えず、latest を取得して変更意図を merge します。

access、参照、保存

epismo playbook acl <playbook-id> --acl <principal-ids>
epismo alias set <alias> <playbook-id> --owner-id <account-id>
epismo alias list --owner-id <account-id>
epismo playbook share create <playbook-id>
epismo playbook star <playbook-id>
epismo playbook unstar <playbook-id>
epismo playbook archive <playbook-id>

ACL は durable access、alias は読みやすい名前、share token は token-based read、star は個人保存を提供します。これらは独立しています。archive は Version を書き換えず、Playbook を通常利用から外します。

Suggestion

epismo suggestion create --playbook-id <playbook-id> \
  --base-version-id <version-id> --title "Clarify evidence" --content "..."
epismo suggestion list --playbook-id <playbook-id> --statuses open
epismo suggestion update <suggestion-id> --title "..." --content "..."
epismo suggestion resolve <suggestion-id> --status applied \
  --result-version-id <new-version-id>

author は open Suggestion を編集し、Playbook owner が resolve します。applied には提案から publish した Version が必要です。採用しない場合は declined、取り下げる場合は archived にします。