Installation
Get started with Poliage by installing the CLI tool.
Prerequisites
Before installing, ensure you have:
- Node.js 18.0 or higher
- npm, yarn, or pnpm package manager
- A Poliage account (sign up at poliage.com)
The CLI requires Node.js 18+ due to native fetch API usage. Check your version with node --version.
Install the CLI
Install globally using your preferred package manager:
npm install -g @poliage/cliVerify the installation:
poliage --versionAuthentication
After installation, authenticate with your Poliage account:
Generate an API Token
- Log into the Poliage Dashboard
- Navigate to Settings → API Tokens
- Click Generate New Token
- Copy the token (it won't be shown again)
Configure the CLI
Run the login command:
poliage loginWhen prompted, paste your API token. The CLI stores it securely in ~/.poliage/config.json.
Verify Authentication
Test that authentication works:
poliage whoamiYou should see your email and account information.
Project Initialization
Initialize Poliage in your project directory:
cd your-project
poliage initThis creates a docsync.config.json file:
{
"project": "your-project-slug",
"version": "1.0.0",
"captures": []
}The project slug must match an existing project in your Poliage dashboard. Create one at poliage.com/dashboard/new.
Quick Verification
Let's verify everything works with a simple capture:
# Add a test capture configuration
poliage capture add --url "https://example.com" --name "test"
# Run the capture
poliage capture run
# Check the output
ls .poliage/captures/You should see a test.png file in the captures directory.