Skip to content

You are viewing documentation for Immuta version 2021.2.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

cancel

Install and Configure the Immuta CLI

Audience: Immuta users

Content Summary: This page details how to install the Immuta CLI and tab completions.

1 - Install the Immuta CLI

macOS CLI Binary Warning

When installing the macOS CLI binary, macOS displays the warning "could not verify that this app is free from malware" when the binary is run. Navigate to the Security & Privacy section in your System Preferences to allow the binary to be run.

  1. Navigate to the Immuta Releases page and log in with your Immuta Account credentials.
  2. Scroll to the All Archives section and use the username and password displayed there to log in to the Immuta Archives site.
  3. Select the folder of the current release and download the binary zip file corresponding to your system architecture.
  4. Unzip the file and add the binary to a directory in your system's $PATH.

2 - Configure the CLI with Your Instance of Immuta

  1. Run immuta configure.
  2. Enter the URL of your Immuta instance in the interactive prompt.
  3. Enter your Immuta API Key in the interactive prompt:
$ immuta configure
? What is the url of the immuta instance you use?: https://your.instance.url.com/
? What is the api key of your immuta user account?:  ***************************Updated the config at /Users/user/.immutacfg.yaml

Below is the configuration file that will be saved at ~/.immutacfg.yaml:

default:

  api_key: <apiKey>

  host: https://your.immuta.url.com

3 - Install Tab Completions

To generate shell completion scripts for Immuta CLI commands, run immuta completion [bash|zsh|fish|powershell]. You can opt to specify -h or --help for instructions on installing tab completions for Bash, Zsh, Fish, and PowerShell commands and flags.

Use the tabs below for specific instructions for each of these shells.

Bash

  1. Install bash-completion https://github.com/scop/bash-completion.

  2. Add this to your ~/.bash_profile:

    eval "$(immuta completion bash)"

Zsh

  1. Generate an _immuta completion script and save it in your $fpath:

    immuta completion zsh > /usr/local/share/zsh/site-functions/_immuta

  2. Ensure that the following is present in your ~/.zshrc:

    autoload -U compinit
compinit -i

Fish

Generate an immuta.fish completion script:

immuta completion fish > ~/.config/fish/completions/immuta.fish

PowerShell

  1. Run immuta completion powershell | Out-String | Invoke-Expression.

  2. To load completions for every new session, run

    immuta completion powershell > immuta.ps1

  3. Source this immuta.ps1 from your PowerShell profile.

The exact configuration file locations might vary based on your system. Make sure to restart your shell before you test whether completions are working.