CLI overview

The YoFix CLI (yofix) lets you deploy preview environments, run visual regression tests, manage environment variables, and read build logs from your terminal or CI, without opening the dashboard and without a git push.

npm install -g @yofix/cli
yofix login
cd your-project && yofix deploy

Every command also speaks JSON, so the same binary that you use by hand drives your CI pipeline and AI agents. See Agents, JSON and MCP.

Install

npm install -g @yofix/cli

The package name is @yofix/cli and it installs a single binary, yofix. You can install it with any package manager:

npm install -g @yofix/cli      # npm
pnpm add -g @yofix/cli         # pnpm
yarn global add @yofix/cli     # yarn

Requires Node.js 20 or newer. To run it once without installing:

npx @yofix/cli deploy

Update

Check whether a newer version is published, and upgrade with the same command you installed with:

yofix update                   # report the latest version
npm install -g @yofix/cli      # upgrade in place

yofix update --check reports only, which is useful in scripts that want to warn without printing an upgrade command.

Check the version

yofix --version                # prints the version and exits
yofix version                  # same, but supports --json

The basic flow

Most sessions look like this:

yofix login                    # authenticate (browser device flow)
cd ~/code/your-project
yofix link                     # link this directory to a YoFix project
yofix deploy                   # package and deploy a preview
yofix deploy --prod            # ship to production
yofix logs --follow            # stream the latest build

yofix link writes a small .yofix/project.json so later commands know which project you mean. The CLI walks up from your working directory to find it, the same way git finds .git, so subdirectories of a linked repo work too.

Global options

These flags work on every command. The full table, the JSON envelope, and exit codes live in Global options and output.

Flag	What it does
`--json`	Emit a machine-readable JSON envelope on stdout
`--cwd <dir>`	Run as if from a different working directory
`--team <slug>`	Override the active team for this command
`--project <slug>`	Override the linked project slug
`--token <token>`	Use this bearer token instead of stored credentials
`-y, --yes`	Skip confirmation prompts
`--no-input`	Fail instead of prompting when input is required
`--debug`	Show stack traces and verbose error context
`--host <url>`	Override the API host (default `https://app.yofix.ai`)

Getting help

yofix --help                   # top-level command list
yofix deploy --help            # flags and arguments for one command
yofix doctor                   # diagnose setup issues (Node, keychain, API)
yofix status                   # auth, linked project, API reachability

Authentication: log in, use tokens, and run in CI.
Deploy from your machine: the full deploy workflow.
Command reference: every command and flag.