Welcome! We are excited that you want to learn how to use Runly. The Runly Quickstart will teach you how to:

  1. Setup your development environment (this page)
  2. Package a Runly job
  3. Run your first job on Runly

Create Free Account

Before you begin, sign in to Runly to create a free account. After signing in, we will create a free personal organization for you where you can complete the rest of this tutorial.

Install the CLI

The first step is to connect a node so that jobs have somewhere to run. Nodes are machines added to a cluster by running the node application on the machine, either via the CLI or as a service. For the purposes of this guide, we will connect your first node using the CLI. The easiest way to install the CLI on a develoment machine is to install it as a dotnet global tool:

dotnet tool install -g Runly.Cli

This will make the runly command available globally.

Set the API Key

When you signed up we created an organization with an environment and cluster. You can connect a node to the default cluster to be able to run jobs on the production environment.

Copy the API key from your dashboard using the Copy button.

copy api key

Then, set the API key with the CLI:

runly set-apikey <copied-api-key>

Start the Node

runly start-node

You should see something like this:

Connecting to Runly...
API URL: https://api.runly.io/
Poll Delay: 20000
Connected to myorg/default as machinename/9f75388c-ec69-4b99-a38e-49e1321df0b1
Listening for jobs to run

If you have your dashboard open, you should also now see the default cluster on your dashboard page as Online.

Congratulations! Your first node is now connected to your organization’s infrastructure and is ready to run jobs!

Continue to Step 2: Package a Runly job >>