> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runcomfy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Install

The runcomfy CLI is a single statically-linked Rust binary. Pick whichever install matches your environment.

***

## Option 1: npx (no install)

For a one-off run or to try the CLI before committing to an install:

```bash theme={null}
npx -y @runcomfy/cli --version
npx -y @runcomfy/cli run openai/gpt-image-2/text-to-image \
  --input '{"prompt": "test"}'
```

`npx` downloads `@runcomfy/cli`, runs its `postinstall` hook (which fetches the per-platform binary from GitHub Releases), and invokes it. Subsequent `npx` runs reuse the cached package. No `PATH` changes, no admin privileges.

***

## Option 2: npm global

```bash theme={null}
npm install -g @runcomfy/cli
runcomfy --version
```

Same package as `npx`, but `runcomfy` is on your `PATH` permanently. Update with `npm i -g @runcomfy/cli@latest`.

***

## Option 3: curl install script

For developers who don't want Node on the install path, or for quick provisioning into containers / VMs:

```bash theme={null}
curl -fsSL https://runcomfy.com/install.sh | sh
```

The script:

* Detects your OS and CPU architecture
* Downloads the matching binary from the [latest GitHub Release](https://github.com/runcomfy-com/runcomfy-cli/releases)
* Verifies the SHA-256 checksum
* Installs to `~/.local/bin/runcomfy` (or `/usr/local/bin/runcomfy` if you have write access)
* Adds the install dir to your PATH if needed (with a one-line printed instruction)

To install a specific version:

```bash theme={null}
curl -fsSL https://runcomfy.com/install.sh | RUNCOMFY_VERSION=v0.1.0 sh
```

***

## Option 4: Build from source

```bash theme={null}
git clone https://github.com/runcomfy-com/runcomfy-cli
cd runcomfy-cli
cargo build --release
./target/release/runcomfy --version
```

Requires Rust 1.75+ (`rustup install stable`).

***

## Supported platforms

| OS      | Architecture        | npm | curl install.sh | Notes                                                               |
| ------- | ------------------- | --- | --------------- | ------------------------------------------------------------------- |
| macOS   | Apple Silicon (M1+) | ✅   | ✅               |                                                                     |
| macOS   | Intel               | ✅   | ✅               |                                                                     |
| Linux   | x86\_64 (glibc)     | ✅   | ✅               | Works on Ubuntu, Debian, Fedora, RHEL, Alpine via `apk add gcompat` |
| Linux   | ARM64 (aarch64)     | ✅   | ✅               | Raspberry Pi 4 / 5, ARM cloud VMs                                   |
| Windows | x86\_64             | —   | —               | Use WSL2 for now                                                    |

***

## Shell completion

After install, generate a completion script for your shell:

```bash theme={null}
runcomfy completion bash > /usr/local/etc/bash_completion.d/runcomfy   # bash
runcomfy completion zsh  > "${fpath[1]}/_runcomfy"                      # zsh
runcomfy completion fish > ~/.config/fish/completions/runcomfy.fish     # fish
```

Re-source your shell rc file (or open a new terminal) to pick it up. `runcomfy <Tab>` will then list subcommands; `runcomfy run <Tab>` will offer flags.

***

## Verify the install

```bash theme={null}
runcomfy --version
# runcomfy 0.1.1 (16cc8b8, 2026-04-29)
```

The output includes the git short SHA and commit date so you can pin a specific build.