| Name | yo JSON |
| Version |
1.8.0
JSON |
| download |
| home_page | https://github.com/oracle/yo |
| Summary | A fast and simple CLI client for managing OCI instances |
| upload_time | 2024-11-22 21:03:32 |
| maintainer | None |
| docs_url | None |
| author | Oracle |
| requires_python | None |
| license | UPL |
| keywords |
oci
client
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
```bash
# 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][contributing].
## Security
Please consult the [security guide][security] 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/.
[documentation]: https://oracle.github.io/yo/
[contributing]: ./CONTRIBUTING.md
[security]: ./SECURITY.md
Raw data
{
"_id": null,
"home_page": "https://github.com/oracle/yo",
"name": "yo",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "oci client",
"author": "Oracle",
"author_email": "stephen.s.brennan@oracle.com",
"download_url": "https://files.pythonhosted.org/packages/fd/14/dd26a91ef6a61b6f79cd3b5ff976e02df5fc81fb964d004be72ff859f85f/yo-1.8.0.tar.gz",
"platform": null,
"description": "# yo - fast and simple OCI client\n\nyo is a command-line client for managing OCI instances. It makes launching OCI\ninstances as simple as rudely telling your computer \"yo, launch an instance\".\nIts goals are speed, ease of use, and simplicity. It was originally designed to\nhelp developers in the Oracle Linux team quickly launch disposable VMs for\ntesting, but is slowly gaining users outside of OL. Here are some examples of\nhow yo tries to improve on the OCI command line and browser tools:\n\n- yo hides other people's VMs from you, so you can just manage your own\n instances.\n- yo doesn't make you type any more than you need. Compartment IDs, common shape\n configurations, etc can all be stored in your config. It really can be as\n simple as `yo launch` (or, for the lazier, `yo la`).\n- yo lets you refer to your instances by name. You should never need to memorize\n an IP address again.\n- yo aggressively caches data to make operations as quick as possible.\n\n## Installation\n\nA minimum of Python 3.6 is required in order to use Yo.\n\n**Via Pip:**\n\n pip install yo oci-cli\n\nThis will install the standard OCI CLI alongside Yo, which can be useful as\nwell. After installation, you'll need to configure Yo to work with your OCI\ntenancy. Please see the [documentation][] for detailed instructions.\n\n## Documentation\n\nThe [documentation][] contains information on the configuration file, as well as\na listing of sub-commands and features offered.\n\n## Examples\n\n```bash\n# Launch an instance based on your default settings, and SSH into it\nyo launch -s\n\n# Launch a flexible instance with given shape, size, and name\nyo launch -S VM.Standard.E4.Flex --cpu 3 --mem 12 -n my-vm\n\n# SSH into my-vm\nyo ssh my-vm\n\n# Copy files to my-vm\nyo scp ./files my-vm:\n\n# Terminate my-vm\nyo terminate my-vm\n```\n\n## Help\n\nWe hope you can find all the answers to your questions in our documentation. But\nif you're still having trouble, feel free to open a Github issue and we'll try\nour best to help!\n\n## Contributing\n\nWe welcome contributions from the community. Before submitting a pull request,\nplease [review our contribution guide][contributing].\n\n## Security\n\nPlease consult the [security guide][security] for our responsible security\nvulnerability disclosure process.\n\n## License\n\nCopyright (c) 2023 Oracle and/or its affiliates.\n\nReleased under the Universal Permissive License v1.0 as shown at\nhttps://oss.oracle.com/licenses/upl/.\n\n[documentation]: https://oracle.github.io/yo/\n[contributing]: ./CONTRIBUTING.md\n[security]: ./SECURITY.md\n\n\n",
"bugtrack_url": null,
"license": "UPL",
"summary": "A fast and simple CLI client for managing OCI instances",
"version": "1.8.0",
"project_urls": {
"Homepage": "https://github.com/oracle/yo"
},
"split_keywords": [
"oci",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b34a56ccbfad3df97f405755c347ecbc614efd30980b60db766b659356e8073f",
"md5": "66273c31bc12746804d9a9003c54955d",
"sha256": "f3f910781bef1a078fda1adc0bffda12014b9f5a73d16e6121ec04b9a2705eb0"
},
"downloads": -1,
"filename": "yo-1.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "66273c31bc12746804d9a9003c54955d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 130926,
"upload_time": "2024-11-22T21:03:30",
"upload_time_iso_8601": "2024-11-22T21:03:30.812114Z",
"url": "https://files.pythonhosted.org/packages/b3/4a/56ccbfad3df97f405755c347ecbc614efd30980b60db766b659356e8073f/yo-1.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fd14dd26a91ef6a61b6f79cd3b5ff976e02df5fc81fb964d004be72ff859f85f",
"md5": "c3d0b14885c365028a0749e5fa525977",
"sha256": "64b1341c307cbd39712bba506ad719e63a3e975669dae96fba7eb180bbe63ed9"
},
"downloads": -1,
"filename": "yo-1.8.0.tar.gz",
"has_sig": false,
"md5_digest": "c3d0b14885c365028a0749e5fa525977",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 124748,
"upload_time": "2024-11-22T21:03:32",
"upload_time_iso_8601": "2024-11-22T21:03:32.779294Z",
"url": "https://files.pythonhosted.org/packages/fd/14/dd26a91ef6a61b6f79cd3b5ff976e02df5fc81fb964d004be72ff859f85f/yo-1.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 21:03:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oracle",
"github_project": "yo",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "yo"
}
