Skip to content

Use a ParaSpace project

This is the loop for a repository that already has a .paraspace/ directory. From the repository root, four commands get you a running workspace:

sh
npm install
para image build
para up ws1
para sh ws1

Install the dependencies

sh
npm install

Most projects ship their setup layers as npm dependencies, so run this before any command that touches a workspace. Skip it if this project keeps its layers in the repository instead; read .paraspace/stack to see which way it goes. If you get it wrong, your first para command stops and lists the layer paths it could not find.

Build the project image

sh
para image build

Every workspace you create is a clone of one base image, so build it once before your first para up, and give it several minutes. Build again when the project's image hooks change, and once more if you move to a machine with a different CPU architecture. See The image contract.

Launch a workspace

sh
para up ws1

You now have an isolated workspace named ws1, with the repository cloned inside it, the environment provisioned, and the project's services running. All three are the project's own hooks, so what you get is whatever this repository decided a workspace should be.

On a fresh machine, the first launch may print an SSH public key and pause. Add that key to your Git host and continue. See Shared authentication.

Enter the workspace

sh
para sh ws1

You land in a shell in the clone, where you can run your editor, your coding agent, the tests, and the project's own commands.

Open the application

sh
para ls

That lists your workspaces with their URLs, so you can paste one into a browser. Opening it for you is a project command rather than an engine verb, and the bundled base layer ships one:

sh
para web ws1

Run para --help to see which commands this project gives you.

Create more workspaces

Each one gets its own clone, IP address, services, and URLs, so you can leave ws1 running while you work in another:

sh
para up another-feature
para sh another-feature

Use para ls to see everything you have running, and delete the ones you have finished with:

sh
para rm ws1

See Commands for the full reference.

Next

Running coding agents covers the parallel-development workflow this is built for. Workspace URLs explains routing, custom domains, and certificate trust.

Released under the MIT License.