Skip to content
readylabDocs Product

Get started with Readylab

Install on your own Linux machine. Work locally, or connect to a remote installation.

System requirements

PlatformSupport
Architecturex86_64 (AMD64) and ARM64 (AArch64)
Linux distributionsUbuntu- and Debian-based Linux distributions.
VirtualizationHardware virtualization with KVM available to the Linux installation. A hosted virtual machine needs nested virtualization.
macOS and WindowsComing soon.

Install Readylab

Run the installer on the Linux machine where you want your workspaces and apps to live:

curl -fsSL https://get.readylab.dev | sh

Prefer to download the binaries yourself? Open Downloads, choose the Linux release for your architecture and follow the installation instructions included with the release.

Use it locally

  1. Install Readylab on your Linux computer using the command above or the release binaries.
  2. Complete the installer’s setup and open the local dashboard using the address it provides.
  3. Create a project from a Git repository or start with an empty workspace.
  4. Connect your editor or agent once the workspace is Ready.

Your workspaces run in isolated environments on this computer. The computer needs to stay on for agents and deployed apps to keep running.

Self-host remotely

Connect over SSH to the Linux machine that will run Readylab, then install it there:

ssh user@your-linux-host
curl -fsSL https://get.readylab.dev | sh

Complete setup on the remote machine. To open its dashboard from your computer, use the Readylab CLI with your SSH destination:

readylab ui connect user@your-linux-host

Open the URL printed in your terminal and enter the pairing code. Keep the command running while using the dashboard. Your workspaces and apps run on the remote machine, so disconnecting your computer does not stop them.

Create your first project

In the dashboard, create a project, optionally attach a Git repository and add a workspace. Connect over SSH or VS Code Remote when it is Ready.

From the CLI on the machine running Readylab:

export READYLAB_SOCKET=/run/readylab/readylabd.sock
readylab health
readylab project create my-project
readylab project list

Next, create and connect to a workspace, run a coding agent or deploy your app.