Meta

For contributors: https://clig.dev has some pretty good recommendations about CLI UX goals.

Command list

This page is just a quick list of every command we've thought we'll need, so we can look for consistent patterns.

Not all of these are currently implemented! (We wanted to look forward to functionality we anticipate building, in order find naming patterns that will stay firm during growth

Existing commands

• run
• check
• catalog →
  • init
  • add
  • release
  • ls
  • show
  • bundle
  • update
  • ingest-git-tags
  • generate-html
• watch
• {status,info}
• quickstart
• ferk

Execution

Execution commands can do fileset mutations. These mutations may have records, caches, and memoizations stored in a workspace.

• warpforge quickrun — launch a container with your whole host mounted ro, and the cwd mounted rw, and the container shell launched in that same cwd. Details configurable with config files in your home workspace.
• warpforge quickbox — similar to warpforge quickrun but starts with a minimal root image instead of your whole host. Details configurable with config files in your home workspace.
• warpforge run [file | pattern]... — looks for either a module or a plain formula and Does The Thing. Or take an entire pattern (e.g. "./..."), in which case we're looking for modules, and are gonna do a bunch of fun stuff.
  • This has many, many options. In particular, you must say if it's allowed to do non-hermetic things, like --net=allow and --mount=allow and --ingest=allow.
• warpforge impact — makes changes on your host! Runs some module or formula, and then, upon success, will unpack its outputs onto your host!
  • Can be configured with where to put stuff: it's much like the input spec for a formula. (Additionally, it also allows relative paths!)
  • Has a built-in support for "atomic mode" (unpacking to a tmpdir and updating a symlink).
  • Impact profiles can be shipped alongside a module... But are only recommendations. To take effect, they must be copied into your root or home workspace. (This is similar to how gitattributes config works, and for similar reasons.)
  • N.B. not sandboxed even a little tiny bit! Can totally be used to overwrite content in your workspace. (Which can be cool — if used carefully.)