Connect with the JavaScript Client

Ensure you have installed the JavaScript Client. See here for installation instructions

Connecting with the JavaScript Client

Depending on whether you are connecting to an instance you have set up yourself, or whether you are using TerminusCMS in the cloud, there are two different methods of connection.

In both cases, you should load the TerminusDB client in your script with the following:

const TerminusClient = require("@terminusdb/terminusdb-client");


The TerminusCMS endpoint has the form where TEAM is the name of the team you are using in TerminusCMS for the data products you want to access.

In order to connect to this team, you will need to get your API key after selecting the team you want to use.

To create a client use the following code within your script, ensuring to use your credentials.

const client = new TerminusClient.WOQLClient('',
                     {user:"", organization:'Team'})

Connecting to a TerminusDB installation

Whether you are connecting to a local docker, a local server, or a server that you've set up somewhere, you can use the following to log in to TerminusDB.

const client = new TerminusClient.WOQLClient(SERVER_URL,{user:"admin",key:"myKey"})

async function getSchema() {
     const schema = await client.getSchema()

Try out the Getting Started with the TerminusDB JavaScript Client five-part tutorial to get to grips with it.