Skip to content

Quickstart

The TL;DR. Want a guided walkthrough instead? See the tutorial: your first jarvy.toml.


Install

curl -fsSL https://raw.githubusercontent.com/Cliftonz/jarvy/main/dist/scripts/install.sh | bash
brew install jarvy
cargo install jarvy
irm https://raw.githubusercontent.com/Cliftonz/jarvy/main/dist/scripts/install.ps1 | iex

Download from GitHub Releases and add to PATH.

Verify: jarvy --version


Or: one-command repo bootstrap

Already have a repo with a jarvy.toml? Drop scripts/bootstrap.sh into the project so contributors can install Jarvy and provision in one command:

curl -fsSL \
  https://raw.githubusercontent.com/Cliftonz/jarvy/main/scripts/bootstrap.sh \
  -o scripts/bootstrap.sh
chmod +x scripts/bootstrap.sh
git add scripts/bootstrap.sh && git commit -m "chore: add Jarvy bootstrap"

Teammates then run a single command on a clean laptop:

git clone <your-repo> && cd <your-repo> && ./scripts/bootstrap.sh

The script installs Jarvy if missing (via the official installer above), adds the install dir to PATH, then runs jarvy setup against the repo's jarvy.toml. Idempotent — safe to re-run after vacation or when the environment drifts. Flags: --no-setup, --channel beta, plus passthrough args to jarvy setup.


Configure

Drop a jarvy.toml in your repo root:

jarvy.toml
[provisioner]
git    = "latest"
node   = "20"
python = "3.12"
docker = "latest"

[hooks.node]
post_install = "npm install -g typescript"

[env.vars]
NODE_ENV = "development"

Or start from a template: jarvy init --template node-pnpm


Provision

jarvy setup

That's it. Jarvy installs missing tools, runs hooks, writes .env, and snapshots the result for drift detection.


Verify

jarvy doctor

Walks every tool, confirms version satisfies the config.


Useful commands

Command What it does
jarvy diff What would change on this machine
jarvy setup --dry-run Full plan, no execution
jarvy validate Schema check on jarvy.toml
jarvy doctor Verify everything is installed correctly
jarvy drift check Compare current machine to the committed baseline
jarvy drift accept Update the baseline to current state
jarvy tools List all 200+ supported tools
jarvy search <name> Find a tool in the registry
jarvy explain <name> Detailed metadata for one tool
jarvy templates list Browse starter jarvy.toml files
jarvy update Self-update Jarvy
jarvy mcp Start the MCP server for AI agents

Full CLI reference →


Next