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 account 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 account 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 account 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 account fields you'd like to display |
Clone#
Clone a Playbooks repo to your Github account.
playbooks clone <repo_uuid>
playbooks clone <repo_uuid> --account playbooks-community --name my-new-repoAvailable options#
Option | Type | Description |
|---|---|---|
| --account | string | Clone to a specific account |
| --name | string | Rename the cloned repository |
| --private | boolean | Mark the cloned repository as private |
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 Playbooks repo to your local computer.
playbooks download <repo_uuid>
playbooks download <repo_uuid> --unzip --removeAvailable options#
Option | Type | Description |
|---|---|---|
| --path | string | Path to custom destination folder |
| --unzip | boolean | Automatically unzip the binary file |
| --remove | boolean | Automatically remove the binary file |
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 account fields you'd like to display |
Login#
Login to your Playbooks account from the command line.
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 logoutOrders#
View your account orders.
playbooks orders
playbooks orders --select 'id,amount,createdAt'Available options#
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of account 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 account fields you'd like to display |
Ping#
Test your connection to the Playbooks API.
playbooks pingRepo#
Fetch and display a specific repo
playbooks repo <uuid>
playbooks repo <uuid> --select 'id,name,uuid,tagline'Available options#
Option | Type | Description |
|---|---|---|
| --select | string[] | A comma separated list of account fields you'd like to display |
Repos#
Fetch and display a list of repos
playbooks repos
playbooks repos --select 'id,name,uuid,tagline'
playbooks repos --framework 'react'
playbooks repos --language 'typescript'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 |
| --tool | string | Fetch by tool identifier |
| --topic | string | Fetch by topic 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 account fields you'd like to display |
Session#
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 account 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 account 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 account fields you'd like to display |