Skip to content
Registry StackDocsv0.34.0

bregctl dev command reference

View as Markdown

Start or stop this project’s retained local development services.

This page is generated from the public Clap command tree for Registry Stack source version 0.34.0 and catalog SHA-256 521175a69262e60df96745886392348e5bb8d82e63cdd24bdf4baa80d46e5ff4. Hidden implementation commands are omitted.

bregctl dev [OPTIONS] [PROJECT]
bregctl dev <COMMAND>
CommandDescription
startStart or reuse the project’s retained local database and services
stopStop only this project’s supervised services, preserving its database, records, audit history, keys and built package
eventsShow received local webhook deliveries, hiding projected values by default
export-clientCopy an explicitly selected retained local client credential pair
tokenAcquire a fresh local client token and report its private header-file path
grantExchange an existing Casework approval using an explicit configured issuer connection
ArgumentAlways requiredDefaultValuesEnvironmentDescription
[PROJECT]No.n/an/aExisting authored registry project. Its package environment must be local. A symbolic link at any component of this path is refused.
OptionAlways requiredDefaultValuesEnvironmentDescription
--clients-file <FILE>Non/an/an/aLocal clients, profile bindings, and optional seed records (default on first start: dev-clients.yaml in the project; retained for restarts). A symbolic link at any component of this path is refused.
--breg-port <BREG_PORT>Non/an/an/aRegistry loopback port on first start (default 8090; retained for restarts)
--issuer-port <ISSUER_PORT>Non/an/an/aLocal issuer loopback port on first start (default 8091; retained for restarts)
--issuer-project <PROJECT>Non/an/an/aReady Base Registry Engine (BReg) dev project that owns the shared local issuer and client registrations. A symbolic link at any component of this path is refused.
--issuer-image <ISSUER_IMAGE>Non/an/an/aImmutable local candidate issuer image ID on first start; retained for restarts
--mint-port <MINT_PORT>Non/an/an/aRetained spelling from earlier Mint-based dev sessions; refused with legacy-session guidance rather than silently ignored
--mint-bin <MINT_BIN>Non/an/an/aRetained spelling from earlier Mint-based dev sessions; refused with legacy-session guidance rather than silently ignored
--database-port <DATABASE_PORT>Non/an/an/aPostgreSQL loopback port on first start (default 55432; retained for restarts)
--format <FORMAT>Nohumanhuman, jsonn/aEmit the selected command’s report in this format
-h, --helpNon/an/an/aPrint help

Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.