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

npm

npm install -g @voyantcloud/cli

Verify the installation:

voyant --version

Quick Start

1. Login to Voyant

   Authenticate with your Voyant account via browser-based OAuth.

   voyant login
   

2. Initialize your project

   Link your local project to a Voyant workspace and project.

   voyant init
   

   This creates a voyant.json configuration file in your project root.

3. Start development

   Start your local dev server, then authenticate localhost with Voyant.

   npm run dev
   voyant dev
   

What you can do

Authenticate

Login, logout, and manage your Voyant credentials

Project Setup

Initialize, link, and configure projects

Local Development

Authenticate localhost and Payload CMS admin panels

Monitor Deployments

View deployment status across environments

Configuration

Running voyant init creates a voyant.json file:

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

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

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:

voyant --debug <command>