Skip to main content


Setup the CLI and run your first Task


  • Run this command to check if you have Nodejs installed. The result should be v11 or higher. If you don't have Node installed or it's in an old version, check this guide.
node -v



npm install -g runops
runops signup

Run a test command#

runops targets list

Run your first Task#

After setting up the CLI, it's time to start using it. Runops Tasks represent the scripts and commands you need to run against a live resource (Target).

Pick the Target#

The only thing you need to run a Task is a valid Target. If your company is using Runops, you already have a set of Targets available. To see the Targets available you can use the list Targets command in the CLI.

runops targets list

The result will look like this:

โ”‚ name โ”‚ type โ”‚ status โ”‚ review โ”‚ reviewers โ”‚ runner โ”‚
โ”‚ db-prod-abc โ”‚ postgres โ”‚ active โ”‚ teams โ”‚ dba,sre โ”‚ runops-hosted โ”‚

This command will show a list of the Targets you can use to run Tasks. Pick the one you need and take a note of the type, this will define the type of scripts you will use in the Task. Also, check the review mode to understand the workflow of the Target.

Run the Task#

Ok, now that we have a Target, let's create our Task. The simplest possible way to create a Task is by providing the Target name and the script.

runops tasks create \
--target 'db-prod-abc' \
--message 'Creating my first Runops Task'
--script 'select * from customers'

This Task has a SQL script, as the Target type of Postgres based on the Targets list command. The message is optional, but it's a good practice to add some context to what you are doing. This Target requires reviews and the message will help reviewers speed things up.

You have just learned the basics of Runops and ran your first script.

Anything unclear or buggy in this tutorial? Please report it in the chat at the bottom right.

Kill a Task#

If the command is taking to long, it's possible to kill an existent task in a running state, however, it is not guaranteed that it will succeed.

runops tasks kill --id <task-id>

Then, issue a get task to see if the task changed its state to killed:

runops tasks get --id <task-id>