Skip to the contentSkip to the navigation
RootsGitHubMenu

Command line

The commands of roots 0.4.0, from the toolchain's own command table (what roots help prints).

Commands #

roots add #

roots add <pkg>[@range]… [-D|--dev] [--allow-young pkg] [--reviewed]

Add dependencies (cooldown, typo checks).

roots approve-builds #

roots approve-builds [pkg…] [--all]

Allow install scripts for exact versions (sandboxed).

roots build #

roots build [dir] --target web|pwa|ext|ios|android|term|all [--out dir] [--strict] [--native] [--binary] [--no-bundle] [--no-minify] [--error-codes]

Build the app in dir (default .) for a target.

roots compile #

roots compile <file.lisp> [-o out.js|out.ts] [--ts] [--target t]

Compile Lisp source to an ES module.

roots db #

roots db migrate|types|query|reset ["sql"] [dir] [--db name|file] [--check] [--out f] [--json]

SQLite: apply migrations, generate src/db-types.ts, run a query, start the local database again.

roots dev #

roots dev [dir] [--target web|pwa|ext|ios|android|term] [--port 5173] [--host addr]

Dev server with live reload (term: rebuild and restart).

roots docs #

roots docs build|check|dev|preview [dir] [--out dir] [--port n] [--base /path/] [--origin https://host] [--strict] [--lenient] [--rebuild] [--only-current] [--only-version]

The documentation site: build every version, check, write with live reload, preview.

roots doctor #

roots doctor [dir] [--target t] [--ci]

Check toolchains and the supply chain (CI workflows, MCP servers, hooks).

roots eval #

roots eval [--ts] "<forms>"

Print the JavaScript (or TypeScript) for some forms.

roots import-lock #

roots import-lock [package-lock.json]

Create roots.lock from npm's package-lock.json (v2/v3).

roots install #

roots install [--frozen] [--offline] [--verify-age] [--verify] [--allow-young pkg]

Install the dependencies in package.json (roots.lock).

roots new #

roots new <dir> [--name name]

Create a new app.

roots outdated #

roots outdated 

Direct dependencies with newer versions (and the cooldown).

roots preview #

roots preview [dir] [--target web|pwa|ext|ios|android] [--port 4173] [--out dir]

Build for production and serve the result locally.

roots publish #

roots publish --dry-run [--direct]

Check what would be published (staged + OIDC by default).

roots remove #

roots remove <pkg>…

Remove dependencies.

roots run #

roots run [dir] [--target term] | <file.lisp>

Build and run the app (terminal), or compile and run one .lisp file.

roots self #

roots self binary [--out path] [--compress]

Write the whole toolchain as one executable (default ./roots).

roots store #

roots store verify [--fix]

Re-hash the content-addressed store (~/.roots/store).

roots test #

roots test [filter]

Run every test suite of the toolchain.

roots update #

roots update [pkg…] [--allow-young pkg] [--reviewed]

Re-resolve dependencies within their ranges (with a review).

roots why #

roots why <pkg>

Show why a package is installed.