Commands

CLI reference with copyable examples and supported options.

All commands also support the --config flag. See Global Options for shared flags.

Account

Display which account is currently active. Use playbooks account <action> for account-scoped resources.

Terminal

playbooks account
playbooks account --select 'id,name,email'

Option	Type	Description
`--select`	`string[]`	A comma separated list of account fields you'd like to display

Banks

View your account banks.

Terminal

playbooks account banks
playbooks account banks --page 2 --pageSize 25

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Bookmarks

View your account bookmarks.

Terminal

playbooks account bookmarks
playbooks account bookmarks --page 2 --pageSize 25

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Cards

View your account cards.

Terminal

playbooks account cards
playbooks account cards --page 2 --pageSize 25

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Charges

View your account charges.

Terminal

playbooks account charges
playbooks account charges --page 2 --pageSize 25

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Collections

View your account collections.

Terminal

playbooks account collections
playbooks account collections --page 2 --pageSize 25

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Drafts

View your account drafts.

Terminal

playbooks account drafts
playbooks account drafts --page 2 --pageSize 25

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Downloads

View your account downloads.

Terminal

playbooks account downloads
playbooks account downloads --page 2 --pageSize 25

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Invoices

View your account invoices.

Terminal

playbooks account invoices
playbooks account invoices --page 2 --pageSize 25

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Ledgers

View your account ledger activity.

Terminal

playbooks account ledgers
playbooks account ledgers --select 'id,amount,type'

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display

Payouts

View your account payouts.

Terminal

playbooks account payouts
playbooks account payouts --page 2 --pageSize 25

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Templates

View your account templates.

Terminal

playbooks account templates
playbooks account templates --status draft --page 1

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--status`	`string`	Filter by status
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Subscription

Fetch and display your account subscription.

Terminal

playbooks account subscription
playbooks account subscription --select 'id,name,uuid,email'

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display

Teams

View a list of your account teams.

Terminal

playbooks account teams
playbooks account teams --page 2 --pageSize 25

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

This command is only available when a user account is active.

Transfers

View your account transfers.

Terminal

playbooks account transfers
playbooks account transfers --page 2 --pageSize 25

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Usage

Fetch and display your account usage statistics.

Terminal

playbooks account usage
playbooks account usage --select 'id,totalCredits,totalRemaining'

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display

Clone

Clone a template to your GitHub account.

Terminal

playbooks clone <uuid>
playbooks clone <uuid> --account mile-hi-labs --private

Option	Type	Description
`--account`	`string`	Clone to a specific account
`--name`	`string`	Rename the cloned template
`--private`	`boolean`	Mark the cloned template as private
`--version`	`string`	Specify the version ID

Collections

Fetch collection related resources.

Terminal

playbooks collections
playbooks collections --query next
playbooks collections starter-packs
playbooks collections starter-packs open
playbooks collections starter-packs --include team
playbooks collections starter-packs templates --view featured

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--include`	`string`	A comma separated list of relationships to include
`--view`	`string`	Filter by view
`--query`	`string`	Filter by a search query
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Config

Display your config file.

Terminal

playbooks config
playbooks config --select 'token,uuid'

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display

Download

Download a template to your local machine.

Terminal

playbooks download <uuid>
playbooks download <uuid> --path ~/path/to/folder

Option	Type	Description
`--path`	`string`	Path to a custom destination folder
`--name`	`string`	Custom name for the directory
`--version`	`string`	Specify a specific version to download

Init

Add the minimal playbooks.json identity manifest to your project.

Terminal

playbooks init
playbooks init --path ~/path/to/project

Option	Type	Description
`--path`	`string`	Path to a custom destination folder

Terminal

playbooks login
playbooks login --email acme@example.com --password ******

Option	Type	Description
`--email`	`string`	Your email address
`--password`	`string`	Your password

Register

Create a Playbooks account via name, email, and password.

Terminal

playbooks register
playbooks register --name "Acme Team" --email acme@example.com --password ******

Option	Type	Description
`--name`	`string`	Your name
`--email`	`string`	Your email address
`--password`	`string`	Your password

Logout

Logout of your Playbooks account.

Terminal

playbooks logout

Option	Type	Description
None	`—`	No command-specific options

MCP

Configure Playbooks MCP for supported coding environments on your local machine.

Terminal

playbooks mcp claude
playbooks mcp codex
playbooks mcp cursor
playbooks mcp vscode

Option	Type	Description
None	`—`	No command-specific options

OAuth

Terminal

playbooks oauth

Option	Type	Description
None	`—`	No command-specific options

Ping

Test your connection to the Playbooks API.

Terminal

playbooks ping

Option	Type	Description
None	`—`	No command-specific options

Templates

Fetch template related resources.

Terminal

playbooks templates
playbooks templates --query next
playbooks templates --view featured
playbooks templates actix-official-starter
playbooks templates actix-official-starter demo
playbooks templates actix-official-starter deploy
playbooks templates actix-official-starter open

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--include`	`string`	A comma separated list of relationships to include
`--view`	`string`	Filter by view
`--query`	`string`	Filter by a search query
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Publish

Publish a template to the marketplace.

Terminal

playbooks publish <uuid>

Option	Type	Description
None	`—`	No command-specific options

Session

Fetch and display your current session.

Terminal

playbooks session
playbooks session --select 'id,name,uuid,email'

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display

Submit

Submit a template via a GitHub URL.

Terminal

playbooks submit https://github.com/ehubbell/astro-official-starter
playbooks submit https://github.com/ehubbell/astro-official-starter --type default --visibility public

Option	Type	Description
`--type`	`string`	Select a type
`--visibility`	`string`	Select a visibility setting

Sync

Sync a template to pull the latest files from GitHub.

Terminal

playbooks sync <uuid>

Option	Type	Description
None	`—`	No command-specific options

Teams

Fetch team related resources.

Terminal

playbooks teams
playbooks teams --query next
playbooks teams mile-hi-labs
playbooks teams mile-hi-labs open
playbooks teams mile-hi-labs --include users
playbooks teams mile-hi-labs templates --view featured

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--include`	`string`	A comma separated list of relationships to include
`--view`	`string`	Filter by view
`--query`	`string`	Filter by a search query
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value

Toggle

Toggle your active account.

Terminal

playbooks toggle
playbooks toggle --uuid 'playbooks-community'

Option	Type	Description
`--uuid`	`string`	Account identifier

Users

Fetch user related resources.

Terminal

playbooks users
playbooks users --query next
playbooks users ehubbell
playbooks users ehubbell open
playbooks users ehubbell --include teams
playbooks users ehubbell templates --view featured

Option	Type	Description
`--select`	`string[]`	A comma separated list of fields you'd like to display
`--include`	`string`	A comma separated list of relationships to include
`--view`	`string`	Filter by view
`--query`	`string`	Filter by a search query
`--page`	`number`	Fetch a specific page
`--pageSize`	`number`	Fetch a specific page size
`--sortProp`	`string`	Sort by a specific property
`--sortValue`	`string`	Sort using a specific value