https://github.com/cloud-native-toolkit/itzcli
Go Implementation of an IBM Technology Zone (https://techzone.ibm.com) CLI
https://github.com/cloud-native-toolkit/itzcli
Last synced: 4 months ago
JSON representation
Go Implementation of an IBM Technology Zone (https://techzone.ibm.com) CLI
- Host: GitHub
- URL: https://github.com/cloud-native-toolkit/itzcli
- Owner: cloud-native-toolkit
- License: mit
- Created: 2022-12-10T21:49:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-07T15:36:26.000Z (over 2 years ago)
- Last Synced: 2025-06-22T03:02:56.783Z (12 months ago)
- Language: Go
- Homepage:
- Size: 1.17 MB
- Stars: 4
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# IBM Technology Zone Command Line Interface (itz)
 
The `itz` command line interface is a command line interface that provides CLI access to IBM Technology Zone.
## Introduction
Using `itz`, you can:
* List your existing reservations and get their status.
* List the available pipelines that you can install in a Red Hat OpenShift cluster
that you reserved in TechZone.
* Install or deploy products outside of TechZone using infrastructure as code in your
own OpenShift cluster.
## Quickstart
See the [QUICKSTART](QUICKSTART.md).
For usage documentation, see the documentation in the [docs](docs/itz.md) folder.
## Installing `itz`
Release packages for your OS can be found at https://github.com/cloud-native-toolkit/itzcli/releases.
### Installing on Linux
To install `itz` on Linux, use the _install.sh_ script as shown here:
```bash
$ curl https://raw.githubusercontent.com/cloud-native-toolkit/itzcli/main/scripts/install.sh | bash -
```
Verify the installation by using the `itz version` command to view the current
version.
By default, the script installs `itz` in `/usr/local/bin`. If you would like this to be in
a different location, you can set the `ITZ_INSTALL_HOME` environment variable, like
this:
```bash
$ export ITZ_INSTALL_HOME=~/bin
$ curl https://raw.githubusercontent.com/cloud-native-toolkit/itzcli/main/scripts/install.sh | bash -
```
### Installing on Mac
> **_Note: if you have version 1.24 and installed itz with `brew`, you must
> use brew to uninstall itz and then re-install it._**
#### If you have itz already installed
If you have itz already installed and `itz version` outputs _1.24_ (or a lower
version), you must follow these steps first:
1. Use brew to uninstall the existing itz.
```bash
brew uninstall itz
```
1. Untap the existing repository.
```bash
brew untap cloud-native-toolkit/techzone
```
Once you have uninstalled itz, you can proceed to
"[Installing itz using brew](#installing-itz-using-brew)".
#### Installing itz using brew
To install `itz` using [Homebrew](), follow these steps:
1. Tap the cask.
```bash
brew tap cloud-native-toolkit/homebrew-techzone
```
2. Install ITZ with brew.
```bash
brew install itz
```
### Signing on to IBM Technology Zone
Version v0.1.245 and higher of `itz` supports IBM's Single Sign On (SSO) to
authenticate against the TechZone APIs. To log in, type the following:
```bash
$ itz login
```
This command will automatically open a browser. You can log into IBM Verify with
your IBM ID. When you are done, you can close the browser window.
#### Signing on without a browser
For headless VMs or scripts, the `itz login` command also supports authentication
using the token stored in a file. Log in at https://techzone.ibm.com and view your
profile using the **My profile** page. Copy the value from the **API token** field
and store the value in a file (e.g., `~/token.txt`). Then use the command as
shown to store the value:
```bash
$ itz login --from-file ~/token.txt
```