Oracle Cloud Infrastructure CLI
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
About
=====
This is the command line interface for Oracle Cloud Infrastructure.
The project is open source and maintained by Oracle Corp. The home page for the project is `here`__.
__ https://docs.cloud.oracle.com/Content/API/Concepts/cliconcepts.htm
Announcements
=============
Interactive Features
--------------------
OCI CLI offers interactive features to guide you through command usage.
Enabling them allows:
* Suggestions and autocompletion to help compose commands;
* Color-coded suggestions to distinguish required parameters from optional parameters; and
* Quick references display alongside suggestions to recognize command and parameter purposes.
Try the interactive features anytime with the ``-i`` option:
::
oci -i
.. image:: https://github.com/oracle/oci-cli/blob/master/images/animation.png?raw=true
:width: 1000
:alt: Alternative text
Read more on `OCI Documentation`__.
__ https://docs.oracle.com/iaas/Content/API/SDKDocs/cliusing_topic-Using_Interactive_Mode.htm
Container Image
---------------
OCI CLI is now available as container images.
With a standards-compliant container runtime engine, pull and run the latest version of oci-cli from the GitHub Container Registry.
Read about setup requirements and instructions on `Working with the OCI CLI Container Image`__.
Find previous image versions on `our package page`__.
__ https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/clicontainer.htm
__ https://github.com/oracle/docker-images/pkgs/container/oci-cli
Installation
============
Mac OS X
--------
::
brew install oci-cli
`OCI Command Line Interface Installation and Configuration on Mac Instance <https://www.youtube.com/watch?v=0k2Lj0oMDK4&list=PLKCk3OyNwIzuA-dqI5vkhZVIc_cxHCkp5&index=22>`_
Linux
-----
::
bash -c "$(curl -L https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.sh)"
`OCI Command Line Interface Installation and Configuration on Linux Instance <https://www.youtube.com/watch?v=bY3jQMMHxdw&list=PLKCk3OyNwIzuA-dqI5vkhZVIc_cxHCkp5&index=20>`_
Oracle Linux 7
--------------
::
sudo yum install python36-oci-cli
Fedora Linux
------------
::
sudo dnf install oci-cli
Windows
-------
::
powershell -NoProfile -ExecutionPolicy Bypass -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1'))"
`OCI Command Line Interface Installation and Configuration on Windows Instance <https://www.youtube.com/watch?v=rEHwcJdRf8M&list=PLKCk3OyNwIzuA-dqI5vkhZVIc_cxHCkp5&index=21>`_
See the `installation guide`__ for detailed installation instructions, options and troubleshooting.
__ https://docs.cloud.oracle.com/Content/API/SDKDocs/cliinstall.htm
Offline Installation
--------------------
1. Go to the `CLI releases page`__ and locate the required CLI version.
2. For the release, go to the "Assets" area.
3. Download and copy the zip file for your Operating System to the environment where you want to install CLI.
4. Unzip the file and execute the following from inside the unzipped folder
On Linux:
::
bash install.sh --offline-install
On Windows:
::
install.ps1 -OfflineInstall
`OCI Command Line Interface (CLI) Installation on an Offline Linux Instance <https://www.youtube.com/watch?v=sWDFAOSxqHU&list=PLKCk3OyNwIzuA-dqI5vkhZVIc_cxHCkp5&index=28&t=1s>`_
`OCI Command Line Interface (CLI) Installation on an Offline Windows Instance <https://www.youtube.com/watch?v=3QtjZ0T58oc&list=PLKCk3OyNwIzuA-dqI5vkhZVIc_cxHCkp5&index=31&t=306s>`_
__ https://github.com/oracle/oci-cli/releases
Usage
=====
To get help with the command line:
::
oci --help
or
::
oci -h
To enable interactive features for usage guidance:
::
oci -i
Examples
========
Examples can be found here__ under the section 'Example Commands'.
__ https://docs.cloud.oracle.com/Content/API/SDKDocs/cliusing.htm
Documentation
=============
Detailed documentation for CLI prerequisites, installation and configuration, and troubleshooting can be found here__.
__ https://docs.cloud.oracle.com/Content/API/Concepts/cliconcepts.htm
Help
====
See the “Questions or Feedback?” section here__.
__ https://docs.cloud.oracle.com/Content/API/SDKDocs/clitroubleshooting.htm
Changes
=======
See CHANGELOG__.
__ https://github.com/oracle/oci-cli/blob/master/CHANGELOG.rst
Contributing
============
oci-cli is an open source project. See CONTRIBUTING__ for details.
Oracle gratefully acknowledges the contributions to oci-cli that have been made by the community.
__ https://github.com/oracle/oci-cli/blob/master/CONTRIBUTING.md
Known Issues
============
You can find information on any known issues with the CLI here__, here__ and under the “Issues__” tab of this project's `GitHub repository`__.
__ https://docs.cloud.oracle.com/Content/knownissues.htm
__ https://github.com/oracle/oci-cli/blob/master/COMMON_ISSUES.rst
__ https://github.com/oracle/oci-cli/issues
__ https://github.com/oracle/oci-cli
License
=======
Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
This SDK and sample is dual licensed under the Universal Permissive License 1.0 and the Apache License 2.0.
See LICENSE__ for more details.
__ https://github.com/oracle/oci-cli/blob/master/LICENSE.txt
Raw data
{
"_id": null,
"home_page": "https://docs.cloud.oracle.com/iaas/Content/API/Concepts/cliconcepts.htm",
"name": "oci-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Oracle",
"author_email": "joe.levy@oracle.com",
"download_url": "https://files.pythonhosted.org/packages/b2/be/1deaffc9dced917f1d3b7963aae11567a90c4f4f4e4eb2c945fb14a14bef/oci-cli-3.50.2.tar.gz",
"platform": null,
"description": "Oracle Cloud Infrastructure CLI\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAbout\n=====\nThis is the command line interface for Oracle Cloud Infrastructure.\n\nThe project is open source and maintained by Oracle Corp. The home page for the project is `here`__.\n\n__ https://docs.cloud.oracle.com/Content/API/Concepts/cliconcepts.htm\n\nAnnouncements\n=============\n\nInteractive Features\n--------------------\nOCI CLI offers interactive features to guide you through command usage.\n\nEnabling them allows:\n * Suggestions and autocompletion to help compose commands;\n * Color-coded suggestions to distinguish required parameters from optional parameters; and\n * Quick references display alongside suggestions to recognize command and parameter purposes.\n\nTry the interactive features anytime with the ``-i`` option:\n::\n\n oci -i\n\n.. image:: https://github.com/oracle/oci-cli/blob/master/images/animation.png?raw=true\n :width: 1000\n :alt: Alternative text\n\nRead more on `OCI Documentation`__.\n\n__ https://docs.oracle.com/iaas/Content/API/SDKDocs/cliusing_topic-Using_Interactive_Mode.htm\n\nContainer Image\n---------------\nOCI CLI is now available as container images.\n\nWith a standards-compliant container runtime engine, pull and run the latest version of oci-cli from the GitHub Container Registry.\n\nRead about setup requirements and instructions on `Working with the OCI CLI Container Image`__.\n\nFind previous image versions on `our package page`__.\n\n__ https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/clicontainer.htm\n\n__ https://github.com/oracle/docker-images/pkgs/container/oci-cli\n\n\nInstallation\n============\n\nMac OS X\n--------\n::\n\n brew install oci-cli\n\n`OCI Command Line Interface Installation and Configuration on Mac Instance <https://www.youtube.com/watch?v=0k2Lj0oMDK4&list=PLKCk3OyNwIzuA-dqI5vkhZVIc_cxHCkp5&index=22>`_\n\nLinux\n-----\n::\n\n bash -c \"$(curl -L https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.sh)\"\n\n`OCI Command Line Interface Installation and Configuration on Linux Instance <https://www.youtube.com/watch?v=bY3jQMMHxdw&list=PLKCk3OyNwIzuA-dqI5vkhZVIc_cxHCkp5&index=20>`_\n\nOracle Linux 7\n--------------\n::\n\n sudo yum install python36-oci-cli\n\n\nFedora Linux\n------------\n::\n\n sudo dnf install oci-cli\n\nWindows\n-------\n::\n\n powershell -NoProfile -ExecutionPolicy Bypass -Command \"iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1'))\"\n\n`OCI Command Line Interface Installation and Configuration on Windows Instance <https://www.youtube.com/watch?v=rEHwcJdRf8M&list=PLKCk3OyNwIzuA-dqI5vkhZVIc_cxHCkp5&index=21>`_\n\nSee the `installation guide`__ for detailed installation instructions, options and troubleshooting.\n\n__ https://docs.cloud.oracle.com/Content/API/SDKDocs/cliinstall.htm\n\nOffline Installation\n--------------------\n1. Go to the `CLI releases page`__ and locate the required CLI version.\n\n2. For the release, go to the \"Assets\" area.\n\n3. Download and copy the zip file for your Operating System to the environment where you want to install CLI.\n\n4. Unzip the file and execute the following from inside the unzipped folder\n\n On Linux:\n ::\n\n bash install.sh --offline-install\n\n On Windows:\n ::\n\n install.ps1 -OfflineInstall\n\n`OCI Command Line Interface (CLI) Installation on an Offline Linux Instance <https://www.youtube.com/watch?v=sWDFAOSxqHU&list=PLKCk3OyNwIzuA-dqI5vkhZVIc_cxHCkp5&index=28&t=1s>`_\n\n`OCI Command Line Interface (CLI) Installation on an Offline Windows Instance <https://www.youtube.com/watch?v=3QtjZ0T58oc&list=PLKCk3OyNwIzuA-dqI5vkhZVIc_cxHCkp5&index=31&t=306s>`_\n\n__ https://github.com/oracle/oci-cli/releases\n\nUsage\n=====\nTo get help with the command line:\n::\n\n oci --help\n\nor\n\n::\n\n oci -h\n\nTo enable interactive features for usage guidance:\n::\n\n oci -i\n\n\nExamples\n========\nExamples can be found here__ under the section 'Example Commands'.\n\n__ https://docs.cloud.oracle.com/Content/API/SDKDocs/cliusing.htm\n\n\nDocumentation\n=============\n\nDetailed documentation for CLI prerequisites, installation and configuration, and troubleshooting can be found here__.\n\n__ https://docs.cloud.oracle.com/Content/API/Concepts/cliconcepts.htm\n\n\nHelp\n====\nSee the \u201cQuestions or Feedback?\u201d section here__.\n\n__ https://docs.cloud.oracle.com/Content/API/SDKDocs/clitroubleshooting.htm\n\n\nChanges\n=======\nSee CHANGELOG__.\n\n__ https://github.com/oracle/oci-cli/blob/master/CHANGELOG.rst\n\n\nContributing\n============\noci-cli is an open source project. See CONTRIBUTING__ for details.\n\nOracle gratefully acknowledges the contributions to oci-cli that have been made by the community.\n\n__ https://github.com/oracle/oci-cli/blob/master/CONTRIBUTING.md\n\n\nKnown Issues\n============\nYou can find information on any known issues with the CLI here__, here__ and under the \u201cIssues__\u201d tab of this project's `GitHub repository`__.\n\n__ https://docs.cloud.oracle.com/Content/knownissues.htm\n__ https://github.com/oracle/oci-cli/blob/master/COMMON_ISSUES.rst\n__ https://github.com/oracle/oci-cli/issues\n__ https://github.com/oracle/oci-cli\n\n\nLicense\n=======\nCopyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.\n\nThis SDK and sample is dual licensed under the Universal Permissive License 1.0 and the Apache License 2.0.\n\nSee LICENSE__ for more details.\n\n__ https://github.com/oracle/oci-cli/blob/master/LICENSE.txt\n\n\n",
"bugtrack_url": null,
"license": "Universal Permissive License 1.0 or Apache License 2.0",
"summary": "Oracle Cloud Infrastructure CLI",
"version": "3.50.2",
"project_urls": {
"Homepage": "https://docs.cloud.oracle.com/iaas/Content/API/Concepts/cliconcepts.htm"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "79e9d1e5e9f2c5d9681a43e4a24a38e574038f21616655c64f4f103077676ce9",
"md5": "c2ae49819a39a2898d61f4ffe73e8926",
"sha256": "36a6eb89d6d2c12cfe1152bc348ddf52bad2495030e3e30d8807d616a75ee92b"
},
"downloads": -1,
"filename": "oci_cli-3.50.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c2ae49819a39a2898d61f4ffe73e8926",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 52224153,
"upload_time": "2024-11-19T04:50:28",
"upload_time_iso_8601": "2024-11-19T04:50:28.222881Z",
"url": "https://files.pythonhosted.org/packages/79/e9/d1e5e9f2c5d9681a43e4a24a38e574038f21616655c64f4f103077676ce9/oci_cli-3.50.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b2be1deaffc9dced917f1d3b7963aae11567a90c4f4f4e4eb2c945fb14a14bef",
"md5": "c28917e83ab847833673fafda67a6bc3",
"sha256": "1bfa0736beb5295afd838394a9cf04eb508c9c7e66b48dcf7eb80b848c861df0"
},
"downloads": -1,
"filename": "oci-cli-3.50.2.tar.gz",
"has_sig": false,
"md5_digest": "c28917e83ab847833673fafda67a6bc3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 18200762,
"upload_time": "2024-11-19T04:50:39",
"upload_time_iso_8601": "2024-11-19T04:50:39.776494Z",
"url": "https://files.pythonhosted.org/packages/b2/be/1deaffc9dced917f1d3b7963aae11567a90c4f4f4e4eb2c945fb14a14bef/oci-cli-3.50.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 04:50:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "oci-cli"
}
JSON