Skip to main content

Command Line Interface

Create databases and collections, read and write data, perform transactions, stream events and setup Tigris locally, all from the command line.

Tigris Installation

Here is instructions how to install the tigris utility.


tigris [command]

Available Commands:
alter Alters collection
completion Generates completion script for shell
config Configuration commands
create Creates database or collection
delete Deletes document(s)
describe Describes database or collection
dev Starts and stops local development Tigris server
docs Generates CLI documentation in Markdown format
drop Drops database or collection
generate Generating helper assets such as sample schema
help Help about any command
insert Inserts document(s)
list Lists databases or collections
login Authenticate on the Tigris instance
logout Logout from Tigris instance
ping Checks connection to Tigris
publish Publish message(s)
read Reads and outputs documents
replace Inserts or replaces document(s)
scaffold Scaffold a project for specified language
search Searches a collection for documents matching the query
server Tigris server related commands
subscribe Subscribes to published messages
transact Executes a set of operations in a transaction
update Updates document(s)
version Shows tigris cli version

-h, --help help for tigris

Use "tigris [command] --help" for more information about a command.