Skip to content

You are viewing documentation for Immuta version 2023.1.

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

cancel

The Immuta CLI

Audience: Immuta users

Content Summary: The Immuta CLI allows users to interact with their Immuta instance using the command line to manage data sources, projects, policies, and purposes. This feature allows you to have all of your Immuta instance information in a Git repository and use the CLI to sync your Immuta instance with the files in your Git repository. To install the Immuta CLI, follow this installation guide.

Section Overview

You can navigate this section of documentation in two different ways: by workflow or by command.

Workflow

The navigation in the left pane is organized by major workflows you would use in Immuta. Each workflow contains relevant commands. Follow this chronological outline to find commands relevant to your workflow.

  1. Install and Configure the Immuta CLI.
  2. Manage Your Immuta Instance.
  3. Create and Manage Data Sources.
  4. Create and Manage Global Policies.
  5. Create and Manage Purposes.
  6. Create and Manage Projects.

Commands

Below is a list of major commands available in the Immuta CLI. Click a command to navigate to its corresponding page that details subcommands, options, and arguments.

  • immuta: Interact with your Immuta instance to create data sources, projects, policies, and purposes.
  • immuta api: Make an authenticated Immuta API request. This command will let you hit any endpoint in the Immuta API, including version 1 endpoints. For example, immuta api /tag will hit the v1 endpoint to list tags. This allows you to use the immuta api command instead of something like Postman or cURL to interact with the V1 API.
  • immuta clone: Clone all data sources, projects, purposes, and policies information into files.
  • immuta completion: Generate shell completion scripts.
  • immuta configure: Specify an Immuta instance url and API key to be saved to the Immuta configuration file.
  • immuta datasource: Manage data sources.
  • immuta policy: Manage Global Policies.
  • immuta project: Manage projects.
  • immuta purpose: Manage purposes.