Installation
The CLI is distributed as a binary executable:Basic usage
The CLI follows this general syntax:Quick examples
Global flags
These flags are available for all commands:| Flag | Short | Default | Description |
|---|---|---|---|
--format | -f | pretty | Output format: json, table, or pretty |
--interactive | -i | false | Start interactive REPL mode |
--web-ui | -w | false | Start web UI server |
--web-address | 127.0.0.1:8080 | Web UI server address |
If you specify a database path without any command, the CLI automatically enters interactive mode.
Output formats
The CLI supports three output formats controlled by the--format flag:
- pretty
- json
- table
Colorized, human-readable output (default)
Web UI mode
Launch a built-in web interface alongside the CLI:Command categories
Commands are organized into logical groups:- Database commands - Database-level operations like backup, compaction, and info
- Collection commands - Create, drop, and manage collections
- Document commands - Insert, find, update, and delete documents
- REPL mode - Interactive shell for database exploration
Exit codes
The CLI uses standard exit codes:| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | General error (invalid syntax, database error, etc.) |
| 2 | Missing required argument |
Next steps
Database commands
Backup, compact, and inspect your database
Document commands
Insert, query, and modify documents
Interactive REPL
Explore your database interactively
Collection commands
Manage collections and schemas