Skip to content

vgrid login & publish

Authenticate with VisiHub. Required before publish and other hub commands.

Terminal window
vgrid login [options]
OptionDescription
--tokenAPI token for non-interactive auth (also reads VISIHUB_API_KEY env var)
--api-baseAPI base URL (default: https://api.visihub.app)
Terminal window
# Interactive login
vgrid login
# Non-interactive (CI)
vgrid login --token vht_abc123
# From environment variable
VISIHUB_API_KEY=vht_abc123 vgrid login

Publish a file to VisiHub and verify its integrity. Uploads the file as a new dataset revision. VisiHub runs an integrity check (row count, column names, schema structure, content hash) and computes a structural diff against the previous version.

Terminal window
vgrid publish <file> --repo <owner/slug> [options]
OptionDescription
--repoVisiHub repository in owner/slug format (required)
--datasetDataset name in VisiHub (defaults to file basename)
--source-typeSource system type (e.g., dbt, qbo, snowflake, manual)
--source-identitySource identity (e.g., warehouse table, realm ID)
--query-hashSource query hash (for warehouse extracts)
--no-waitDon’t wait for import to complete. By default --wait is true: the CLI polls until the server finishes processing
--no-failDon’t fail on integrity check failure. By default --fail-on-check-failure is true
--outputOutput format: json or text (auto-detected: JSON when piped, text when TTY)
--assert-sumAssert sum of a numeric column (repeatable). Format: column:expected[:tolerance]
--assert-cellAssert a computed cell value in a .sheet file (repeatable). Format: sheet!cell:expected[:tolerance]
--reset-baselineReset integrity baseline (use when schema changes are intentional)
--row-count-policyCheck policy for row count changes: warn or fail
--columns-added-policyCheck policy for columns added: warn or fail
--columns-removed-policyCheck policy for columns removed: warn or fail
--strictStrict mode: all check policies set to fail
Terminal window
# Basic publish
vgrid publish data.csv --repo acme/payments
# With source tracking
vgrid publish data.csv --repo acme/payments --source-type dbt
# With source identity
vgrid publish data.csv --repo acme/analytics --source-identity analytics.monthly_close
# Non-blocking publish
vgrid publish data.csv --repo acme/payments --no-wait
# JSON output for CI
vgrid publish data.csv --repo acme/payments --output json
# Assert column sum for sanity check
vgrid publish data.csv --repo acme/payments --assert-sum amount:12345.67:0.01
# Assert computed cell in .sheet file
vgrid publish model.sheet --repo acme/analytics --assert-cell summary!B7:0:10000
# Strict mode — fail on any schema change
vgrid publish data.csv --repo acme/payments --strict
# Reset baseline after intentional schema change
vgrid publish data.csv --repo acme/payments --reset-baseline
CodeMeaning
0Check passed (or --no-fail)
1Integrity check failed
2Bad arguments
42Network error
43Server validation error
44Timeout waiting for import