Voyant CLI

With the Voyant command line interface, you can:

• Initialize and link projects to your Voyant workspace
• Authenticate your local development environment
• Monitor deployment status across environments
• Manage multiple workspaces and projects

Before you begin

Install the latest version of Node.js (v18 or higher) and a package manager of your choice.

Installation

npm install -g @voyantcloud/cli

Or with other package managers:

pnpm add -g @voyantcloud/cli
yarn global add @voyantcloud/cli

Quick Start

# Login to your Voyant account
voyant login

# Initialize your project
voyant init

# Start local dev server, then authenticate localhost
npm run dev
voyant dev

Commands

Authentication

| Command | Description | |---------|-------------| | voyant login | Authenticate with Voyant via browser | | voyant logout | Clear stored credentials | | voyant whoami | Show current user and workspaces |

Project Setup

| Command | Description | |---------|-------------| | voyant init | Initialize a project (creates voyant.json) | | voyant link | Link to a different project | | voyant unlink | Remove project configuration |

Development

| Command | Description | |---------|-------------| | voyant dev | Authenticate localhost for development | | voyant dev --payload | Also authenticate Payload CMS admin | | voyant dev --token-only | Output token only (for CI/scripts) |

Utilities

| Command | Description | |---------|-------------| | voyant status | Show deployment status | | voyant open | Open project in dashboard | | voyant config | Display current configuration | | voyant workspaces | List available workspaces | | voyant projects | List projects in a workspace |

Configuration

Running voyant init creates a voyant.json file in your project root:

{
  "$schema": "https://voyantcloud.com/schemas/voyant.json",
  "workspaceId": "wksp_abc123",
  "projectId": "proj_xyz789",
  "devUrl": "http://localhost:3000",
  "framework": "nextjs"
}

This file is safe to commit — it contains no secrets.

Supported Frameworks

The CLI auto-detects: Next.js, Remix, Nuxt, Astro, Cloudflare Workers, and Static Sites.

Debug Mode

For troubleshooting, enable debug output:

voyant --debug <command>

Help

If you encounter issues or have feedback:

• Documentation — Full CLI documentation
• GitHub Issues — Report bugs or request features

Publishing

For maintainers preparing a release to the public npm registry via pnpm:

• Ensure a clean working tree and run pnpm install
• Validate locally with pnpm test (and pnpm lint / pnpm typecheck if available)
• Build the distributable with pnpm build (also runs automatically on pnpm publish)
• Publish with pnpm publish --access public --tag latest

License

MIT