# horizon-cloud-service-cli
[](https://github.com/vmware-labs/compliance-dashboard-for-kubernetes/blob/main/LICENSE)
- [horizon-cloud-service-cli](#horizon-cloud-service-cli)
- [Overview](#overview)
- [Try it out](#try-it-out)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Mac \& Linux](#mac--linux)
- [Windows](#windows)
- [Use the CLI](#use-the-cli)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
## Overview
Command line toolbox for [VMware Horizon Cloud Service (HCS) Next-Gen](https://www.vmware.com/products/horizon-cloud.html). It provides human-friendly operations based on HCS REST API.
## Try it out
### Prerequisites
* Python 3.10+
* Pip3
Refer to [Setup Prerequisites](doc/dev-setup.md#setup-prerequisites) for more details.
### Installation
#### Mac & Linux
Install the tool
```
brew install python3
pip3 install hcs-cli
```
#### Windows
Install the tool.
```
pip install hcs-cli
```
If you have python installed with option "Add python to path", it should be fine. Otherwise, you need to add python and it's Script directory to path.
#### Use the CLI
Use with default public HCS service.
```
hcs login
```
Run a command, for example, list templates:
```
hcs admin template list
```
## Documentation
* [HCS CLI - User Guide](doc/hcs-cli-user-guide.md)
* [HCS CLI - Cheatsheet](doc/hcs-cli-cheatsheet.md)
* [HCS CLI - Dev Guide](doc/hcs-cli-dev-guide.md)
* [HCS Plan - template engine for HCS](doc/hcs-plan.md)
* [Context Programming](https://github.com/nanw1103/context-programming)
## Contributing
The horizon-cloud-service-cli project team welcomes contributions from the community. Before you start working with horizon-cloud-service-cli, please read and sign our Contributor License Agreement [CLA](https://cla.vmware.com/cla/1/preview). If you wish to contribute code and you have not signed our CLA, our bot will prompt you to do so when you open a Pull Request. For any questions about the CLA process, please refer to our [FAQ]([https://cla.vmware.com/faq](https://cla.vmware.com/faq)).
## License
Apache 2.0
Raw data
{
"_id": null,
"home_page": null,
"name": "hcs-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Horizon, Horizon Cloud, Horizon Cloud Service, CLI",
"author": null,
"author_email": "Nanw1103 <nanw1103@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/aa/e0/7e1845b5f72778d50743142e9523461167c5426e27eac4cf34f876c0cd08/hcs_cli-0.1.212.tar.gz",
"platform": null,
"description": "# horizon-cloud-service-cli\n\n[](https://github.com/vmware-labs/compliance-dashboard-for-kubernetes/blob/main/LICENSE)\n\n- [horizon-cloud-service-cli](#horizon-cloud-service-cli)\n - [Overview](#overview)\n - [Try it out](#try-it-out)\n - [Prerequisites](#prerequisites)\n - [Installation](#installation)\n - [Mac \\& Linux](#mac--linux)\n - [Windows](#windows)\n - [Use the CLI](#use-the-cli)\n - [Documentation](#documentation)\n - [Contributing](#contributing)\n - [License](#license)\n\n\n## Overview\nCommand line toolbox for [VMware Horizon Cloud Service (HCS) Next-Gen](https://www.vmware.com/products/horizon-cloud.html). It provides human-friendly operations based on HCS REST API.\n\n## Try it out\n\n\n### Prerequisites\n* Python 3.10+\n* Pip3\n\nRefer to [Setup Prerequisites](doc/dev-setup.md#setup-prerequisites) for more details.\n\n### Installation\n\n#### Mac & Linux\n\nInstall the tool\n```\nbrew install python3\npip3 install hcs-cli\n```\n\n#### Windows\nInstall the tool.\n```\npip install hcs-cli\n```\nIf you have python installed with option \"Add python to path\", it should be fine. Otherwise, you need to add python and it's Script directory to path.\n\n#### Use the CLI\nUse with default public HCS service. \n```\nhcs login\n```\nRun a command, for example, list templates:\n```\nhcs admin template list\n```\n\n## Documentation\n* [HCS CLI - User Guide](doc/hcs-cli-user-guide.md)\n* [HCS CLI - Cheatsheet](doc/hcs-cli-cheatsheet.md)\n* [HCS CLI - Dev Guide](doc/hcs-cli-dev-guide.md)\n* [HCS Plan - template engine for HCS](doc/hcs-plan.md)\n* [Context Programming](https://github.com/nanw1103/context-programming)\n\n \n## Contributing\n\nThe horizon-cloud-service-cli project team welcomes contributions from the community. Before you start working with horizon-cloud-service-cli, please read and sign our Contributor License Agreement [CLA](https://cla.vmware.com/cla/1/preview). If you wish to contribute code and you have not signed our CLA, our bot will prompt you to do so when you open a Pull Request. For any questions about the CLA process, please refer to our [FAQ]([https://cla.vmware.com/faq](https://cla.vmware.com/faq)).\n\n## License\n\nApache 2.0\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Horizon Cloud Service CLI module.",
"version": "0.1.212",
"project_urls": {
"Bug Tracker": "https://github.com/vmware/horizon-cloud-service-cli/issues",
"Homepage": "https://github.com/vmware/horizon-cloud-service-cli",
"changelog": "https://github.com/vmware/horizon-cloud-service-cli/blob/main/CHANGELOG.md",
"documentation": "https://readthedocs.org",
"repository": "https://github.com/vmware/horizon-cloud-service-cli"
},
"split_keywords": [
"horizon",
" horizon cloud",
" horizon cloud service",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "133c931234d9b95e360dc84c94c49bfa0c21765d0a3de9d1b0d5948a94660da0",
"md5": "db6751cd4cdbad8b0ddaa640775cd547",
"sha256": "27d59e3845f44fdd09678ade441c53fceaab55e50f46a9d765d5ee15e3e4c084"
},
"downloads": -1,
"filename": "hcs_cli-0.1.212-py3-none-any.whl",
"has_sig": false,
"md5_digest": "db6751cd4cdbad8b0ddaa640775cd547",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 252779,
"upload_time": "2024-04-26T16:00:38",
"upload_time_iso_8601": "2024-04-26T16:00:38.009614Z",
"url": "https://files.pythonhosted.org/packages/13/3c/931234d9b95e360dc84c94c49bfa0c21765d0a3de9d1b0d5948a94660da0/hcs_cli-0.1.212-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aae07e1845b5f72778d50743142e9523461167c5426e27eac4cf34f876c0cd08",
"md5": "8dd0a4a9197356f42eeefb2558cec51b",
"sha256": "a051d69dcb97aac07bb468762ae5a3d169636d49da0937b4f1228ce2b21e75d0"
},
"downloads": -1,
"filename": "hcs_cli-0.1.212.tar.gz",
"has_sig": false,
"md5_digest": "8dd0a4a9197356f42eeefb2558cec51b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 71163,
"upload_time": "2024-04-26T16:00:39",
"upload_time_iso_8601": "2024-04-26T16:00:39.974811Z",
"url": "https://files.pythonhosted.org/packages/aa/e0/7e1845b5f72778d50743142e9523461167c5426e27eac4cf34f876c0cd08/hcs_cli-0.1.212.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 16:00:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vmware",
"github_project": "horizon-cloud-service-cli",
"github_not_found": true,
"lcname": "hcs-cli"
}
JSON
