Quickstart

We recommend creating a new directory for your app. You can add this directory to source control and manage your app as you would any other codebase.

mkdir tempest-hello-world && cd tempest-hello-world

# This will scaffold out the basic structure of a Private App
tempest app init hello-world

Take a look around in your new directory. You’ll find the basic structure of a Private App has been created for you. In the newly created apps directory, you’ll find your hello-world/v1 app has been created for you.

To view the capabilities of your app, you can use the tempest app describe command. This will give you a list of all the resources and actions that your app can perform.

tempest app describe hello-world:v1

The CLI will output a list of capabilities our app has implemented. In this case, the scaffolded code only implemnts the Create capability. Let’s make this resource more useful by adding some local storage, and the ability to read and write to it.

The CLI scaffolded app includes an implementation of a Example Resource with create functionality implemented. Let’s test it out.

tempest app test hello-world:v1 -o create -t example -i '{"name":"helloworld"}'

This will create a new instance of our Example Resource with the name “helloworld” property. Your CLI should have returned output similar to the following:

Resource created with ID: 1735934449
Properties:
{
  "name": "helloworld"
}

Now that you’ve created and tested your first Private App, we’ll need to connect it with your Tempest instance to start provisioning resources.

In your Tempest web console, navigate to Apps from your navigation menu.

From there, you can click Create an App from the top right corner of the screen. You’ll be taken to a page to fill in details about your new app.

Fill in the details about your new app and click Create. You’ll be taken to the app’s details page.

Tempest apps are versioned, allowing you to gracefully control how and when your app is updated. You can also have multiple versions of your app running at the same time, allowing you to test new features in a safe and controlled manner.

To create a new version of your app, click the Create a New Version button on your app’s details page.

If this is your first time creating a Private App in Tempest, and you haven’t already created an API key. You’ll find a notice in your UI prompting you to create an API key. Follow the instructions in app to create an API key.

Your new app version will be created with a status as Not Setup. Next, we’ll setup communication between your local code and your app in Tempest.

Once you’ve generated an API key, you’ll need to authenticate your CLI with it. Use the following command and you’ll be prompted to enter your API key.

tempest auth login

The CLI will output a prompt:

Input your API key: # Paste your API key here

Connecting your app to Tempest is simple. Run the following command in your terminal:

tempest app connect hello-world:v1

You’ll be prompted to review the capabilities of your app and confirm the connnection. Hit enter to continue.

➜ tempest app connect hello-world:v1
Tempest App Connect
-----------------------

Describing app: hello-world:v1
Location: /Users/happykeanu/tempest/tempest-hello-world/apps/hello-world/v1

Resource Type: Example Resource

Operations Supported:
- ❌ Read
- ❌ List
- ✅ Create
- ❌ Update
- ❌ Delete

Health Check Supported: ❌

The above capabilities will be connected to app hello-world at version v1.

Continue to connect this app to the Tempest API? (Y/n):

Successfully connected app to Tempest API. 🎉 View details at https://app.tempestdx.com/<your org details here>

To serve your app, run:
tempest app serve hello-world:v1

Next, we’ll serve our app locally.

To serve your app locally, run the following command in your terminal:

tempest app serve hello-world:v1

This will connect your app with the Tempest API and start listening for and dequeuing requests from Tempest. Your app will run as a server, and start printing logs to your console.

In your Tempest web console, navigate to your app in the Apps section, and you’ll see that your is now checking in, and it’s capabilities are registered and reflected in the UI. Next, we’ll learn how to publish your version and make it available to your users via Tempest recipes.

Visit your Hello World app’s page in your Tempest web console. Navigate to the v1 version of your app (or the version you want to publish). In the top right corner of the screen, click the Publish button.

Once published, you’ll be able to set your v1 version of the app as the active version used for your recipes. Navigate one level up to your app’s detail page, and in the sidebar on the right, you’ll see a Recipe Version section.

Once you’ve set the version, you’ll be able to use your app in recipes.

To test your app in a recipe, navigate to the Recipes section in your Tempest web console. Click Create a Recipe from the top right corner of the screen. For this example, we’ll create a Workflow that creates a new Hello World resource.

Click the Add Resource button to add a step to your workflow. Here, you’ll find your Hello World app in the list of resources, and you’ll be able to select the Example Resource resource type created by the CLI.