Skip to content
v0.3

CLI

Terminal window
npm i -g @forgecommerce/cli
forge login --url https://<your-instance>

login stores the box under a name; --instance <name> picks between stored boxes and forge instances lists them. Every command in the registry is a CLI command, under the name it has everywhere else:

Terminal window
forge <command> --input '<json>'
forge read <capability> --input '<json>'
forge read <capability> --input '<json>' --internal

Both writes and reads take --input. --internal is what picks the OPERATOR face of a read — without it the call goes to the public one, which is a different answer rather than an error.

The CLI holds 184 commands and 91 read capabilities. It carries no list of its own — the table it dispatches on is generated from the same registry as this page, so a command that exists is callable the day it lands. forge --help prints every command with its scope and summary.

Commands marked System: yes on their page are platform commands: they reach the control face and need a platform credential, not a tenant one.