Skip to content

Commands

Every command takes the global options:

options:
-C, --directory DIR Run as if otok was started in DIR
--version Print the version and exit
-h, --help Print this help and exit

otok help <command> prints the same as each section below.

Resolve the dependencies (keeping locked versions), write otok.lock, fetch the inputs and build the libraries into the output

usage: otok install [options]
options:
--profile NAME Fetch (and build) what this profile builds
--locked Fail if otok.lock is missing or would change (for CI)
--offline Use only the cache: download and fetch nothing
--frozen --locked and --offline together
--allow-advisory ID,... Install versions with these withdrawn or security advisories all the same
-v, --verbose Show what each slice builds with and the commands it runs; -vv: their output too, one slice at a time
--keep-build-dirs Keep the whole work directory of a failed build in the cache (failed/), not only its log
--no-sandbox Build without the sandbox, unisolated: on a host that has none, or for a tool the sandbox stops
--no-virtual-paths Windows: build processes see the real, long paths of the cache and the work directories, not short drive letters
--progress auto|plain auto: the slices under way below the lines on a terminal; plain: lines only
--no-dev Build what otok.lock says, ignoring the working trees of otok.dev.toml

Move every library (or the named ones) to the newest allowed version, then as install

usage: otok update [options] [LIBRARY...]
options:
--profile NAME Fetch (and build) what this profile builds
--offline Use only the cache: download and fetch nothing
--allow-advisory ID,... Install versions with these withdrawn or security advisories all the same
-v, --verbose Show what each slice builds with and the commands it runs; -vv: their output too, one slice at a time
--keep-build-dirs Keep the whole work directory of a failed build in the cache (failed/), not only its log
--no-sandbox Build without the sandbox, unisolated: on a host that has none, or for a tool the sandbox stops
--no-virtual-paths Windows: build processes see the real, long paths of the cache and the work directories, not short drive letters
--progress auto|plain auto: the slices under way below the lines on a terminal; plain: lines only
--no-dev Build what otok.lock says, ignoring the working trees of otok.dev.toml
--drop SYSTEM,... Resolve the project for machines of these systems no longer (windows, linux, macos): remove their graphs from otok.lock

Resolve and write otok.lock as install does, then fetch the inputs of every package in it (all profiles); build nothing

usage: otok fetch [options]
options:
--locked Fail if otok.lock is missing or would change (for CI)
--offline Use only the cache: download and fetch nothing
--frozen --locked and --offline together
--allow-advisory ID,... Install versions with these withdrawn or security advisories all the same
--no-dev Build what otok.lock says, ignoring the working trees of otok.dev.toml

Print the resolved graph with versions, recipes, platforms and changed options

usage: otok tree [options]
options:
--profile NAME Show the configuration of this profile
--offline Use only the cache: download and fetch nothing
--no-dev Build what otok.lock says, ignoring the working trees of otok.dev.toml

Show who requires a library and who asked for each of its option values

usage: otok why [options] LIBRARY
options:
--profile NAME Show the configuration of this profile
--offline Use only the cache: download and fetch nothing

Check otok.lock against the advisories of the index, [policy] and deprecated recipes (exit 1 on a withdrawn or security advisory or a refused license)

usage: otok audit [options]
options:
--offline Use only the cache: download and fetch nothing

List, for each locked library, the version update would choose and the newest of its recipe

usage: otok outdated [options]
options:
--profile NAME Show the configuration of this profile
--offline Use only the cache: download and fetch nothing

Find recipes of the index by id, library, description or keyword

usage: otok search [options] TEXT...
options:
--offline Use only the cache: download and fetch nothing

Show the versions, options and dependencies of a recipe of the index, or the recipes of a library

usage: otok info [options] RECIPE|LIBRARY
options:
--offline Use only the cache: download and fetch nothing

Print the resolved graph, the targets and where each library lands, as JSON for IDEs and scripts

usage: otok metadata [options]
options:
--profile NAME Show the configuration of this profile
--offline Use only the cache: download and fetch nothing

Remove the cache of this machine, or the selected parts of it

usage: otok clean [options]
options:
--downloads Remove downloaded files
--sources Remove unpacked sources and git repositories
--builds Remove built libraries, the work directories of dev builds and kept work directories of failed builds
--unused Remove only the entries unused for cache-max-age days
--days N With --unused: entries unused for N days
--dry-run Show what would be removed

Build the recipe in DIR (committed and pushed) from its remote and add its version entry to the index

usage: otok publish [options] [DIR...]
options:
--index DIR|URL A checkout of the index (committed and pushed to), or its repository on GitHub (a pull request)
--publisher NAME The publisher the recipe is published under (default on GitHub: the token's account)
--remote NAME The git remote users fetch the recipe from (default: origin)
--all Every recipe of the checkout; those published already are skipped
--dry-run Build, and publish nothing
--no-build Add the entry without building the recipe
--no-push With a checkout of the index: commit the entry, but do not push
-v, --verbose Show what each slice builds with and the commands it runs; -vv: their output too, one slice at a time
--keep-build-dirs Keep the whole work directory of a failed build in the cache (failed/), not only its log
--no-sandbox Build without the sandbox, unisolated: on a host that has none, or for a tool the sandbox stops
--no-virtual-paths Windows: build processes see the real, long paths of the cache and the work directories, not short drive letters
--progress auto|plain auto: the slices under way below the lines on a terminal; plain: lines only

Show the licenses of the third-party software built into otok, and where otok’s source is

usage: otok licenses

Show the log of the latest build of a library (or of one slice of it) kept in the cache, a failed one too

usage: otok log [options] LIBRARY [SLICE]
options:
--list List the logs of the library kept in the cache, the newest first

Check the changes of a checkout of the index as index CI does with a pull request (for index maintainers)

usage: otok index-check [options] [DIR]
options:
--base REV The commit the changes are made on
--author-id N The GitHub account id of their author
--repository OWNER/NAME The index's repository on GitHub: its maintainers and open pull requests
--pull-request N The number of the pull request checked, left out of the open ones
--approved-by N The GitHub account id of who approved it: an index maintainer's approval lets the workflow merge it
--stamp With the verdict auto, write the time of the merge into the new entries (published)
--summary FILE Write the verdict as JSON
--comment FILE Write the verdict as the Markdown of a comment for the pull request

Probe the inputs of every version of a checkout of the index into availability.toml (for index maintainers)

usage: otok index-probe [options] [DIR]
options:
--output FILE Write it elsewhere

Generate the HTTPS view of a checkout of the index (for index maintainers)

usage: otok index-view [options] [DIR]
options:
--output DIR Where the view is written: its files go to DIR/index/

Generate the catalog site of a checkout of the index, beside its view (for index maintainers)

usage: otok index-catalog [options] [DIR]
options:
--output DIR Where the site is written

© 2026 Alexander A Pototskiy and contributors. Text CC BY 4.0; examplesCC0.