Poliage

CLI Reference

Complete reference for all Poliage CLI commands and options.

Global Options

These options are available on all commands:

OptionDescription
--help, -hDisplay help for command
--version, -VOutput version number
--config, -cPath to config file (default: docsync.config.json)
--verboseEnable verbose output
--quietSuppress all output except errors

Commands

poliage init

Initialize a new Poliage project in the current directory.

poliage init [options]

Options:

OptionDescription
--project, -pProject slug to use
--force, -fOverwrite existing config

Example:

poliage init --project my-docs

poliage login

Authenticate with the Poliage platform.

poliage login [options]

Options:

OptionDescription
--token, -tAPI token (avoids interactive prompt)

Example:

# Interactive login
poliage login
 
# Non-interactive (for CI)
poliage login --token $POLIAGE_TOKEN

poliage whoami

Display current authenticated user information.

poliage whoami

poliage capture

Capture commands for managing and running captures.

poliage capture run

Execute captures defined in config.

poliage capture run [options]

Options:

OptionDescription
--filterComma-separated capture names to run
--parallel, -PNumber of parallel captures (default: 3)
--output, -oOutput directory (default: .poliage/captures)

Example:

# Run all captures
poliage capture run
 
# Run specific captures
poliage capture run --filter homepage,dashboard
 
# Run with more parallelism
poliage capture run --parallel 5

poliage capture add

Add a new capture configuration.

poliage capture add [options]

Options:

OptionDescription
--url, -uURL to capture (required)
--name, -nCapture name (required)
--selector, -sCSS selector for element capture
--widthViewport width (default: 1280)
--heightViewport height (default: 720)

poliage capture interactive

Launch interactive capture mode.

poliage capture interactive [options]

Options:

OptionDescription
--portWeb interface port (default: 3333)

poliage sync

Sync local captures to the Poliage platform.

poliage sync [options]

Options:

OptionDescription
--message, -mCommit message
--dry-runPreview without uploading
--force, -fSkip confirmation prompts

Example:

# Standard sync
poliage sync -m "Updated login screenshots"
 
# Preview changes
poliage sync --dry-run

poliage status

Show current project status and pending changes.

poliage status

Output includes:

  • Number of local captures
  • Changes since last sync
  • Current project information

poliage config

Manage configuration settings.

poliage config get

Get a configuration value.

poliage config get <key>

poliage config set

Set a configuration value.

poliage config set <key> <value>

Example:

poliage config set defaultViewport.width 1920
poliage config get defaultViewport.width

Environment Variables

VariableDescription
POLIAGE_TOKENAPI authentication token
POLIAGE_PROJECTDefault project slug
POLIAGE_CONFIGPath to config file
POLIAGE_OUTPUTDefault output directory

Exit Codes

CodeDescription
0Success
1General error
2Configuration error
3Authentication error
4Network error
5Capture error