The brane CLI is used by developers and scientists to build packages, manage workflows, and interact with instances.
| Command | Description |
|---|
brane package build <PATH> | Build a package from a container.yml |
brane package list | List 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 search | List packages on the remote instance |
brane package remove <NAME> [VERSION] | Remove a local package |
| Command | Description |
|---|
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.
| Command | Description |
|---|
brane login <URL> --username <NAME> | Set the active instance |
brane instance | Show the current instance |
brane data list | List available datasets |
brane data download <NAME> | Download a dataset locally |
branectl is the node management tool for system administrators.
| Option | Description |
|---|
-n, --node <PATH> | Path to node.yml (default: ./node.yml) |
branectl download services <NODE_TYPE> [OPTIONS]
Node types: central, worker, proxy, auxillary
| Option | Description |
|---|
-f | Create missing directories |
--version <VER> | Download a specific version |
# Infrastructure (central only)
branectl generate infra -f -p ./config/infra.yml <ID:ADDR>...
branectl generate node -f central <HOSTNAME>
branectl generate node -f worker <HOSTNAME> <LOCATION_ID>
branectl generate node -f proxy <HOSTNAME>
branectl generate backend -f -p ./config/backend.yml local
branectl generate proxy -f -p ./config/proxy.yml
branectl generate certs -f -p ./config/certs server <LOCATION_ID> -H <HOSTNAME>
branectl generate certs -f -p ./config/certs client <LOCATION_ID> -H <HOSTNAME>
branectl generate policy_secret -f -p <PATH>
branectl generate policy_db -f -p <PATH>
branectl generate policy_token <INITIATOR> <SYSTEM> <DURATION> -s <SECRET_PATH>
branectl start <NODE_TYPE> # Start services
branectl stop <NODE_TYPE> # Stop services
branectl start --image-dir <DIR> ... # Custom image location