Skip to content

CLI Reference

The brane CLI is used by developers and scientists to build packages, manage workflows, and interact with instances.

CommandDescription
brane package build <PATH>Build a package from a container.yml
brane package listList local packages
brane package test <NAME> [VERSION]Test a package function locally
brane package push <NAME> [VERSION]Push a package to a remote instance
brane package searchList packages on the remote instance
brane package remove <NAME> [VERSION]Remove a local package
CommandDescription
brane workflow repl [--remote URL]Start interactive BraneScript REPL
brane workflow run <FILE> [--remote URL]Execute a workflow from a .bs file

Without --remote, workflows run in local mode.

CommandDescription
brane login <URL> --username <NAME>Set the active instance
brane instanceShow the current instance
brane data listList available datasets
brane data download <NAME>Download a dataset locally

branectl is the node management tool for system administrators.

OptionDescription
-n, --node <PATH>Path to node.yml (default: ./node.yml)
Terminal window
branectl download services <NODE_TYPE> [OPTIONS]

Node types: central, worker, proxy, auxillary

OptionDescription
-fCreate missing directories
--version <VER>Download a specific version
Terminal window
# Infrastructure (central only)
branectl generate infra -f -p ./config/infra.yml <ID:ADDR>...
# Node configuration
branectl generate node -f central <HOSTNAME>
branectl generate node -f worker <HOSTNAME> <LOCATION_ID>
branectl generate node -f proxy <HOSTNAME>
# Backend (worker only)
branectl generate backend -f -p ./config/backend.yml local
# Proxy
branectl generate proxy -f -p ./config/proxy.yml
# Certificates
branectl generate certs -f -p ./config/certs server <LOCATION_ID> -H <HOSTNAME>
branectl generate certs -f -p ./config/certs client <LOCATION_ID> -H <HOSTNAME>
# Policy
branectl generate policy_secret -f -p <PATH>
branectl generate policy_db -f -p <PATH>
branectl generate policy_token <INITIATOR> <SYSTEM> <DURATION> -s <SECRET_PATH>
Terminal window
branectl start <NODE_TYPE> # Start services
branectl stop <NODE_TYPE> # Stop services
branectl start --image-dir <DIR> ... # Custom image location