Commands
The Playbooks CLI comes with the following commands:
Account
Display which account is currently active.
playbooks account
playbooks account --select 'id,name,email'Available options
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of fields you'd like to display |
Banks
View your account bank accounts.
playbooks banks
playbooks banks --select 'id,summary,createdAt'Available options
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of fields you'd like to display |
Cards
View your account credit cards.
playbooks cards
playbooks cards --select 'id,summary,createdAt'Available options
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of fields you'd like to display |
Charges
View your account charges.
playbooks charges
playbooks charges --select 'id,amount,card.id'Available options
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of fields you'd like to display |
Clone
Clone a play to your Github account.
playbooks clone <uuid>
playbooks clone <uuid> --submission
playbooks clone <uuid> --stack
playbooks clone <uuid> --account playbooks-community --name my-new-repo --privateAvailable options
Option | Type | Description |
|---|---|---|
| --account | string | Clone to a specific account |
| --name | string | Rename the cloned playsitory |
| --private | boolean | Mark the cloned playsitory as private |
| --stack | boolean | Conditional flag to clone a stack |
| --submission | boolean | Conditional flag to clone a submission |
| --version | string | Specify the versionId |
Config
Display your config file.
playbooks config
playbooks config --select 'id,name,email'Available options
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'
playbooks download <uuid> --version 'v1.0.0'Available options
Option | Type | Description |
|---|---|---|
| --path | string | Path to custom destination folder |
| --name | string | Custom name for the download |
| --version | string | Specify the versionId |
Downloads
View your account downloads.
playbooks downloads
playbooks downloads --select 'id,status,createdAt'Available options
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of fields you'd like to display |
Login
Login to Playbooks account using email / password.
playbooks login
playbooks login --email acme@example.com --password ******Available options
Option | Type | Description |
|---|---|---|
| string | Your email address | |
| --password | string | Your password |
Logout
Logout of your Playbooks account.
playbooks logoutOauth
Login to Playbooks via Github OAuth.
playbooks oauthOrders
View your account orders.
playbooks orders
playbooks orders --select 'id,amount,createdAt'Available options
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of fields you'd like to display |
Payouts
View your account payouts.
playbooks payouts
playbooks payouts --select 'id,amount,createdAt'Available options
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of fields you'd like to display |
Ping
Test your connection to the Playbooks API.
playbooks pingPlay
Fetch and display a specific play
playbooks play <uuid>
playbooks play <uuid> --select 'id,name,uuid,tagline'Available options
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of fields you'd like to display |
Plays
Fetch and display a list of plays
playbooks plays
playbooks plays --select 'id,name,uuid,tagline'
playbooks plays --framework 'react'
playbooks plays --language 'typescript'
playbooks plays --platform 'web'
playbooks plays --tool 'stripe'
playbooks plays --tag 'portfolio'
playbooks plays --user 'ehubbell'
playbooks plays --view 'featured'Available options
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of fields you'd like to display |
| --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 | enum | Fetch by view |
Session
Fetch and display your current session
playbooks session
playbooks session --select 'id,name,uuid,email'Available options
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of fields you'd like to display |
Subscription
Fetch and display your account subscription
playbooks subscription
playbooks subscription --select 'id,name,uuid,email'Available options
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of fields you'd like to display |
Teams
Fetch and display your account teams
playbooks teams
playbooks teams --select 'id,name,uuid,email'Available options
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of fields you'd like to display |
Toggle
Toggle your active account.
playbooks toggle
playbooks toggle --uuid 'playbooks-community'Available options
Option | Type | Description |
|---|---|---|
| --uuid | string | Account identifier |
Transfers
View your incoming account transfers.
playbooks transfers
playbooks transfers --select 'id,amount,createdAt'Available options
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of fields you'd like to display |