✕
Skip to content

Commands ​

Every command supports --help for command-specific usage:

bash
vant trial --help
vant register --help
vant query --help

Setup ​

trial ​

Start a free 14-day trial with no account required:

bash
vant trial
vant trial "my-app" --origins "https://myapp.com,https://app.myapp.com"

Provisions an anonymous project and saves credentials to ~/.vantmetry/config.json.

No account is created and nobody is identified, so vant trial records no acceptance of the Terms. Use of the service is still governed by them, and the command prints the links before provisioning.

After the trial, link it to your account:

bash
vant claim your@email.com

register ​

Create an account and provision a project in one step:

bash
vant register your@email.com

Credentials are saved automatically and a dashboard login link is sent to your email.

Registering records your acceptance of the Terms of Service, Privacy Notice and Data Processing Agreement. The command prints the links and asks you to confirm; confirming is the acceptance.

claim ​

Link a local anonymous project (created via vant trial) to your account:

bash
vant claim your@email.com

A dashboard login link is sent to your email. This is the point where an anonymous trial gains an identified owner, so it records an acceptance the same way register does.

Accepting the terms without the prompt ​

register and claim show the Terms of Service, Privacy Notice and Data Processing Agreement and ask you to confirm. Confirming is the acceptance.

--no-interactive skips that prompt, which leaves nothing to accept the documents, so the command prints the links and exits without doing anything. Pass --accept-terms to accept them on the command line instead:

bash
vant register your@email.com --no-interactive --accept-terms

Project management ​

config ​

Configure a named project with an ingestor URL and secret key:

bash
vant config prod
vant config staging

You will be prompted for the URL and secret key. Saves to ~/.vantmetry/config.json.

use ​

Switch the active project:

bash
vant use prod
vant use staging

ls ​

List all configured projects and show which is active:

bash
vant ls

remove ​

Remove a saved project from local config:

bash
vant remove staging

Querying ​

query ​

Execute a SQL query against the active project:

bash
vant query "SELECT * FROM vantmetry_logs LIMIT 10"

Output formats:

  • --json: JSON array
  • --ndjson: Newline-delimited JSON (for piping to LLMs or large datasets)
  • --fields=col1,col2: Return only specified columns
bash
vant query "SELECT * FROM vantmetry_logs WHERE severity = 'ERROR'" --ndjson --fields=ts,message

recent ​

Show the last 20 logs with timestamp, severity, and message:

bash
vant recent

errors ​

Show recent errors grouped by fingerprint with occurrence counts:

bash
vant errors

Groups by fingerprint (hash of error type, message, and stack). Useful for finding your most frequent errors.

schema ​

Print the database schema and CLI command reference as JSON:

bash
vant schema

Outputs column names and types for vantmetry_logs. Useful for AI agents and introspection tools.


Interactive REPL ​

Drop into an interactive SQL prompt with no arguments:

bash
vant

Inside the REPL, type SQL queries or shortcuts:

vant> SELECT * FROM vantmetry_logs LIMIT 10
vant> recent
vant> errors
vant> help
vant> exit