Skip to content

Repository files navigation

Boot

Your workspace, wherever you work.

Boot recreates your project setup on any machine or cloud agent, so you can start working without rebuilding it by hand.

Install

macOS or Linux:

curl -fsSL https://useboot.co/install.sh | bash

Windows PowerShell:

irm https://useboot.co/install.ps1 | iex

Boot requires Git.

Get started

Run Boot from the folder that contains your project:

cd ~/code
boot init
boot up . --profile agent
boot inspect --json

boot init scans the project and creates boot.yaml. Review that file and commit it with your code.

boot up prepares the repositories your agent needs and checks the required tools, services, and environment variables. Add --start to run the service start commands declared in boot.yaml and wait until each service reports healthy.

boot inspect --json gives the agent a clear summary of the workspace without including secret values.

boot ui opens a local web app served by the CLI itself (127.0.0.1 only) that lists your workspaces and prepares and launches them with one click.

Start a fresh cloud agent

Publish the reviewed workspace definition once:

boot link git@github.com:acme/billing-map.git ~/code
boot save ~/code

Then prepare any fresh VM, container, or CI runner with one Boot command:

boot agent git@github.com:acme/billing-map.git /workspace \
  --profile agent --run-setup --json

The command is provider-neutral and safe to rerun. It acquires the workspace map, realizes only the selected profile, materializes available encrypted environment values, optionally runs declared setup commands, and returns secret-free readiness diagnostics. A machine that needs Boot-managed secrets must have the workspace key provisioned before bootstrap.

What Boot handles

  • One repository or many
  • Repository paths, roles, branches, and clone URLs
  • Project commands and constraints
  • Required tools, services, and environment variables
  • Starting declared services and verifying they are healthy (--start)
  • Different setups for local work, coding agents, CI, and review
  • One-command, profile-scoped setup on fresh cloud machines
  • A local launchpad (boot ui) to prepare and launch workspaces in one click

Boot prepares repositories, checks requirements, and starts the services you declare. It does not replace Git, install tools, or supervise processes.

Learn more

Development

pnpm install
pnpm lint
pnpm test:run
pnpm qa

The launchpad frontend lives in ui/ (Nuxt + Tailwind, dev-only toolchain). Build it once with pnpm ui:build; boot ui then serves it locally. Release binaries embed the built assets automatically.

License

FSL-1.1-MIT

About

Your code workspace, everywhere.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages