run-gp
Run local workspaces using the .gitpod.yml
run-gp
is a CLI tool for running workspaces based on a .gitpod.yml
file locally on your machine. Using a local working copy it produces a workspace image, and starts that workspace. This provides an experience akin to a regular Gitpod workspace.
Warning This is an experiment. When you find an issue, please report it so that we can improve this project.
Note
run-gp
is not the "real Gitpod experience". Gitpod offers remote development environments which sport many benefits compared to running things locally. Head over to https://www.gitpod.io to find out more.
run-gp
produces a workspace image based on the image
section in the .gitpod.yml
. If no such section exists, gitpod/workspace-full:latest
is used.run-gp
workspace is accessible from your browser.~/.ssh/id_rsa.pub
file) present, the run-gp workspace will sport an SSH server with an appropriate entry in authorized_keys. This means that you can just SSH into the run-gp
workspace, e.g. from a terminal or using VS Code..gitpod.yml
will be installed when the workspace starts up. Those extensions are downloaded from Open VSX, much like on gitpod.io..gitpod.yml
will run automatically on startup. .gitpod.yml
will be made available on startup. There is no dynamic port exposure you might expect from a Gitpod workspace.run-gp
binary.run-gp
up to date without you having to worry about it. This can be disabled - see the Config section below.run-gp
in. It does not work yet on MacOS and when run-gp
is used from within a Gitpod workspace.run-gp
is used in. It is known NOT to work on arm64 MacOS.gp
CLI is coming in a future release.run-gp
does not have a lot of configuration settings, as most thinsg are determined by the .gitpod.yml
. You can find the location of the configuration file using
run-gp config path
By default run-gp
will automatically update itself to the latest version. It does that by checking the GitHub releases of the run-gp repository for a new release.
To disable this behaviour run:
run-gp config set autoUpdate.enabled false
By default run-gp
will send anonymous telemetry. We never send identifiable details such as usernames, URLs or the like. You can review all data ever being transmitted in the sources. To disable telemetry run:
run-gp config set telemetry.enabled false
run-gp
respects Console Do Not Track, i.e. export DO_NOT_TRACK=1
will also disable telemetry.
This readme refers to run-gp
as experiment. What does that mean?
This means that run-gp
is not a polished product. Instead it's an attempt to ship a 🛹, i.e. an MVP that explores how local Gitpod-like workspaces would look like. This repository is not backed by a regular product team, but instead a product exploration effort.
The performacne on my M1 Mac is terrible, what can I do?
Until the release of MacOS 13, Docker Desktop (and any other Linux VM) will be rather slow on arm64 hardware. It's unlikely we'll produce an arm64 version of Gitpod before (if ever) MacOS 13 comes out. Your best chance is to find an x86 machine, or wait for the release of MacOS 13.