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

# Install

> Install the Voiceflow CLI on your machine.

You can use `voiceflow-cli` by installing a pre-compiled binary (in several ways), using Docker, or compiling it from source. In the below sections, you can find the steps for each approach.

## Install a pre-compiled binary

### homebrew tap

Install the Voiceflow CLI:

```sh theme={null}
brew install xavidop/tap/voiceflow
```

### snapcraft

```sh theme={null}
sudo snap install voiceflow
```

### aur

```sh theme={null}
yay -S cxcli-bin
```

### scoop

```powershell theme={null}
scoop bucket add voiceflow https://github.com/xavidop/scoop-bucket.git
scoop install voiceflow
```

### chocolatey

```powershell theme={null}
choco install voiceflow
```

### apt

```sh theme={null}
echo 'deb [trusted=yes] https://apt.fury.io/xavidop/ /' | sudo tee /etc/apt/sources.list.d/voiceflow.list
sudo apt update
sudo apt install voiceflow
```

### yum

```sh theme={null}
echo '[voiceflow]
name=Vocieflow CLI Repo
baseurl=https://yum.fury.io/xavidop/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/voiceflow.repo
sudo yum install voiceflow
```

### nix

#### nixpkgs

```bash theme={null}
nix-env -iA voiceflow
```

!!! info\
The [package in nixpkgs](https://github.com/NixOS/nixpkgs/blob/main/pkgs/tools/misc/voiceflow/default.nix) might be slightly outdated, as it is not updated automatically. Use our NUR to always get the latest updates.

#### nur

First, you'll need to add our [NUR](https://github.com/xavidop/nur) to your nix configuration.\
You can follow the guides [here](https://github.com/nix-community/NUR#installation).

Once you do that, you can install the packages.

```nix theme={null}
{ pkgs, lib, ... }: {
    home.packages = with pkgs; [
    nur.repos.xavidop.voiceflow
    ];
}
```

### deb, rpm and apk packages

Download the `.deb`, `.rpm` or `.apk` packages from the \[OSS releases page]\[releases] and install them with the appropriate tools.

### go install

```sh theme={null}
go install github.com/xavidop/voiceflow-cli@latest
```

### bash script

```sh theme={null}
curl -sfL https://voiceflow.xavidop.me/static/run | bash
```

#### Additional Options

You can also set the `VERSION` variable to specify\
a version instead of using latest.

You can also pass flags and args to voiceflow-cli:

```bash theme={null}
curl -sfL https://voiceflow.xavidop.me/static/run |
    VERSION=__VERSION__ bash -s -- version
```

!!! tip\
This script does not install anything, it just downloads, verifies and runs voiceflow-cli. Its purpose is to be used within scripts and CIs.

### manually

Download the pre-compiled binaries from the \[releases page]\[releases] and copy them to the desired location.

## Verifying the artifacts

### binaries

All artifacts are checksummed, and the checksum file is signed with \[cosign]\[].

1. Download the files you want along with the `checksums.txt`, `checksum.txt.pem`, and `checksums.txt.sig` files from the \[releases]\[releases] page:

   ```sh theme={null}
   wget https://github.com/xavidop/voiceflow-cli/releases/download/__VERSION__/checksums.txt
   wget https://github.com/xavidop/voiceflow-cli/releases/download/__VERSION__/checksums.txt.sig
   wget https://github.com/xavidop/voiceflow-cli/releases/download/__VERSION__/checksums.txt.pem
   ```
2. Verify the signature:

   ```sh theme={null}
   COSIGN_EXPERIMENTAL=1 cosign verify-blob \
   --cert checksums.txt.pem \
   --signature checksums.txt.sig \
   checksums.txt
   ```
3. If the signature is valid, you can then verify the SHA256 sums match with the downloaded binary:

   ```sh theme={null}
   sha256sum --ignore-missing -c checksums.txt
   ```

### docker images

Our Docker images are signed with \[cosign]\[].

Verify the signatures:

```sh theme={null}
COSIGN_EXPERIMENTAL=1 cosign verify xavidop/voiceflow
```

!!! info\
The `.pem` and `.sig` files are the image `name:tag`, replacing `/` and `:` with `-`.

## Running with Docker

You can also use `voiceflow-cli` within a Docker container.\
To do that, you'll need to execute something more-or-less like the examples below.

Registries:

* [`xavidop/voiceflow`](https://hub.docker.com/r/xavidop/voiceflow)
* [`ghcr.io/xavidop/voiceflow`](https://github.com/xavidop/voiceflow-cli/pkgs/container/voiceflow)

Example usage:

```sh theme={null}
docker run --rm \
    xavidop/voiceflow voiceflow version
```

Note that the image will almost always have the last stable Go version.

If you need other packages and dependencies, you are encouraged to keep your own image.

## Compiling from source

If you just want to build from source for whatever reason, follow these steps:

**clone:**

```sh theme={null}
git clone https://github.com/xavidop/voiceflow-cli
cd voiceflow-cli
```

**get the dependencies:**

```sh theme={null}
go mod tidy
```

**build:**

```sh theme={null}
go build -o voiceflow .
```

**verify that it works:**

```sh theme={null}
./voiceflow version
```