Get Started

An overview of the ways to get started with TerminusDB.
TerminusDB is an open-source document graph database with a collaboration model providing Git-like features. It stores documents as JSON documents and the schema language connects these into a graph. It comes with GraphQL, User Interface, CLI, JavaScript, and Python Clients. TerminusX is TerminusDB as a Service and is free to use to build your Betas and experiment with the product.

Starting overview

Get started in minutes on Windows, macOS, or Linux with the steps below.

Install

Install a TerminusDB server.

Run

Start a TerminusDB server.

Go

Create, query, and maintain your databases using several programmatic interfaces.

Installation overview

Interaction with TerminusDB databases is through the TerminusBD Server. The server provides a RESTful API using the JSON-LD exchange format. This enables you to develop applications with your toolchain to utilize the powerful features of graph search and storage.
To install a TerminusDB server and use TerminusDB databases programmatically in your applications, the installation options below are available. Click on an option for detailed install instructions.

Source code

Install from the source code in GitHub.

Docker container

Install as a Docker container also referred to as the TerminusDB bootstrap.

GraphQL

TerminusDB comes with GraphQL for more information visit the GraphQL reference guide.

Javascript client

Install as a Node.js-based JavaScript Client.

Python client

Install as a Python Client. Also requires a Docker container installation.

Diagram: TerminusDB and TerminusX install options

Interfaces Overview

TerminusDB provides several interfaces for creating, querying, and maintaining your databases. Depending on the component/s you choose to install, you can interact with TerminusDB using one or more of the available interfaces listed below.
Use one or a combination of several TerminusDB interfaces.

GraphQL

TerminusDB automatically generates GraphQL schema to query data. Read the GraphQL reference guide for more information.

Command Line Interface

The TerminusDB Command Line Interface (CLI.)

Dashboard

The TerminusX dashboard provides a visual interface.

APIs

The TerminusDB Javascript and Python Client APIs.

Query

The TerminusDB Web Object Query Language (WOQL.)

Diagram: TerminusDB interfaces

Further Reading