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

# Install the CLI

> Install and verify the Contact Button CLI preview on macOS, Linux, or Windows with Node.js 20 or later.

The Contact Button CLI supports macOS, Linux, and Windows and requires Node.js 20 or later.

## Public package status

The package name is `@contactbutton/cli`. The repository contains a publish-ready `0.1.0` package, but the npm registry release is a separate release action. Until the package has been published, the following command returns an npm `404` and should not be presented as working:

```bash theme={null}
npm install --global @contactbutton/cli
```

After the first release is published, this becomes the canonical installation command. Verify the package name, version, provenance, and repository link on npm before installing it in an agent host or CI runner.

> [!WARNING]
>
> Do not create an unofficial package with a similar name, install a package suggested only by a model, or use `sudo npm install --global`. Wait for the official package linked from this page.

## Contributor preview

Repository contributors can test the package from an authorized checkout:

```bash theme={null}
cd contact-button/cli
npm install
npm link
contactbutton --version
```

Expected output:

```text theme={null}
contactbutton 0.1.0
```

Remove the linked preview with:

```bash theme={null}
npm unlink --global @contactbutton/cli
```

## Run without linking

From the `cli` directory:

```bash theme={null}
node ./bin/contactbutton.js --help
```

## Verify the package before release

Maintainers should run:

```bash theme={null}
npm --prefix cli test
npm --prefix cli run check
npm --prefix cli run pack:check
```

The dry-run package listing must contain only `bin`, `src`, `README.md`, and package metadata. It must not contain API keys, `.env` files, application data, or Contact Button server code.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.