An existing repository

On this page

Install DevCapsule first. The commands here run in your computer's terminal, from the project folder. Use a project you trust: its source folder is shared read/write with the capsule, and tools or agents running there can change it. Commit or back up work you care about before experimenting.

A project that already has a DevCapsule configuration

If the repository carries .devcapsule/devcapsule.toml, someone has already declared what the project needs. From its root:

~/.local/bin/devcapsule project init
~/.local/bin/devcapsule project run

init reads the project's declared tools and asks only for what is still yours to decide: required local values, consent to run the base image, and consent for any vendor download the selected tools need. A project can recommend host access; a recommendation grants nothing. project config show lists the recommendations and the pending decisions; authorize the ones your work needs, as Granting and withdrawing access describes. If the checkout is already initialized, go straight to project run.

A project without one

Choose one IDE and initialize from the project root:

Work you want to do Initialize with
JavaScript or TypeScript, VSCodium ~/.local/bin/devcapsule project init --need frontend-ide --need node
Python, PyCharm ~/.local/bin/devcapsule project init --need python-ide --need python

The prompts are the ones your first session explains. Then ~/.local/bin/devcapsule project run opens the IDE.

The capsule supplies the selected development tools. The project's own dependencies, databases and test commands still come from its README: run those setup commands in the IDE's terminal, inside the capsule, where they belong. A maintained project configuration can declare more of that setup; see What a project declares.

What goes where

.devcapsule/ holds the manifest and the platform lock: what the project needs and which exact versions satisfy it. They belong in Git with the project, so the next person gets the same environment. Your host permissions, private agent sign-ins and IDE state live outside the checkout, in your local DevCapsule storage; Project versus personal draws the line.

Next: add a coding agent.

Read the source on GitHub Back to top ↑