Skip to main content

yo - fast and simple OCI client

yo is a command-line client for managing OCI instances. It makes launching OCI instances as simple as rudely telling your computer "yo, launch an instance". Its goals are speed, ease of use, and simplicity. It was originally designed to help developers in the Oracle Linux team quickly launch disposable VMs for testing, but is slowly gaining users outside of OL. Here are some examples of how yo tries to improve on the OCI command line and browser tools:

  • yo hides other people's VMs from you, so you can just manage your own instances.
  • yo doesn't make you type any more than you need. Compartment IDs, common shape configurations, etc can all be stored in your config. It really can be as simple as yo launch (or, for the lazier, yo la).
  • yo lets you refer to your instances by name. You should never need to memorize an IP address again.
  • yo aggressively caches data to make operations as quick as possible.

Installation

A minimum of Python 3.6 is required in order to use Yo.

Via Pip:

pip install yo oci-cli

This will install the standard OCI CLI alongside Yo, which can be useful as well. After installation, you'll need to configure Yo to work with your OCI tenancy. Please see the documentation for detailed instructions.

Documentation

The documentation contains information on the configuration file, as well as a listing of sub-commands and features offered.

Examples

# Launch an instance based on your default settings, and SSH into it
yo launch -s

# Launch a flexible instance with given shape, size, and name
yo launch -S VM.Standard.E4.Flex --cpu 3 --mem 12 -n my-vm

# SSH into my-vm
yo ssh my-vm

# Copy files to my-vm
yo scp ./files my-vm:

# Terminate my-vm
yo terminate my-vm

Help

We hope you can find all the answers to your questions in our documentation. But if you're still having trouble, feel free to open a Github issue and we'll try our best to help!

Contributing

We welcome contributions from the community. Before submitting a pull request, please review our contribution guide.

Security

Please consult the security guide for our responsible security vulnerability disclosure process.

License

Copyright (c) 2023 Oracle and/or its affiliates.

Released under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl/.

Metadata

Release files for yo 1.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for yo 1.5.1
File Size Uploaded
yo-1.5.1.tar.gz 118.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for yo 1.5.1
File Interpreter ABI Platform
yo-1.5.1-py3-none-any.whl Python 3 none any Details

Total release size: 243.6 kB

Release files / yo-1.5.1.tar.gz

Download URL yo-1.5.1.tar.gz
Size 118.8 kB
Tags Source
SHA-256 checksum
How to use checksums
05d546fcc04fd1049866782beef3adb80256dcd8290395eb73f78280bf3a8000
BLAKE2b-256 checksum
How to use checksums
993990add0662b85efb228059977511a02a12ce0023b330ee1a8fef00c1a30f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.18

Release files / yo-1.5.1-py3-none-any.whl

Download URL yo-1.5.1-py3-none-any.whl
Size 124.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b8531b50d19ec2a80609693dff666c50193c06bbac108c3c46a759c0609bb136
BLAKE2b-256 checksum
How to use checksums
ec8894bdc5cec3d3d07952994bbadf0823b62b93ffb393bf22adb9476e6dba84
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.18

Release history Release notifications | RSS feed

1.9.0

2 release files

1.8.1

2 release files

1.8.0

2 release files

1.7.3

2 release files

1.7.2

2 release files

1.7.1

2 release files

1.7.0

2 release files

1.6.0

2 release files

This release

1.5.1 This release

2 release files

1.5.0

2 release files

1.4.0

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.0.0

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page