Command Line Interface (CLI)

The Command Line Interface (CLI) provides a way to interact with Chameleon resources using shell and scripting tools. Chameleon uses the OpenStack Client to provide CLI functionality. This documentation section provides an overview on how to install the client and configure your shell environment to access Chameleon features.

Which authentication method should I use? We recommend ccauth for most users: it authenticates via a browser-based device flow and can generate credentials for multiple projects and sites at once, so you don’t need to manually download and manage separate credential files. If you’re working with a single project and site and want a tool with nothing to install, cc-login is a lighter-weight option preinstalled on CC-* images. The password and application credential methods still work but require manually creating and downloading credential files for each project — only reach for them if neither ccauth nor cc-login fits your workflow.

Looking to script or orchestrate experiments in Python instead of shell? python-chi is Chameleon’s Python library and offers a programmatic alternative to the CLI — see our Jupyter and python-chi guide for an introduction.

Attention

Some of the Chameleon features are only accessible via the CLI, such as power monitoring tools and the advanced networking features.

Chameleon Cloud is primarily designed to support Unix-like environments. Therefore, it is highly recommended using CLI in a Unix-like system. For Windows 10 users, you may want to enable Windows Subsystem for Linux to get better experience with the Chameleon CLI.