hcs-cli 0.1.82

Horizon Cloud Service CLI

horizon-cloud-service-cli

• horizon-cloud-service-cli
  • Overview
  • Try it out
    • Prerequisites
    • Installation
      • Mac & Linux
      • Windows
      • Use the CLI
  • Authentication Methods
    • Security Practice
  • Documentation
  • Contributing
  • License

Overview

Command line toolbox for VMware Horizon Cloud Service (HCS) Next-Gen. It provides human-friendly operations based on HCS REST API.

Try it out

Prerequisites

• Python 3.10+
• Pip3

Refer to Setup Prerequisites for more details.

Installation

Mac & Linux

Install the tool

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

Authentication Methods

For the first time with each profile, it needs authentication. There are three ways to authenticate:

Example	Purpose
hcs login [--org <org-id>]	Login with configured credentials, otherwise do an interactive login using browser. Note that if your CSP default org is not the target org for HCS, the --org argument must be specified for initial login.
hcs login --api-token <csp-api-token>	Login with CSP API token. Reference: Get CSP User API Token.
hcs login --client-id <client-id> --client-secret <client-secret> [--org <org-id>]	Login with OAuth client id/secret.

To get the current authentication information:

hcs login -d

Security Practice

HCS CLI stores authentication information in a conventional way. The profile and authentication state after login are stored in the current user home directory. The best practice is to use it on a single user system with admin privilege.

Documentation

• Work with development environments
• HCS CLI Cheatsheet
• HCS Plan, a resource manager for deployment
• Development Setup
• 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. 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.

License

Apache 2.0