Skip to content

Installation

Choose the installation method that best fits your environment. The CLI is a single binary with no runtime dependencies.

Install Methods

npm install -g @ipto/cli

Tip

The npm package bundles pre-built binaries for all major platforms, so no compilation step is required.

Homebrew

brew install ipto-ai/tap/ipto

Binary Download

Download the latest release for your platform from the GitHub Releases page.

curl -fsSL https://github.com/ipto-ai/cli/releases/latest/download/ipto-linux-amd64 \
  -o ipto
chmod +x ipto
sudo mv ipto /usr/local/bin/

curl -fsSL https://github.com/ipto-ai/cli/releases/latest/download/ipto-linux-arm64 \
  -o ipto
chmod +x ipto
sudo mv ipto /usr/local/bin/

curl -fsSL https://github.com/ipto-ai/cli/releases/latest/download/ipto-darwin-arm64 \
  -o ipto
chmod +x ipto
sudo mv ipto /usr/local/bin/

curl -fsSL https://github.com/ipto-ai/cli/releases/latest/download/ipto-darwin-amd64 \
  -o ipto
chmod +x ipto
sudo mv ipto /usr/local/bin/

Download ipto-windows-amd64.exe from the releases page and add it to your PATH.

Docker

Run the CLI without installing anything locally:

docker run --rm -it ghcr.io/ipto-ai/cli:latest --version

To use your host credentials inside the container, mount the config directory:

docker run --rm -it \
  -v ~/.ipto:/root/.ipto:ro \
  ghcr.io/ipto-ai/cli:latest datasets list

Verify Installation

ipto --version

Expected output:

ipto 0.1.0

Shell Completions

Generate tab-completion scripts for your shell:

ipto completion bash > /etc/bash_completion.d/ipto
# or for the current user only
ipto completion bash >> ~/.bashrc

ipto completion zsh > "${fpath[1]}/_ipto"

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

After installing completions, restart your shell or source the relevant file.

Updating

npm update -g @ipto/cli

brew upgrade ipto

Re-download the latest release from the releases page and replace the existing binary.

FAQ

Which platforms are supported?

The CLI ships pre-built binaries for:

OS Architectures
Linux amd64, arm64
macOS amd64 (Intel), arm64 (Apple Silicon)
Windows amd64

Other platforms can build from source using cargo install ipto-cli if Rust 1.78+ is available.

Can I use the CLI offline?

The CLI requires network access to communicate with the IPTO API. There is no offline mode, but you can inspect cached configuration files at ~/.ipto/ at any time.

How do I configure proxy support?

Set the standard HTTPS_PROXY (or https_proxy) environment variable before running any command:

export HTTPS_PROXY=http://proxy.corp.example:8080
ipto datasets list

The CLI respects HTTPS_PROXY, HTTP_PROXY, and NO_PROXY.

How do I uninstall the CLI?

Remove the CLI using the same method you used to install it:

Method Uninstall command
npm npm uninstall -g @ipto/cli
Homebrew brew uninstall ipto
Binary sudo rm /usr/local/bin/ipto
Docker docker rmi ghcr.io/ipto-ai/cli:latest

Optionally, remove the config directory:

rm -rf ~/.ipto