Skip to content
helmstudio
Contents

CLI reference

What helm prints about itself, verbatim. Install it as Install helm says, or build it from a clone with go build -o bin/helm ./cmd/helm; helm --version says which one you have.

helm

usage: helm <command> [arguments]

commands:
  validate <manifest.yaml>...   validate one or more studio manifests
  validate -theme <dir>         lint a studio's stylesheets against helm-css (-strict to fail)
  dev [-f helmstudio.yaml]      run a studio against the embedded provider, no daemon
  upgrade [--version <v>]       replace this helm with the newest release
  --version                     print which helm this is

helm validate

usage: helm validate [--json] [-criteria] [-theme <dir> [-strict]] [<manifest.yaml|registry-entry.yaml>...]

helm dev

usage: helm dev [-f helmstudio.yaml] [-addr 127.0.0.1:0] [-link weight=dir]... [-select weight] [-venv dir]
  -addr string
    	loopback address for the studio API (port 0 picks a free one) (default "127.0.0.1:0")
  -f string
    	the studio's manifest (default "helmstudio.yaml")
  -link value
    	use an existing weights directory: -link <weight>=<directory> (repeatable)
  -select string
    	which checkpoint to launch with, for a studio with selectable weights: -select <weight>
  -venv string
    	the Python environment a studio that declares python: runs in (default: the active one, $VIRTUAL_ENV)

Not built

The design names these, and none of them exists yet. They belong to no milestone.

  • helm studio init — scaffold a studio, which the quickstart's example stands in for
  • helm test — run the smoke harness that certification needs (03 §12)
  • helm doctor — score the criteria against a working tree, and say which provider a studio would get and why (01 §R6c, 05 §4)
  • helm adopt — import a studio's standalone data into the daemon, hardlinking blobs and replaying rows (01 §R6b)
  • helm dev --fixtures — serve canned data in place of a provider
  • helm dev --fail — make an operation fail on purpose, to see what a studio does