{"id":18777346,"url":"https://github.com/cloudera/cdpcli","last_synced_at":"2025-04-13T10:31:40.863Z","repository":{"id":66864292,"uuid":"279384232","full_name":"cloudera/cdpcli","owner":"cloudera","description":"CDP command line interface (CLI)","archived":false,"fork":false,"pushed_at":"2025-03-19T23:03:48.000Z","size":1491,"stargazers_count":11,"open_issues_count":8,"forks_count":15,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-05T21:56:05.475Z","etag":null,"topics":["cdp","cloudera"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudera.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-13T18:40:55.000Z","updated_at":"2025-03-19T23:03:54.000Z","dependencies_parsed_at":"2024-01-05T22:41:15.430Z","dependency_job_id":"92f3f230-319f-423f-a50b-e7047692bc09","html_url":"https://github.com/cloudera/cdpcli","commit_stats":null,"previous_names":[],"tags_count":110,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudera%2Fcdpcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudera%2Fcdpcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudera%2Fcdpcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudera%2Fcdpcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudera","download_url":"https://codeload.github.com/cloudera/cdpcli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248698951,"owners_count":21147563,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cdp","cloudera"],"created_at":"2024-11-07T20:10:03.585Z","updated_at":"2025-04-13T10:31:39.980Z","avatar_url":"https://github.com/cloudera.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cloudera CDP Command Line Interface\n\nThis package provides a unified command line interface to the Cloudera Data\nPlatform (CDP) control plane API.\n\n## Prerequisites\n\n* Python 3.6 or higher\n\nEarlier versions of Python are no longer supported for new releases, as of\nJanuary 2021. Previous CLI releases shall continue to work under earlier Python\nversions.\n\nStarting with version 0.9.24, the requests and urllib3 libraries are no longer\nbundled with the CLI. When upgrading, watch for those new dependencies to be\ninstalled.\n\n## Installation\n\nTo install using `pip` from the\n[cdpcli PyPI project](https://pypi.org/project/cdpcli/):\n\n```\n$ pip install cdpcli\n```\n\nTo install from source:\n\n```\n$ git clone git@github.com:cloudera/cdpcli.git\n$ cd cdpcli\n$ pip install .\n```\n\n### Beta CLI\n\nAn alternative CLI exposing beta functionality is available in its own package.\n\n```\n$ pip install cdpcli-beta\n```\n\nDo not install both the regular and beta CLIs in the same Python environment,\nas they use the same entry points and therefore conflict.\n\nAny features exposed in the beta CLI that are not available in the regular CLI\nare still under development. They are not yet supported, may not work, and are\nsubject to change in incompatible ways, including removal. Do not rely on beta\nfeatures for production use.\n\n## Configuring\n\nAPI calls through the CDP CLI require a key pair issued from the CDP control\nplane. Use the CDP console to generate keys, following [documented\ninstructions](https://docs.cloudera.com/cdp/latest/cli/topics/mc-cli-generating-an-api-access-key.html).\nThen, run `cdp configure` to provide the credentials to the CLI.\n\n```\n$ cdp configure\nCDP Access Key ID [None]: xxx\nCDP Private Key [None]: yyy\n```\n\nCredentials are stored under the \"default\" profile in *$HOME/.cdp/credentials*,\nusing the ini file format.\n\n```\n[default]\ncdp_access_key_id = xxx\ncdp_private_key = yyy\n```\n\n### Profiles\n\nIf you need to access the API as more than one user, set up a named profile for\neach user. Each profile stores a separate set of credentials.\n\n```\n$ cdp configure --profile my-other-user\n```\n\nThe credentials for a profile are stored in *$HOME/.cdp/credentials* under a\nsection named for the profile.\n\n### Credential Environment Variables\n\nAn alternative to storing credentials in *$HOME/.cdp/credentials* is to pass\nthem using the environment variables `CDP_ACCESS_KEY_ID` and `CDP_PRIVATE_KEY`.\nHowever, these variables are ignored when the `--profile` option is used when\nrunning the CLI (see below).\n\n### Base Endpoint URL and Form Factor\n\nThe CLI may be used to access\n[CDP Private Cloud](https://docs.cloudera.com/cdp-private-cloud/latest/overview/topics/cdppvc-overview.html)\ncontrol planes. Contact your control plane administrator to obtain the required\nbase endpoint URL value for your installation. Set the value in\n*$HOME/.cdp/config*, another configuration file that uses the ini file format.\nCreate a section named for the profile which should work with the private cloud\ncontrol plane.\n\n```\n[profile private1]\ncdp_endpoint_url = https://cdp-private.example.com\n```\n\nThe CLI guesses whether it is using CDP Public Cloud or CDP Private Cloud based\non the base endpoint URL. If you find that it is guessing incorrectly, you can\nconfigure use of either *form factor* in *$HOME/.cdp/config*. Valid form factor\nvalues are \"public\" and \"private\".\n\n```\n[profile private1]\nform_factor = private\n```\n\n## Running\n\nBasic syntax:\n\n```\ncdp [options] \u003ccommand\u003e \u003csubcommand\u003e [parameters]\n```\n\nExamples:\n\n```\n$ cdp iam get-user\n$ cdp environments describe-environments --environment-name myenv1\n```\n\n### Help\n\nFor general help, use any of these commands.\n\n```\n$ cdp help\n$ cdp --help\n$ cdp # no arguments\n```\n\nMost CLI commands correspond to API services. Subcommands correspond to\noperations in services.\n\n* For help on any command, run its `help` subcommand, or pass the `--help` parameter.\n* For help on any subcommand, pass the `help` or `--help` parameter.\n\nThe same help content is available in online\n[API documentation](https://cloudera.github.io/cdp-dev-docs/api-docs/).\n\n### Profiles\n\nBy default, the CLI uses credentials in the \"default\" profile. Use a different\nprofile by passing the `--profile` option.\n\n```\n$ cdp --profile my-other-user iam get-user\n```\n\n### Base Endpoint URL and Form Factor\n\nBy default, the CLI works with\n[CDP Public Cloud](https://docs.cloudera.com/cdp/latest/overview/topics/cdp-overview.html)\nand calculates API endpoints accordingly. If you are using CDP Private Cloud, be\nsure to provide the base endpoint URL for your private cloud control plane. You\ncan do so by setting it in *$HOME/.cdp/config* for the desired profile, or\nthrough the `--endpoint-url` option, which supersedes the configuration.\n\n```\n$ cdp --endpoint-url https://other.cdp-private.example.com ...\n```\n\nThe CLI guesses whether it is using CDP Public Cloud or CDP Private Cloud based\non the base endpoint URL. If you find that it is guessing incorrectly, you can\nforce use of either *form factor* by either setting it in *$HOME/.cdp/config*\nfor the desired profile, or through the `--form-factor` option, which supersedes\nthe configuration. Specifying a form factor does not alter the base endpoint URL\n in use.\n\n```\n$ cdp --form-factor private ...\n```\n\n## License\n\nThe CDP CLI is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)\nwith a [supplemental license disclaimer](https://console.cdp.cloudera.com/downloads/LICENSE_SUPPLEMENTAL_DISCLAIMER.txt).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudera%2Fcdpcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudera%2Fcdpcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudera%2Fcdpcli/lists"}