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

# Voyant CLI

> Command-line interface for local development and project management

The Voyant CLI helps you manage projects, authenticate your local development environment, and monitor deployments — all from the terminal.

## Installation

<CodeGroup>
  ```bash npm theme={null}
  npm install -g @voyantcloud/cli
  ```

  ```bash pnpm theme={null}
  pnpm add -g @voyantcloud/cli
  ```

  ```bash yarn theme={null}
  yarn global add @voyantcloud/cli
  ```
</CodeGroup>

Verify the installation:

```bash theme={null}
voyant --version
```

## Quick Start

<Steps>
  <Step title="Login to Voyant">
    Authenticate with your Voyant account via browser-based OAuth.

    ```bash theme={null}
    voyant login
    ```
  </Step>

  <Step title="Initialize your project">
    Link your local project to a Voyant workspace and project.

    ```bash theme={null}
    voyant init
    ```

    This creates a `voyant.json` configuration file in your project root.
  </Step>

  <Step title="Start development">
    Start your local dev server, then authenticate localhost with Voyant.

    ```bash theme={null}
    npm run dev
    voyant dev
    ```
  </Step>
</Steps>

## What you can do

<CardGroup cols={2}>
  <Card title="Authenticate" icon="key">
    Login, logout, and manage your Voyant credentials
  </Card>

  <Card title="Project Setup" icon="folder">
    Initialize, link, and configure projects
  </Card>

  <Card title="Local Development" icon="code">
    Authenticate localhost and Payload CMS admin panels
  </Card>

  <Card title="Monitor Deployments" icon="rocket">
    View deployment status across environments
  </Card>
</CardGroup>

## Configuration

Running `voyant init` creates a `voyant.json` file:

```json theme={null}
{
  "$schema": "https://voyant.app/schemas/voyant.json",
  "workspaceId": "wksp_abc123",
  "projectId": "proj_xyz789",
  "devUrl": "http://localhost:3000",
  "framework": "nextjs"
}
```

<Note>
  This file is safe to commit to version control — it contains no secrets.
</Note>

### Supported Frameworks

The CLI auto-detects the following frameworks:

| Framework         | Detection                     | Default Port |
| ----------------- | ----------------------------- | ------------ |
| Next.js           | `next` dependency             | 3000         |
| Remix             | `@remix-run/react` dependency | 3000         |
| Nuxt              | `nuxt` dependency             | 3000         |
| Astro             | `astro` dependency            | 4321         |
| Cloudflare Worker | `wrangler.toml` or Hono       | 8787         |
| Static Site       | `index.html` in root          | 3000         |

## Debug Mode

Enable verbose output for troubleshooting:

```bash theme={null}
voyant --debug <command>
```