Skip to main content

​
Authentication

​
voyant login

Authenticate with Voyant via browser-based OAuth. 
voyant login
voyant login --force  # Re-authenticate even if already logged in

​
voyant logout

Clear stored credentials from your machine. 
voyant logout

​
voyant whoami

Display your current authentication status and available workspaces. 
voyant whoami
Example output: 
Logged in as: [email protected] (user_abc123)

Workspaces:
  wksp_abc123  Acme Travel Agency   owner
  wksp_def456  Partner Agency       member

​
Project Setup

​
voyant init

Initialize a Voyant project by creating a voyant.json configuration file. 
voyant init            # Interactive setup
voyant init -y         # Accept defaults without prompting
voyant init --force    # Overwrite existing configuration
OptionDescription
-y, --yesAccept all defaults
--forceOverwrite existing voyant.json
Re-link to a different project without full initialization. 
voyant link                              # Interactive selection
voyant link --workspace wksp_abc123      # Pre-select workspace
voyant link --project proj_xyz789        # Link directly to project
OptionDescription
--workspace <id>Workspace ID to use
--project <id>Project ID to link to
Remove the voyant.json configuration file. 
voyant unlink      # Prompts for confirmation
voyant unlink -y   # Skip confirmation
OptionDescription
-y, --yesSkip confirmation prompt

​
Development

​
voyant dev

Authenticate your localhost for local development. This generates a session token that allows your local server to communicate with Voyant APIs. 
voyant dev                                # Standard authentication
voyant dev --url http://localhost:4000    # Override dev URL
voyant dev --no-open                      # Don't open browser
voyant dev --token-only                   # Output token only (for CI)
OptionDescription
--url <url>Override the dev URL from config
--no-openDon’t open browser automatically
--token-onlyPrint token only, for CI/scripts

​
Payload CMS Integration

If your project uses Payload CMS, authenticate the admin panel: 
voyant dev --payload                      # Auth dev session + Payload admin
voyant dev --payload-only                 # Only auth Payload admin
voyant dev --payload --admin-path /cms    # Custom admin path
OptionDescription
--payloadAlso authenticate Payload CMS admin
--payload-onlyOnly authenticate Payload (skip dev session)
--admin-path <path>Payload admin path (default: /admin)

​
Utilities

​
voyant config

Display current project configuration from voyant.json. 
voyant config

​
voyant workspaces

List all workspaces you have access to. 
voyant workspaces

​
voyant projects

List all projects in a workspace. 
voyant projects                            # Prompts for workspace
voyant projects --workspace wksp_abc123    # Specific workspace
OptionDescription
--workspace <id>Workspace ID to list projects from

​
voyant open

Open the current project in the Voyant dashboard. 
voyant open              # Open project dashboard
voyant open --workspace  # Open workspace settings
OptionDescription
--workspaceOpen workspace settings instead of project

​
voyant status

Show deployment status for the current project. 
voyant status
Example output: 
Project: My Travel App (proj_abc123)

Environments:
  production   v42  active    main      2 hours ago
  staging      v38  active    develop   5 hours ago
  preview      v45  building  feature   just now

Recent Deployments:
  v45  preview     building   abc1234  Add booking feature   just now
  v44  preview     inactive   def5678  Fix header            1 hour ago
  v42  production  active     jkl3456  Release 2.1.0         2 hours ago