Overview

The Playbooks CLI gives developers terminal access to their Playbooks account. Using the CLI, developers can browse, download, clone, and manage their plays from anywhere. After installation, simply use the playbooks prompt followed by the commands outlined below.

Prerequisites

• node
• npm

Installation

npm install @playbooks/cli -g

Quick Start

playbooks login
playbooks download <uuid>

Configuration

The Playbooks CLI will look for the following config file ~/.playbooksrc containing your platform secrets. If one does not exist, the Playbooks CLI will create one when you login. As an alternative, you can provide a custom config file location using the --config flag as part of any command. Here is a sample config file located at the default location on your file system:

# ~/.playbooksrc

id=1
name=Eric Hubbell
[email protected]
uuid=eric-hubbell
token=********
...

Table of Contents

• global
• account
• account banks
• account bookmarks
• account cards
• account charges
• account collections
• account drafts
• account downloads
• account invoices
• account ledgers
• account payouts
• account plays
• account subscription
• account teams
• account transfers
• account usage
• add
• clone
• collections
• config
• download
• frameworks
• init
• languages
• login
• logout
• mcp
• oauth
• ping
• plays
• platforms
• publish
• session
• submit
• sync
• tags
• teams
• tools
• toggle
• users

Global

A list of global commands and options.

playbooks --help
playbooks --version

playbooks login --help
playbooks login --config ~/path/to/.playbooksrc

playbooks download --help
playbooks download --config ~/path/to/.playbooksrc

| Option | Type | Description | | :-------- | :------ | :----------------------------------------- | | --config | string | Path to a custom playbooks config file | | --help | boolean | Display command info and available options | | --version | boolean | Display current library version |

Commands

A list of Playbooks specific commands.

Account

Display which account is currently active.

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 |

Account Banks

View your account banks.

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 |

Account Bookmarks

View your account bookmarks.

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 |

Account Cards

View your account cards.

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 |

Account Charges

View your account charges.

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 |

Account Collections

View your account collections.

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 |

Account Drafts

View your account drafts.

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 |

Account Downloads

View your account downloads.

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 |

Account Invoices

View your account invoices.

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 |

Account Ledgers

View your account ledger activity.

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 |

Account Payouts

View your account payouts.

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 |

Account Plays

View your account plays.

playbooks account plays
playbooks account plays --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 |

Account Subscription

Fetch and display your account subscription

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 |

Account Teams

View a list of your account teams

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 |

Please note: this command is only available when a user account is activated.

Account Transfers

View your account transfers.

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 |

Account Usage

Fetch and display your account usage statistics.

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 |

Add

Add a play to your local project and run install commands.

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

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

Clone

Clone a play to your Github account.

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 play | | --private | boolean | Mark the cloned play as private | | --version | string | Specify the versionId |

Collections

Fetch collection related resources.

playbooks collections
playbooks collections starter-packs
playbooks collections starter-packs --include team
playbooks collections starter-packs plays --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.

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 play to your local machine.

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

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

Frameworks

Fetch framework related resources.

playbooks frameworks
playbooks frameworks react
playbooks frameworks react --include team
playbooks frameworks react plays --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 |

Init

Add a playbooks.json file to your project.

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

| Option | Type | Description | | :----- | :----- | :-------------------------------- | | --path | string | Path to custom destination folder |

Languages

Fetch language related resources.

playbooks languages
playbooks languages typescript
playbooks languages typescript --include framework
playbooks languages typescript plays --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 |

Login

Login to your Playbooks account via email / password.

playbooks login
playbooks login --email [email protected] --password ******

| Option | Type | Description | | :--------- | :----- | :----------------- | | --email | string | Your email address | | --password | string | Your password |

Logout

Logout of your Playbooks account.

playbooks logout

MCP

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

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

Oauth

Login to Playbooks via Github OAuth.

playbooks oauth

Ping

Test your connection to the Playbooks API.

playbooks ping

Plays

Fetch play related resources.

playbooks plays
playbooks plays actix-official-starter
playbooks plays actix-official-starter demo
playbooks plays actix-official-starter deploy
playbooks plays --framework react
playbooks plays --language typescript
playbooks plays --team mile-hi-labs
playbooks plays --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 | | --framework | string | Fetch by framework identifier | | --language | string | Fetch by language identifier | | --platform | string | Fetch by platform identifier | | --team | string | Fetch by team identifier | | --tool | string | Fetch by tool identifier | | --tag | string | Fetch by tag identifier | | --user | string | Fetch by user identifier | | --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 |

Platforms

Fetch platform related resources.

playbooks platforms
playbooks platforms web
playbooks platforms web --include tool
playbooks platforms web plays --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 |

Publish

Publish a play to the marketplace.

playbooks publish <uuid>

Session

Fetch and display your current session

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 play via Github URL.

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

| Option | Type | Description | | :----------- | :----- | :---------------- | | --variant | string | Select variant | | --visibility | string | Select visibility |

Sync

Sync a play to pull the latest files from Github.

playbooks sync <uuid>

Tags

Fetch tag related resources.

playbooks tags
playbooks tags portfolio
playbooks tags portfolio --include user
playbooks tags portfolio plays --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 |

Teams

Fetch team related resources.

playbooks teams
playbooks teams mile-hi-labs
playbooks teams mile-hi-labs --include users
playbooks teams mile-hi-labs plays --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 |

Tools

Fetch tool related resources.

playbooks tools
playbooks tools stripe
playbooks tools stripe --include platform
playbooks tools stripe plays --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.

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

| Option | Type | Description | | :----- | :----- | :----------------- | | --uuid | string | Account identifier |

Users

Fetch user related resources.

playbooks users
playbooks users ehubbell
playbooks users ehubbell --include teams
playbooks users ehubbell plays --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 |

Questions

Please reach out to [email protected] with any technical questions and / or issues.

Author

• Playbooks XYZ
• [email protected]

Contributions

Please open a Github Issue describing the PR you want to submit before starting work.