Global Options

The Playbooks CLI comes with a series of global options that can be appended to the global or an individual command.


Usage

Here are a couple of common usage patterns:

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

Types

The Playbooks CLI expects the following types for each option:

Option
Type
Description
--configstringPath to a custom playbooks config file location.
--helpbooleanDisplay help menu for an individual command.
--versionbooleanDisplay the current package version.

2024 © Playbooks, Inc