Getting Started

Installation

Install CliFi on macOS, Linux, or Windows. Choose the method that works best for your environment.

npm (recommended)

The fastest way to get CliFi on any platform with Node.js 18 or later:

npm install -g clifi

Verify the installation:

clifi --version
# clifi 2.4.1

Homebrew (macOS and Linux)

If you use Homebrew, install from the official tap:

brew tap clifi/tap
brew install clifi

To upgrade:

brew upgrade clifi

curl installer

For CI environments or machines without a package manager:

curl -fsSL https://install.clifi.dev | sh

The installer detects your platform, downloads the appropriate binary, and places it in /usr/local/bin or ~/.local/bin depending on your permissions.

Binary downloads

Pre-built binaries are available for every release on the GitHub releases page. Download the archive for your platform, extract it, and place the binary somewhere on your PATH.

Docker

Run CliFi in a container without installing locally:

docker run --rm -v "$(pwd):/workspace" -w /workspace ghcr.io/clifi/clifi:latest run deploy

Shell completion

Enable tab completion for your shell:

# Bash
clifi completion bash > /usr/local/etc/bash_completion.d/clifi

# Zsh
clifi completion zsh > "${fpath[1]}/_clifi"

# Fish
clifi completion fish > ~/.config/fish/completions/clifi.fish

Verify your installation

After installation, run the built-in health check to confirm everything is set up correctly:

clifi doctor
# Checking dependencies...
# Node.js: 20.11.1
# Git: 2.43.0
# Docker: 25.1.1
# All checks passed.