cli

README

CLI for Instill Core

inst is a command line tool for **Instill Core.

Prerequisites

• macOS or Linux - inst works on macOS or Linux, but does not support Windows yet.

Installation

inst is available via Homebrew and as a downloadable binary from the releases page.

To install:

brew install instill-ai/tap/inst

To uninstall:

brew uninstall inst

To upgrade:

brew upgrade inst

Usage examples

# Check all available commands
inst help

# Deploy a local Instill Core
inst local deploy

# Undeploy a local Instill Core
inst local undeploy

# Authorization for an instance (default to managed Instill Core https://api.instill-ai.com)
inst auth login

# REST API request
inst api vdp/alpha1/pipelines

Documentation

📔 Documentation

Please check out the documentation website.

📘 API Reference

The gRPC protocols in protobufs provide the single source of truth for the VDP APIs. The genuine protobuf documentation can be found in our Buf Scheme Registry (BSR).

For the OpenAPI documentation, access http://localhost:3001 after make all, or simply run make doc.

Contributing

Please refer to the Contributing Guidelines for more details.

Community support

Please refer to the community repository.

License

See the LICENSE file for licensing information.