Quick Start#

Use this page to get the Playbooks CLI installed, connected, and ready for day-to-day use.

1. Install the CLI#

Terminal
npm install -g @playbooks/cli

Install the CLI on your local machine or any remote environment where you want terminal access to Playbooks.

2. Check connectivity#

Terminal
playbooks ping

A successful response confirms the CLI is installed and can reach the Playbooks API.

3. Login#

For most developers, the guided login flow is the simplest place to start.

Terminal
playbooks login

If you already have credentials and want a non-interactive flow, you can pass them directly.

Terminal
playbooks login --email steve@apple.com --password ********

4. Run your first commands#

Once authenticated, these are a few good first commands:

Terminal
playbooks account
playbooks config
playbooks plays --query next

Use playbooks account to confirm the active account, playbooks config to inspect the active config, and playbooks plays to start browsing marketplace content.

For the full command tree, continue to Commands and Examples.