Poliage

Installation

Get the Poliage CLI installed and configured in minutes.

Prerequisites

  • Node.js 18 or higher
  • Chrome browser installed
  • A terminal (macOS, Linux, or Windows with WSL)

Install the CLI

Install Poliage globally using npm:

npm install -g @poliage/cli

Or with pnpm:

pnpm add -g @poliage/cli

Or with yarn:

yarn global add @poliage/cli

Verify Installation

Check that Poliage is installed correctly:

poliage --version

Quick Setup

The CLI includes a unified setup command that handles everything:

poliage setup

What this does:

  1. Authenticates: Links your local environment to the Poliage Platform (optional if using BYOS)
  2. Initializes: Creates a docsync.config.json file if one doesn't exist
  3. Launches Studio: Opens the local web interface at http://localhost:4300

Manual Initialization

If you prefer to set up manually, you can initialize a project with:

poliage init

This creates a basic docsync.config.json with default settings.

Authentication (Optional)

If you're using the Poliage Platform for managed storage, authenticate with:

poliage auth

Credentials are stored securely in ~/.poliage/config.json.

Authentication is only required if you're using Platform Mode. For BYOS (Bring Your Own Storage), you can skip this step.

Next Steps

Now that you have Poliage installed, continue to the Quick Start guide to capture your first visual.