branectl Reference

branectl is the node management tool used by system administrators to deploy, configure, and manage Brane nodes.

Global Options

branectl [OPTIONS] <COMMAND>

Option	Description
`-n, --node <PATH>`	Path to node.yml (default: `./node.yml`)
`--help`	Show help
`--version`	Show version

Download Commands

branectl download services

Download Brane service Docker images.

branectl download services <NODE_TYPE> [OPTIONS]

Argument	Values
`NODE_TYPE`	`central`, `worker`, `proxy`, `auxillary`

Option	Description
`-f`	Create missing directories
`--version <VER>`	Download a specific version

Examples:

branectl download services central -f
branectl download services worker -f --version 3.0.0
branectl download services auxillary -f

Generate Commands

branectl generate infra

Generate infrastructure configuration for the central node.

branectl generate infra [OPTIONS] <ID:ADDR>...

Option	Description
`-f`	Create missing directories
`-p <PATH>`	Output path (default: `./config/infra.yml`)

Example:

branectl generate infra -f -p ./config/infra.yml \
  hospital-a:10.0.1.1 hospital-b:10.0.2.1

branectl generate node

Generate node configuration.

# Central node
branectl generate node [OPTIONS] central <HOSTNAME>

# Worker node
branectl generate node [OPTIONS] worker <HOSTNAME> <LOCATION_ID>

# Proxy node
branectl generate node [OPTIONS] proxy <HOSTNAME>

Option	Description
`-f`	Create missing directories

branectl generate backend

Generate backend configuration for worker nodes.

branectl generate backend [OPTIONS] <BACKEND_TYPE>

Argument	Values
`BACKEND_TYPE`	`local` (Docker daemon)

Option	Description
`-f`	Create missing directories
`-p <PATH>`	Output path

branectl generate proxy

Generate proxy configuration.

branectl generate proxy [OPTIONS]

Option	Description
`-f`	Create missing directories
`-p <PATH>`	Output path

branectl generate certs

Generate TLS certificates.

# Server certificates
branectl generate certs [OPTIONS] server <LOCATION_ID> [-H <HOSTNAME>]

# Client certificates
branectl generate certs [OPTIONS] client <LOCATION_ID> [-H <HOSTNAME>]

Option	Description
`-f`	Create missing directories
`-p <PATH>`	Output directory

branectl generate policy_secret

Generate a policy secret key file.

branectl generate policy_secret [OPTIONS]

branectl generate policy_db

Bootstrap a policy database.

branectl generate policy_db [OPTIONS]

branectl generate policy_token

Generate an access token for policy management.

branectl generate policy_token <INITIATOR> <SYSTEM> <DURATION> -s <SECRET_PATH>

Argument	Description
`INITIATOR`	Policy expert name
`SYSTEM`	Domain identifier
`DURATION`	Token validity (e.g., `30d`, `1y`)

Start/Stop Commands

branectl start

Start node services.

branectl start [OPTIONS] <NODE_TYPE>

Option	Description
`--image-dir <DIR>`	Custom image directory
`--local-aux`	Use locally downloaded auxiliary images

branectl stop

Stop node services.

branectl stop <NODE_TYPE>