Skip to main content

Command Reference

This page provides an overview of all VamsCLI command groups with links to detailed documentation for each. All commands support the global options --profile, --verbose, and --help. Most commands that produce output also support --json-output for machine-readable JSON.

Common Options

The following options appear on nearly every command and are not repeated in individual pages:

  • --json-output -- Output raw JSON response instead of formatted CLI display
  • --json-input -- Provide parameters as a JSON string or file path (where supported)
  • --auto-paginate -- Automatically fetch all pages of results
  • --page-size -- Number of items per API page
  • --max-items -- Maximum total items to fetch (used with --auto-paginate, default: 10,000)
  • --starting-token -- Pagination token for manual page navigation :::

Command Groups​

Command GroupDescriptionDetailed Reference
setup, auth, features, profileInitial configuration, authentication, feature switches, and profile managementSetup and Authentication
databaseCreate, update, delete, and list databases and bucket configurationsDatabase
assets, asset-version, asset-links, assets export, assets downloadAsset CRUD, version management, relationship links, export, and downloadAssets
fileUpload, list, info, create-folder, move, copy, archive, unarchive, delete, revert, set-primaryFiles
sync filePush/pull directory synchronization with an asset, transferring only changed filesSync
tag, tag-typeTag and tag type management for asset categorizationTags
metadata, metadata-schemaMetadata CRUD for assets, files, links, and databases; schema inspectionMetadata
comment, subscriptionReview comments on an asset version, and asset event subscriptionsComments and Subscriptions
searchSearch assets and files using Amazon OpenSearch ServiceSearch
pipeline, pipeline template, pipeline tag-schemaPipeline definitions, configuration templates, and template tag schemasPipelines
workflow, workflow trigger, workflow executeWorkflow CRUD, file-upload triggers, and asset-less multi-file executionWorkflows
executionGlobal execution list, details, paged detail metadata, logs, abort, re-run, and permanent deleteExecutions
role, role constraint, role userRole management, permission constraints, user-role assignments, and template importPermissions
user cognito, api-keyAmazon Cognito user management and API key managementUsers and API Keys
industry engineering bom, industry engineering plm, industry spatialBOM assembly, PLM XML import, and spatial GLB combinationIndustry

Quick Reference​

Setup and Authentication​

vamscli setup https://your-vams-url.example.com
vamscli auth login -u admin@example.com
vamscli auth change-password -u admin@example.com
vamscli auth forgot-password -u admin@example.com
vamscli auth status
vamscli profile list

Database and Asset Management​

vamscli database list
vamscli database create -d my-database --description "Production assets"
vamscli assets list -d my-database
vamscli assets create -d my-database --name "Bridge Model" --description "3D scan" --distributable

File Operations​

vamscli file upload model.gltf -d my-db -a my-asset
vamscli file list -d my-db -a my-asset --basic --auto-paginate
vamscli file info -d my-db -a my-asset -p "/model.gltf" --include-versions

Directory Synchronization​

vamscli sync file push ./models -d my-db -a my-asset --dryrun
vamscli sync file push ./models -d my-db -a my-asset --allow-modify
vamscli sync file pull ./models -d my-db -a my-asset --allow-modify

Search and Metadata​

vamscli search simple -q "training" --entity-types asset
vamscli metadata asset list -d my-db -a my-asset
vamscli metadata-schema list -d my-database -e assetMetadata

Pipelines, Workflows, Executions, and Permissions​

vamscli pipeline list -d my-database
vamscli pipeline list --auto-paginate --json-output
vamscli workflow list -d my-database
vamscli workflow execute --workflow-database-id global -w workflow-123 --input-file my-db:asset1:/model.glb
vamscli execution list --status RUNNING
vamscli execution details-metadata execution-123 --collection output --auto-paginate
vamscli role list
vamscli role constraint template import -j ./database-admin.json

Users and API Keys​

vamscli user cognito list
vamscli api-key create --name "CI Pipeline" --user-id bot@example.com --description "Build pipeline"

Industry Commands​

vamscli industry engineering bom bomassemble --json-file bom.json -d my-db
vamscli industry engineering plm plmxml import -d my-db --plmxml-dir /data/plm/export
vamscli industry spatial glbassetcombine -d my-db -a root-asset-id

Additional Resources​