Skip to main content

Introduction

The Metadb CLI provides a comprehensive set of commands for managing your Metadb data platform. All commands follow the pattern:
metadb <command> <arguments>

Available Commands

init

Initialize a new Metadb instance

start / stop

Start and stop the Metadb server

sync / endsync

Manage data source synchronization

upgrade

Upgrade to the latest Metadb version

Global Options

Most commands support these common options:
-D, --dir
string
required
Data directory path for the Metadb instance
-v, --verbose
boolean
Enable verbose output for detailed logging
--trace
boolean
Enable extremely verbose output (development mode only)

Getting Help

For detailed help on any command:
metadb help <command>

Version Information

Check your installed Metadb version:
metadb version
The CLI requires the data directory to be specified for most operations using the -D or --dir flag.

Environment Variables

METADB_COLOR
string
Controls color output in terminal. Options: always, auto, or never
METADB_DEV
string
Set to on to enable development mode with additional debugging options

Build docs developers (and LLMs) love