Quick Start

This guide will get you up and running with several core Deviceplane features.

In three minutes, we'll show you how to register a device with Deviceplane, and then use the CLI to SSH into a device.

Signing up

Sign up or log in to Deviceplane. If it's your first time, create a new project. Otherwise, select the project you'd like to register a device on.

Registering a device

You don't have any devices registered yet, let's add one!

After creating a new project, navigate to Devices on the sidebar, and click on "register device". It should give you a registration command that you can run on your device:

After your agent installs, you should be able to navigate back and see a device in your Devices sidebar tab.


The CLI enables you to perform most actions available in the UI, so you can quickly deploy, troubleshoot, and dig into issues via your terminal. It also offers output in JSON and YAML, so you can use it to write scriptable workflows. In this tutorial, we'll just show you how to SSH into a device using it. Note that you can also SSH into a device via the web UI.

First, let's download the CLI on your computer. If you click your user icon in the top right, you should see a dropdown that has "Download CLI" as one of the listed options. Click it, and select your OS.

Then, move the CLI to a folder in your $PATH, such as /usr/local/bin. This will let you run the deviceplane command anywhere, without needing the absolute file path. Afterwards, if you're on a UNIX-based system chmod +x [path to deviceplane], which will allow you to run the deviceplane command.

Now, you should be able to run deviceplane, and see the help output.

Let's generate a access key, so we can use the CLI to access our project.

Go to back to your browser, and in the same menu where you found "Download CLI", there should be an option to "Manage Access Keys". Click it, then create an access key. Copy the generated access key.

Go back to your CLI, run deviceplane configure, and enter your project name and your access key! You should now be able to run deviceplane device list to see the list of devices you have, as well as deviceplane ssh [device] to SSH into a device!

You're all set! Play around with the UI/CLI, or take a look at the rest of the docs to learn more.