Playbooks

Search, author, publish, share, save, and improve reusable guidance.

Find and read

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 accepts a UUID or a Playbook reference such as pb:alias and pb:handle/alias. Search supports text, category, page size, cursor, a server-side filter expression, and aggregation options. Read the full Definition—especially input schema, resource hints, and expected outputs—before using a result.

Create and publish

Use a file for a complete Definition:

{
	"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

Omit IDs for new Steps. Preserve an existing four-character ID only for the same logical Step. Publication creates an immutable Version; after a base-version conflict, fetch latest and merge your intent instead of changing only the base ID.

Access, references, and saving

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>

An ACL grants durable access, an alias provides a readable name, a share token provides token-based read access, and a star is personal. These mechanisms are independent. Archiving removes a Playbook from normal use without rewriting its Versions.

Suggestions

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>

The author can edit an open Suggestion; the Playbook owner resolves it. applied requires the Version published from the proposal. Resolve as declined when it should not be adopted and archived when it is withdrawn.