Overview

A simple CLI to access the Playbooks platform.

Prerequisites

• Node
• A Playbooks account

Quick Start

npm install -g @playbooks/cli
playbooks login
playbooks download <repo_uuid>

Description

The Playbooks CLI gives developers easy terminal access to their Playbooks account so they can preview, purchase, download, and clone repositories from anywhere. Using the CLI, developers can toggle in and out of their associated accounts making it a breeze to perform similar actions on behalf of those entities. After installation, simply use the playbooks prompt followed by the commands outlined below.

Configuration

Playbooks will look for a config file at the root of your file system ~/.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
uuid=eric-hubbell
[email protected]
token=********
...

Table of Contents

• global
• account
• banks
• cards
• clone
• config
• download
• login
• logout
• orders
• ping
• repo
• repos
• session
• subscription
• teams
• toggle

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 |

Banks

View your account banks.

playbooks banks
playbooks banks --select 'id,summary,createdAt'

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

Cards

View your account cards.

playbooks cards
playbooks cards --select 'id,summary,createdAt'

| 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,createdAt'

| Option | Type | Description | | :--- | :--- | :--- | | --select | string[] | A comma separated list of 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-repo

| 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'

| 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 --remove

| 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,amount,createdAt'

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

Login

Login to your Playbooks account from the command line.

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

Orders

View your account orders.

playbooks orders
playbooks orders --select 'id,amount,createdAt'

| Option | Type | Description | | :--- | :--- | :--- | | --entity | enum | Filter by entityType | | --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'

| 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 ping

Repo

Fetch a specific repo

playbooks repo <uuid>
playbooks repo <uuid> --select 'id,name,uuid,tagline'

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

Repos

Fetch a list of repos

playbooks repos
playbooks repos --select 'id,name,uuid,tagline'
playbooks repos --framework 'react'
playbooks repos --language 'typescript'

| 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'

| 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'

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

Teams

View a list of your session teams

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

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

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

Toggle

Toggle your active account.

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

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

Transfers

View your account transfers.

playbooks transfers
playbooks transfers --select 'id,amount,createdAt'

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

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.