This package provides a unified command line interface to the Cloudera Data Platform (CDP) control plane API.

• Python 2.7 or higher (3.5 or higher recommended)

Note: Starting in January 2021, Python 3.5 or higher will be required.

To install using pip from the cdpcli PyPI project:

$ pip install cdpcli

To install from source:

$ git clone git@github.com:cloudera/cdpcli.git
$ cd cdpcli
$ pip install .

API calls through the CDP CLI require a key pair issued from the CDP control plane. Use the CDP console to generate keys, following documented instructions. Then, run cdp configure to provide the credentials to the CLI.

$ cdp configure
CDP Access Key ID [None]: xxx
CDP Private Key [None]: yyy

Credentials are stored under the "default" profile in $HOME/.cdp/credentials, using the ini file format.

If you need to access the API as more than one user, set up a named profile for each user. Each profile stores a separate set of credentials.

$ cdp configure --profile my-other-user

Basic syntax:

cdp [options] <command> <subcommand> [parameters]

Examples:

$ cdp iam get-user
$ cdp environments describe-environments --environment-name myenv1

For general help, use any of these commands.

$ cdp help
$ cdp --help
$ cdp # no arguments

Most CLI commands correspond to API services. Subcommands correspond to operations in services.

• For help on any command, run its help subcommand, or pass the --help parameter.
• For help on any subcommand, pass the help or --help parameter.

The same help content is available in online API documentation.

By default, the CLI uses credentials in the "default" profile. Use a different profile by passing the --profile option.

$ cdp --profile my-other-user iam get-user

The CDP CLI is licensed under the Apache License, Version 2.0 with a supplemental license disclaimer.