Skip to content

Getting started

Install

sh
npm i -g paraspace

para drives Incus and Caddy on the host:

Using a para-enabled repo

If the repo already has a .paraspace/ dir (a maintainer committed one), you're four commands from a running workspace:

sh
para image-build  # build the project's base image — once per machine
para up ws1       # launch an isolated workspace
para sh ws1       # shell into the clone
para web ws1      # open its https URL

Two things to expect on a fresh machine: image-build takes several minutes (on macOS, para also boots its Colima VM first), and with the default template's hooks the first up pauses at a printed SSH key so you can authorize it with your git host — see Git authentication. Your browser will distrust the workspace's certificate until you trust the local CA — see Workspace URLs.

para up starts everything it needs — Incus (on macOS, the Colima VM) and the para Caddy. The full command surface (down, rm, run, …) is in Commands.

Enabling your project

para needs one thing from a project: a .paraspace/ dir at the repo root — a Parafile (config) and hooks/ (provision + boot). Commit it, and every contributor — and every agent — gets the workflow above:

sh
para init         # scaffold .paraspace/ from a working template

Then point it at your repo and your stack — the walkthrough is Project setup.

Next

  • How it works — what problem this solves, and the architecture that solves it.
  • Workspace URLs — clean :443 URLs, your own domain, browser trust.

Released under the MIT License.