For the complete documentation index, see llms.txt. This page is also available as Markdown.

Overview

Complete apps built on Terra. Download one with the Terra CLI.

Start from a working app instead of a blank project. Each one is a complete Terra integration.

Quickstart

Download an example with the Terra CLI, then follow its setup guide. The commands below use the Unified API app.

1

Install the Terra CLI

Install with npm. This option requires Node.js 18 or later.

npm install -g @tryterra/cli

See Installation for other install options.

2

Choose an app

List the available examples, or browse the app guides below.

terra examples list
3

Download the app

Download the Unified API example into a new my-app directory:

terra examples clone unified-api-web-app my-app

To download a different app, replace unified-api-web-app with its name from the list. Choose a destination that does not exist yet, inside an existing parent directory.

Downloading requires a network connection, but no Terra login or Git.

4

Set up and run the app

Open the downloaded directory and install its dependencies:

cd my-app
npm install

Follow the app's README to configure credentials and run it. For this example, continue with the Unified API setup guide. Each app's guide lists its required tools and accounts.

How downloads work
  • clone returns the downloaded app's path and next steps.

  • If you omit my-app, the directory defaults to the example name.

  • The CLI fetches the current catalog, so new examples appear without updating it.

  • Downloading does not require Node.js if you installed the CLI without npm. Running an app requires the tools listed in its guide.

Explore the apps

The Lab Reports and Vantage apps run locally in demo mode with no credentials, so you can read the code against a working app before setting anything up.

Browse terra-examples

Last updated

Was this helpful?