CLI

The command inst is the official command-line tool for Instill Core.

Prerequisites

Make sure you have the prerequisites set up:

macOS or Linux - inst works on macOS or Linux, but does not support Windows at the moment.
Docker and Docker Compose - Instill Core uses Docker Compose to run all services at local. See the official instructions and the Docker resource requirements for Instill Core.

📘
CLI requires the current user to be added to the docker group or to be run as root.

Downloading CLI

inst is available via Homebrew.

brew install instill-ai/tap/inst

brew upgrade inst

Alternatively, inst is cross-platform. You can just download the CLI for your operating system from the assets of the release page:

macOS x86_64/amd64
Linux x86_64/amd64
Linux arm64/aarch64
Linux arm-v6
Windows x86_64/amd64

If you download from the above links, the steps are slightly different compared to downloading the CLI from Homebrew. After downloading CLI, you will have to make it executable. Let's take macOS as an example:

## Download **CLI** binary file from the latest release version.
## Here we use `v0.1.0-alpha` as example
wget https://github.com/instill-ai/cli/releases/download/v0.1.0-alpha/inst_Darwin_x86_64.tar.gz

## unpack the file
tar -zxvf inst_Darwin_x86_64.tar.gz

cd bin

chmod +x inst

## Run CLI
./inst

The following command will show you all available commands:

inst help

Deploying Instill Core

Once the CLI has been installed, you can deploy a local Instill Core CE instance:

inst local deploy

Once all services are up and running, the Console is ready to go at http://localhost:3000.

Undeploy Instill Core

To shut down and clean up all Instill Core CE resources, run

inst local undeploy

Here are some other example commands:

# REST API request
inst api vdp/v1beta/pipelines

Uninstall CLI

To uninstall the CLI:

brew uninstall inst