Skip to content

Command index

The 25 commands below are in published version 0.2.0. See Migration for older syntax. The seven file access workflows are implemented in source for a future release and are not in the published 0.2.0 packages.

Use pnpm exec clibox or npm exec -- clibox for a project-local installation.

CommandPurpose
clibox run envSet a child environment and execute a command.
clibox run with-rate-limitAdmit a workload through a named local token bucket.
clibox run with-lockRun a workload while holding a named local lock.
clibox run with-serviceWait for HTTP readiness, optionally while owning a service.
clibox run with-retryRetry selected nonzero workload exits with backoff.
clibox run with-timeoutLimit a workload's total runtime or output-idle time.
clibox port listInspect local listening TCP or bound UDP port owners.
clibox port killTerminate revalidated port owners.
clibox openOpen a file, directory, or URI.
clibox clipboard copyCopy text from an argument or stdin.
clibox clipboard pasteWrite desktop clipboard text to stdout.
clibox system cpusQuery estimated parallelism or online logical CPUs.
clibox text replaceReplace literal text or regex matches.
clibox time formatFormat an explicit timestamp or the current instant.
clibox time addApply calendar or elapsed-time arithmetic.
clibox base64 encodeEncode bytes as Base64.
clibox base64 decodeDecode Base64 into bytes.
clibox hash computeCompute SHA-256, SHA-512, or BLAKE3.
clibox hash verifyVerify a digest or GNU checksum manifest.
clibox wait tcpWait for a successful TCP connection.
clibox wait httpWait for an HTTP response status.
clibox wait fileWait for a regular file to exist.
clibox dotenv listList sorted unique dotenv keys.
clibox dotenv mergeMerge dotenv layers in order.
clibox yaml normalizeExpand YAML references and normalize formatting.

File access workflows in source

The source CLI adds clibox fspy record, compare, autowatch, assetcov, latencylab, min-repro, and fbreak. See File access workflows for syntax and limits. These seven commands await a future packaged release.

Help and version

clibox, clibox -h, and clibox --help print root help to stdout and exit successfully. clibox -V or clibox --version prints the installed version. Add -h to a command for core rules and examples or --help for detailed constraints.

Running a group without its required subcommand prints that group's help to stderr and returns 2. Other invalid arguments also return 2, with redacted diagnostics. See Output and cancellation for runtime statuses and Migration for removed names.

The executable is the public interface; no JavaScript import or public Rust library API is provided.