The boxxy command: one command for each procedure of the boxxy API, the close-out command that an agent runs inside a session, and the two hooks that bind a session and link its pull request.

Install

Install the package from npm with Bun:

bun add @boxxy/cli

The package runs on Bun 1.3 or newer.

An image with no Bun downloads boxxy-linux-x64, boxxy-hook-plugin.tar.gz and SHA256SUMS from the GitHub release @boxxy/cli@<version>, as the CLI release assets describes.

Usage

Set the address of the server, then run a command:

BOXXY_URL=<server_url> boxxy item list --state ready

• <server_url> is the origin of the server's owner listener. In a worker session an atc auth profile sets it to the broker's address.

boxxy --help prints the usage line of every command, and boxxy --version prints the version. A command prints the server's answer as JSON and exits 0, exits 1 on a refusal or an error, and exits 2 on a wrong command line. boxxy attempt evidence and boxxy attempt close-out print only the ID of the fact they recorded.

Features

• boxxy item, boxxy relation, boxxy defer, boxxy expedite, boxxy status and the other owner commands.
• boxxy attempt current, boxxy attempt evidence and boxxy attempt close-out, for an agent in a session.
• boxxy hook session-start and boxxy hook post-tool-use, which the plug-in in hook-plugin/ runs.
• runCLI, which runs one command line against dependencies the caller passes in.

Documentation

The CLI and the hooks lists the environment, the exit codes and what each hook does.