Command Line Interface (CLI)
The CLI is a small footprint tool that you can use on its own or with the Console to complete Oracle Cloud Infrastructure tasks. The CLI provides the same core functionality as the Console, plus additional commands. Some of these, such as the ability to run scripts, extend the Console's functionality.
This CLI and sample is dual-licensed under the Universal Permissive License 1.0 and the Apache License 2.0; third-party content is separately licensed as described in the code.
The CLI is built on Python (version 3.5 or later), running on Mac, Windows, or Linux. The Python code makes calls to Oracle Cloud Infrastructure APIs to provide the functionality implemented for the various services. These are REST APIs that use HTTPS requests and responses. For more information, see About the API.
Installation: See Quickstart.
Reference: For help with a specific command, you can enter
help <command> on the command line or view the Command Line Reference. This reference is derived from the APIs and help text in the Python source code.
To install and use the CLI, you must have:
- An Oracle Cloud Infrastructure account
- A user created in that account, in a group with a policy that grants the desired
permissions. This account user can be you, another person, or a system that calls the API. For an example of how to set up a new user, group, compartment, and
policy, see Adding Users. For a list
of other typical Oracle Cloud Infrastructure policies, see Common Policies.
- A keypair used for signing API requests, with the public key uploaded to Oracle.
Only the user calling the API should possess the private key. See Configuring the CLI.
To use the CLI without a keypair, you can use token-based authentication. For more information, see Token-based Authentication for the CLI.
Python version 3.5 or later, running on Mac, Windows, or Linux. Note that if you use the CLI Installer and do not have Python on your machine, the Installer offers to automatically install Python for you. If you already have Python installed on your machine, you can use the
python --version command to find out which version is installed.
Python 2 support ended on December 31, 2019. Versions of the OCI CLI released after January 2020 will not be compatible with Python 2. To avoid interruption at that time, please install the OCI CLI in a compatible Python 3 environment.
If you require FIPS-compliance, see Using FIPS-validated Libraries.
- Analytics Cloud
- API Gateway
- Application Migration
- Autoscaling (Compute)
- Big Data
- Container Engine for Kubernetes
- Content and Experience
- Core Services (Networking, Compute, Block Volume)
- Data Catalog
- Data Flow
- Data Science
- Data Transfer
- Digital Assistant
- Email Delivery
- File Storage
- Health Checks
- Key Management (for the Vault service)
- Load Balancing
- Oracle NoSQL Database Cloud
- Object Storage
- OS Management
- Resource Manager
- Secret Management (for the Vault service)
- Secret Retrieval (for the Vault service)
- Web Application Acceleration and Security
- Work Requests (Compute, Database)
Got a fix for a bug or a new feature you'd like to contribute? The SDK is open source and accepting pull requests on GitHub.
To be notified when a new version of the CLI is released, subscribe to the Atom feed.
Questions or Feedback