apigeecli

========== apigee-cli

⚠️ Warning: This project is no longer actively maintained and was created specifically for previous Darumatic clients.

|License| |Python version| |Downloads|

apigee-cli is a command-line interface tool designed to simplify the use of the Apigee Edge Management API. It provides a user-friendly experience with features such as SSO support.

It can be used for general administrative tasks, as a developer package, and to support automation for common development tasks such as CI/CD.

With the apigee-cli, you can manage your Apigee Edge credentials using environment variables, config files, or command-line arguments.

The tool is highly experimental and is not affiliated with Apigee or Google.

For more information on getting started with the apigee-cli or for troubleshooting help, refer to the documentation and links provided.

---

Installation

The easiest way to install apigee-cli is to use pip_ in a virtualenv::

$ pip install apigeecli

or, if you are not installing in a virtualenv, to install globally::

$ sudo pip install apigeecli

or for your user::

$ pip install --user apigeecli

If you have the apigee-cli installed and want to upgrade to the latest version you can run::

$ pip install --upgrade apigeecli

---

Getting Started

Before using apigee-cli, you need to tell it about your Apigee Edge credentials. You can do this in three ways:

• Environment variables
• Config file
• Command-line arguments

The steps below show how to use command-line arguments to configure your Apigee Edge credentials.

^^^^^^^^^^^^^^^^^^^^ Basic authentication ^^^^^^^^^^^^^^^^^^^^

::

$ apigee configure -P default -u MY_EMAIL -p MY_PASS -o MY_ORG -mfa '' -z '' --no-token --prefix ''

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Multi-factor authentication (MFA) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

::

$ apigee configure -P default -u MY_EMAIL -p MY_PASS -o MY_ORG -mfa MY_KEY -z '' --no-token --prefix ''

^^^^^^^^^^^^^^^^^^ SSO authentication ^^^^^^^^^^^^^^^^^^

::

$ apigee configure -P default -u MY_EMAIL -p none -o MY_ORG -mfa '' -z MY_ZONENAME --no-token --prefix ''

If you are not currently signed in by your identity provider, you will be prompted to sign in::

$ apigee apis list
SSO authorization page has automatically been opened in your default browser.
Follow the instructions in the browser to complete this authorization request.

If your browser did not automatically open, go to the following URL and sign in:

https://{zoneName}.login.apigee.com/passcode

then copy the Temporary Authentication Code.

Please enter the Temporary Authentication Code:

zoneName will be the Identity zone name you previously configured.

Refer to the official Apigee documentation to learn more about how to Access the Edge API with SAML_.

^^^^^^^^^^^^^^^^^^^^^^^^ Testing your credentials ^^^^^^^^^^^^^^^^^^^^^^^^

Run the following command to get a list of API proxies in your default Apigee organization::

$ apigee apis list
["helloworld", "oauth"]

---

Why does this exist?

It is intended for general administrative use from your shell, as a package for developers, and to support automation for common development tasks, such as test automation or Continuous Integration/Continuous Deployment (CI/CD).

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ When to use this over the official tool ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Apigee Corporation maintains their own fully-featured CLI_ for the Apigee Management API that can be used as an SDK to orchestrate tasks and may be more than suitable for your needs.

We built and use the Apigee CLI to implement and distribute features that allow our clients to manage CI/CD, perform self-service operations and promote our DevOps workflows which are difficult to perform using official tools.

---

Getting Help

• Apigee Product Documentation_

---

More Links

• GitHub_
• Mirror_
• Python Package Index (PyPI)_

For further questions, feel free to contact us at [e-mail].

---

Disclaimer

This is not an officially supported Google product.

.. _fully-featured CLI: https://github.com/apigee/apigeetool-node

.. |Upload Python Package badge| image:: https://github.com/mdelotavo/apigee-cli/workflows/Upload%20Python%20Package/badge.svg :target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Upload+Python+Package%22

.. |Python package badge| image:: https://github.com/mdelotavo/apigee-cli/workflows/Python%20package/badge.svg :target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Python+package%22

.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black

.. |PyPI| image:: https://img.shields.io/pypi/v/apigeecli :target: https://pypi.org/project/apigeecli/

.. |License| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg :target: https://opensource.org/licenses/Apache-2.0

.. |Python version| image:: https://img.shields.io/pypi/pyversions/apigeecli :target: https://pypi.org/project/apigeecli/

.. |PyPI Version| image:: https://badge.fury.io/py/apigeecli.svg :target: https://badge.fury.io/py/apigeecli

.. |Downloads| image:: https://pepy.tech/badge/apigeecli :target: https://pepy.tech/project/apigeecli

.. _Apigee Product Documentation: https://apidocs.apigee.com/management/apis

.. _Permissions reference: https://docs.apigee.com/api-platform/system-administration/permissions

.. _Add permissions to testing role: https://docs.apigee.com/api-platform/system-administration/managing-roles-api#addpermissionstotestingrole

.. _pip: http://www.pip-installer.org/en/latest/

.. _Universal Command Line Interface for Amazon Web Services: https://github.com/aws/aws-cli

.. _The Apigee Management API command-line interface documentation: https://darumatic.github.io/apigee-cli/index.html

.. _GitHub: https://github.com/darumatic/apigee-cli

.. _Python Package Index (PyPI): https://pypi.org/project/apigeecli/

.. _Access the Edge API with SAML: https://docs.apigee.com/api-platform/system-administration/using-saml

.. _Commands cheatsheet: https://github.com/mdelotavo/apigee-cli-docs

.. _Using SAML with automated tasks: https://github.com/mdelotavo/apigee-cli-docs

.. _Tabulating deployments: https://github.com/mdelotavo/apigee-cli-docs

.. _Tabulating resource permissions: https://github.com/mdelotavo/apigee-cli-docs

.. _Troubleshooting: https://github.com/mdelotavo/apigee-cli-docs

.. _Mirror: https://github.com/mdelotavo/apigee-cli

.. _Apigee CI/CD Docker releases: https://hub.docker.com/r/darumatic/apigee-cicd