Skip to content

Setup & Configuration

Installation

Install globally from npm:

bash
npm install -g vantmetry-cli@latest

Then use the vant command:

bash
vant --help

Getting started

Option A: Start a free trial (no account required)

bash
vant trial

This provisions an anonymous project, saves credentials to ~/.vantmetry/config.json, and starts a 14-day trial. No signup needed.

Once you're ready to link the project to an account:

bash
vant claim your@email.com

Option B: Register and provision in one step

bash
vant register your@email.com

Creates an account, provisions a project, and emails you a dashboard login link.

Option C: Configure an existing project manually

If you already have a project and secret key (from the dashboard):

bash
vant config prod
vant use prod

You will be prompted for:

  • API URL: e.g., https://ingestor.vantmetry.com
  • Secret Key: Your project's secret key (starts with vsk_)

Configuration File

Config is saved to ~/.vantmetry/config.json. Supported locations:

  • macOS: /Users/username/.vantmetry/config.json
  • Linux: /home/username/.vantmetry/config.json
  • Windows: C:\Users\username\.vantmetry\config.json

To view your configured projects:

bash
vant ls