Command reference
Every command of rookery with its arguments, made from the same definition as rookery --help.
This page is generated from the commands themselves. The command line explains them by what they do.
Flags of every command
| Flag | What it does |
|---|---|
--server URL | Use this rookery server for this command: https://HOST, http://HOST:PORT or unix:/path. rookery login keeps one. |
--token-file FILE | Read the server's token from this file. |
--token-stdin | Read the server's token from standard input. |
-o, --output OUTPUT | What is printed on standard output: a table for people, or the API's own JSON. One of table, json. By default table. |
--no-input | Never ask. What is missing is an error that names the flag to pass. |
-y, --yes | Answer yes to a confirmation. |
-q, --quiet | Print only the result. |
--sudo-password-stdin | Read the SSH user's sudo password from standard input, for a host whose sudo asks for one. |
--color WHEN | Colours: on a terminal, always or never. NO_COLOR turns them off as well. One of auto, always, never. By default auto. |
Flags go before or after the names, as --tail 50 or --tail=50. -- ends the flags; what follows it is passed on as it is.
Exit statuses
| Status | Means |
|---|---|
| 0 | done |
| 1 | the work failed: a job failed, or a host did not answer |
| 2 | the command line was wrong: an unknown word, a missing value, a bad flag |
| 3 | refused: the role is too low, the host or this server cannot do it now, or a confirmation was declined |
| 4 | the server could not be reached |
A command run on a host, such as rookery exec, ends with that command's own status.
Environment
| Variable | What it does |
|---|---|
ROOKERY_SERVER | The server, when no --server is given. It wins over the one rookery login kept. |
ROOKERY_TOKEN | Its token, when no --token-file or --token-stdin is given. For containers and CI. |
NO_COLOR | No colours, as --color never. |
ROOKERY_ and a setting's name | A setting of the server, in capitals, such as ROOKERY_RETENTION_DAYS, for a server in a container. |
XDG_CONFIG_HOME, XDG_DATA_HOME, XDG_RUNTIME_DIR | Where rookery keeps its settings, its data and its socket. |
VISUAL, EDITOR | The editor of rookery host edit. |
rookery ls
Short for rookery host list.
rookery lsrookery apply
Short for rookery host apply.
rookery apply NAME [--detach]| Argument | What it is |
|---|---|
NAME | Its name. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery exec
Run a command on a host and pass its exit status through.
rookery exec HOST [--user USER] [--detach] [--keep] -- COMMAND…| Argument | What it is |
|---|---|
HOST | A host's name. |
--user USER | The account it runs as: agent, operator or root. By default agent. |
--detach | Start it and return; rookery session logs HOST ID shows what it writes. |
--keep | Keep the session once it has ended, for rookery session logs. |
COMMAND… | The command and its arguments, after --. |
rookery ssh
A shell on a host over plain SSH, or a command run there. Needs the installation on this machine.
rookery ssh HOST [--agent] [-- COMMAND…]| Argument | What it is |
|---|---|
HOST | A host's name. |
--agent | Log in as the agent account. |
COMMAND… | A command to run there, after --. |
rookery run
Run one of a host's actions: rookery action list HOST names them.
rookery run HOST ACTION [NAME=VALUE…] [--detach]| Argument | What it is |
|---|---|
HOST | A host's name. |
ACTION | The action's name. |
NAME=VALUE… | The action's arguments. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery ui
Open rookery's screens: the home screen, or the page of one host.
rookery ui [HOST]| Argument | What it is |
|---|---|
HOST | The host to open. |
rookery host
The hosts: list, create, add, change, install and remove them.
rookery host list
The hosts, with their address and whether each answers.
rookery host ls is the same.
rookery host listrookery host show
One host: its type, address, state and actions.
rookery host show NAME| Argument | What it is |
|---|---|
NAME | Its name. |
rookery host create
Describe a new host, then install it. Asks what is missing on a terminal.
rookery host create NAME [--method METHOD] [--from PROFILE] [--type TYPE] [--feature FEATURE] [--no-feature FEATURE] [--set KEY=VALUE] [--generate-passwords] [--provisioner PROVISIONER] [NAME=VALUE…] [--run] [--detach]| Argument | What it is |
|---|---|
NAME | Its name. |
--method METHOD | How it is installed: provisioner, iso, cloud-seed, ssh or ssh-only. |
--from PROFILE | Start from a profile: a host's name, a JSON file, or - for standard input. |
--type TYPE | What rookery does with it: workstation, or node for a server of machines, applied over SSH. |
--feature FEATURE | Switch on a plugin's feature, PLUGIN/FEATURE. Again for more. |
--no-feature FEATURE | Switch off a plugin's feature. |
--set KEY=VALUE | Set a field of the profile. Again for more; the keys are listed below. |
--generate-passwords | Generate the accounts' passwords; rookery host credentials NAME shows them. |
--provisioner PROVISIONER | Make the machine with this provisioner, which also sets it up. |
NAME=VALUE… | The provisioner's arguments, such as cpus=2. |
--run | Install it once it is saved: apply, render the seed or build the installer. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
The ways to install, for --method:
| Method | What it is |
|---|---|
provisioner | From a provisioner |
iso | USB installer |
cloud-seed | Cloud-init seed |
ssh | Existing host over SSH |
ssh-only | Existing host, SSH only |
The fields of a profile, for --set KEY=VALUE here and rookery host set. A switch takes on or off. feature.PLUGIN/FEATURE=on, secret.NAME=VARIABLE and registry.NAME=on give a host those as well.
| Key | Field |
|---|---|
type | Type |
target | Target |
address | SSH address |
user | SSH user |
port | SSH port |
auth | Log in with |
sudo | Ask for sudo password |
power_stop | Stopped by |
hostname | Hostname |
install_tailscale | Tailscale |
tools_web | JavaScript runtimes |
tools_native | Native development |
tools_jvm | JVM development |
tools_dotnet | .NET development |
tools_scripting | Scripting languages |
tools_scientific | Scientific computing |
tools_chrome | Google Chrome |
install_playwright | Playwright |
software_rendering | Software graphics |
install_cockpit | Cockpit web console |
install_docker | Docker on host |
operator_username | Operator username |
operator_ssh_public_keys | SSH key |
operator_password_hash | Operator password hash |
agent_username | Agent username |
agent_password_hash | Agent password hash |
agent_ssh_public_keys | SSH key |
agent_privileges | Agent privileges |
agent_passwordless_sudo | Agent passwordless sudo |
harden_ssh | SSH hardening |
bootstrap_ssh_cidr | Recovery SSH CIDR |
geometry | Desktop size |
target_disk_mode | Disk selection |
target_disk_serial | Target disk serial |
target_disk_model | Disk model pattern |
target_disk_path | Disk path pattern |
target_disk_ssd | Disk type filter |
keyboard | Keyboard layout |
wifi_enabled | Wi-Fi |
wifi_ssid | Wi-Fi SSID |
wifi_password | Wi-Fi password |
wifi_interface | Wi-Fi interface |
release_store | Publish release to |
release_url | Release HTTPS URL |
release_private | Download with login |
iso | Source ISO |
iso_sha256 | ISO SHA256 |
usb_device | Then write to USB drive |
inventory | Ansible inventory |
rookery host add
Take in a machine that exists, by its address, and log in to it once.
rookery host add NAME ADDRESS [--user USER] [--port PORT] [--auth AUTH] [--type TYPE] [--feature FEATURE] [--no-contact] [--password-stdin]| Argument | What it is |
|---|---|
NAME | Its name. |
ADDRESS | Its name or IP address, or a Host alias of the server's SSH configuration. |
--user USER | The account rookery logs in as. |
--port PORT | Its SSH port, when not 22. |
--auth AUTH | How rookery logs in: rookery, key:NAME, password or ssh. |
--type TYPE | What rookery does with it: ssh, managed, node or workstation. By default ssh. |
--feature FEATURE | Switch on a plugin's feature of a node or a workstation, PLUGIN/FEATURE, such as incus/server. Again for more. |
--no-contact | Save it without logging in to it. |
--password-stdin | Read a password from standard input that installs rookery's key on it, once. |
rookery host set
Change settings of a host's profile: KEY=VALUE, as rookery host create --help lists the keys.
rookery host set NAME KEY=VALUE…| Argument | What it is |
|---|---|
NAME | Its name. |
KEY=VALUE… | KEY=VALUE, where KEY is a field (rookery host create --help), feature.PLUGIN/FEATURE, secret.NAME or registry.NAME. |
rookery host edit
Change a host's profile in $EDITOR.
rookery host edit NAME| Argument | What it is |
|---|---|
NAME | Its name. |
rookery host export
A host's profile as JSON on standard output.
rookery host export NAME| Argument | What it is |
|---|---|
NAME | Its name. |
rookery host import
Save the profile in FILE (- for standard input) as the host's, new or changed.
rookery host import NAME FILE| Argument | What it is |
|---|---|
NAME | Its name. |
FILE | The profile as JSON, such as rookery host export wrote; - for standard input. |
rookery host apply
Apply the host's profile to it over SSH, or install its controller alone when it is managed.
rookery host apply NAME [--detach]| Argument | What it is |
|---|---|
NAME | Its name. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery host seed
The cloud-init user data that installs the host on first boot, on standard output.
rookery host seed NAME [--file FILE]| Argument | What it is |
|---|---|
NAME | Its name. |
--file FILE | Write it to FILE instead. |
rookery host iso
Build the host's unattended USB installer where the server runs, and write it to a drive.
rookery host iso NAME [--write DEVICE] [--password-stdin] [--detach]| Argument | What it is |
|---|---|
NAME | Its name. |
--write DEVICE | Write it to this USB drive, which is erased, such as /dev/sdb. |
--password-stdin | Read your sudo password for writing the drive from standard input. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery host rename
Give a host another name in rookery. The machine is left as it is.
rookery host rename NAME NEW [--hostname]| Argument | What it is |
|---|---|
NAME | Its name. |
NEW | Its new name. |
--hostname | Make NEW its profile's hostname as well, and its device's name on the tailnet, for the next apply. |
rookery host remove
Forget a host. The machine is left as it is, unless --destroy.
rookery host rm is the same.
rookery host remove NAME [--destroy]| Argument | What it is |
|---|---|
NAME | Its name. |
--destroy | Destroy the machine a provisioner made for it as well, with its disk, and remove its device from the tailnet. |
rookery host duplicate
Save a copy of a host's profile as the host NEW, without what belongs to its machine. No disk is cloned.
rookery host duplicate NAME NEW [--create] [--detach]| Argument | What it is |
|---|---|
NAME | Its name. |
NEW | The copy's name. |
--create | Have the provisioner that made NAME make NEW's machine at once. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery host adopt
Take in a host rookery set up before, from the profile it keeps.
rookery host adopt NAME [ADDRESS] [--port PORT] [--key FILE] [--force] [--detach]| Argument | What it is |
|---|---|
NAME | Its name. |
ADDRESS | [USER@]ADDRESS; without it, the saved host of that name. |
--port PORT | Its SSH port, when not 22. |
--key FILE | A private key file where the server runs, offered as well for reading the profile only. |
--force | Replace a host of that name. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery host credentials
The passwords rookery generated for a host's accounts.
rookery host credentials NAME [--show]| Argument | What it is |
|---|---|
NAME | Its name. |
--show | Print them even when standard output is no terminal. |
rookery host verify
Check the host's SSH host key, and accept a new one.
rookery host verify NAME [--accept]| Argument | What it is |
|---|---|
NAME | Its name. |
--accept | Accept the key the host shows now. |
rookery host start
Start a host, through the provisioner that made it.
rookery host start NAME [--detach]| Argument | What it is |
|---|---|
NAME | Its name. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery host stop
Stop a host: through the provisioner that made it, or as its profile's power.stop says.
rookery host stop NAME [--detach]| Argument | What it is |
|---|---|
NAME | Its name. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery host inventory
The hosts as an Ansible inventory. Needs the installation on this machine.
rookery host inventory [NAMES…]| Argument | What it is |
|---|---|
NAMES… | The hosts; all with an address when none is named. |
rookery rollout
Bring the hosts up to date, one at a time.
rookery rollout [--only HOST] [--except HOST] [--all] [--update] [--reboot] [--force] [--detach]| Argument | What it is |
|---|---|
--only HOST | Only these hosts. Again for more. |
--except HOST | Leave these hosts out. Again for more. |
--all | Take hosts that are up to date as well. |
--update | Run each host's update action as well. |
--reboot | Reboot the hosts that need it, unless sessions run there. |
--force | With --reboot: even when sessions run. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery action
What a host can do.
rookery action list
What a host can do, or the installation without a host.
rookery action ls is the same.
rookery action list [HOST]| Argument | What it is |
|---|---|
HOST | A host's name. |
rookery session
The terminal and process sessions of a host.
rookery session list
A host's sessions, running and ended.
rookery session ls is the same.
rookery session list HOST| Argument | What it is |
|---|---|
HOST | A host's name. |
rookery session attach
This terminal onto a terminal session, or onto a new shell as the agent. Ctrl+Q leaves it running.
rookery session attach HOST [ID]| Argument | What it is |
|---|---|
HOST | A host's name. |
ID | Its id. |
rookery session logs
What a session wrote.
rookery session logs HOST ID [-f, --follow] [--tail N]| Argument | What it is |
|---|---|
HOST | A host's name. |
ID | Its id. |
-f, --follow | Go on as it writes more. |
--tail N | Only the last N lines. |
rookery session stop
End a session.
rookery session stop HOST ID| Argument | What it is |
|---|---|
HOST | A host's name. |
ID | Its id. |
rookery provisioner
What can make hosts and resources, such as Incus or Docker.
rookery provisioner list
The provisioners, and whether each can be used here.
rookery provisioner ls is the same.
rookery provisioner listrookery provisioner types
The types of provisioner the plugins bring.
rookery provisioner typesrookery provisioner add
Register a provisioner of a type, such as incus/vm, under a name of its own.
rookery provisioner add NAME TYPE [NAME=VALUE…]| Argument | What it is |
|---|---|
NAME | Its name. |
TYPE | Its type, as rookery provisioner types lists them. |
NAME=VALUE… | Its settings. |
rookery provisioner show
How it is now and what it holds. NAME=VALUE gives one of its settings another value for this once.
rookery provisioner show NAME [NAME=VALUE…]| Argument | What it is |
|---|---|
NAME | Its name. |
NAME=VALUE… | A setting with another value for this once. |
rookery provisioner set
Change its settings.
rookery provisioner set NAME NAME=VALUE…| Argument | What it is |
|---|---|
NAME | Its name. |
NAME=VALUE… | A setting and its new value. |
rookery provisioner rename
Give a provisioner another name in rookery, with its settings, secrets and what it made.
rookery provisioner rename NAME NEW| Argument | What it is |
|---|---|
NAME | Its name. |
NEW | Its new name. |
rookery provisioner remove
Forget a provisioner that holds nothing.
rookery provisioner rm is the same.
rookery provisioner remove NAME| Argument | What it is |
|---|---|
NAME | Its name. |
rookery provisioner actions
What it can do.
rookery provisioner actions NAME| Argument | What it is |
|---|---|
NAME | Its name. |
rookery provisioner run
Run one of its actions.
rookery provisioner run NAME ACTION [NAME=VALUE…] [--detach]| Argument | What it is |
|---|---|
NAME | Its name. |
ACTION | The action's name. |
NAME=VALUE… | The action's arguments; a required one that is missing is asked for. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery resource
What provisioners made that is not a host, such as a deployment.
rookery resource list
What provisioners made.
rookery resource ls is the same.
rookery resource list [--kind KIND] [--provisioner PROVISIONER] [--host HOST]| Argument | What it is |
|---|---|
--kind KIND | Only those of this kind, such as deployment or machine. |
--provisioner PROVISIONER | Only those this provisioner made. |
--host HOST | Only the machine of this host. |
rookery resource show
One of them as its provisioner says it is now.
rookery resource show ID| Argument | What it is |
|---|---|
ID | Its id. |
rookery resource create
Make a resource, such as a deployment from a Compose file.
rookery resource create NAME --provisioner PROVISIONER [--kind KIND] [--spec FILE] [--secret NAME[:VARIABLE]] [NAME=VALUE…] [--detach]| Argument | What it is |
|---|---|
NAME | Its name. |
--provisioner PROVISIONER | The provisioner that makes it. |
--kind KIND | Its kind, where the provisioner makes several. |
--spec FILE | The specification, such as a Compose file; - for standard input. |
--secret NAME[:VARIABLE] | A secret it gets, NAME or NAME:VARIABLE. Again for more. |
NAME=VALUE… | The arguments of its kind. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery resource set
Change a resource: other arguments, a new specification, other secrets.
rookery resource set ID [--spec FILE] [--secret NAME[:VARIABLE]] [NAME=VALUE…] [--detach]| Argument | What it is |
|---|---|
ID | Its id. |
--spec FILE | A new specification; - for standard input. |
--secret NAME[:VARIABLE] | The secrets it gets from now on, NAME or NAME:VARIABLE. Again for more. |
NAME=VALUE… | Arguments with new values. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery resource remove
Remove a resource with its provisioner.
rookery resource rm is the same.
rookery resource remove ID [--detach]| Argument | What it is |
|---|---|
ID | Its id. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery resource logs
What it wrote.
rookery resource logs ID [-f, --follow] [--tail N]| Argument | What it is |
|---|---|
ID | Its id. |
-f, --follow | Go on as it writes more. |
--tail N | Only the last N lines. |
rookery resource exec
Run a command in it, for a kind that has exec, and exit with its exit status.
rookery resource exec ID [--stdin] -- COMMAND… [--detach]| Argument | What it is |
|---|---|
ID | Its id. |
--stdin | Give the command what rookery reads on standard input, to its end. |
COMMAND… | The command and its arguments, after --. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery resource actions
What it can do.
rookery resource actions ID| Argument | What it is |
|---|---|
ID | Its id. |
rookery resource run
Run one of its actions.
rookery resource run ID ACTION [NAME=VALUE…] [--detach]| Argument | What it is |
|---|---|
ID | Its id. |
ACTION | The action's name. |
NAME=VALUE… | The action's arguments; a required one that is missing is asked for. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery job
The work the server does: applies, installers, roll-outs.
rookery job list
The jobs, newest first.
rookery job ls is the same.
rookery job list [--limit LIMIT] [--host HOST] [--subject SUBJECT] [--running] [--before ID]| Argument | What it is |
|---|---|
--limit LIMIT | By default 20. |
--host HOST | Only the jobs about this host. |
--subject SUBJECT | Only the jobs of this subject, such as provisioner:NAME or installation. |
--running | Only the jobs that are still running. |
--before ID | Only the jobs that started before this one, to see the next page. |
rookery job show
One job's state.
rookery job show ID| Argument | What it is |
|---|---|
ID | Its id. |
rookery job logs
What a job wrote.
rookery job logs ID [-f, --follow]| Argument | What it is |
|---|---|
ID | Its id. |
-f, --follow | Go on as it writes more, until it ends. |
rookery job wait
Wait for a job to end and exit with its result.
rookery job wait ID| Argument | What it is |
|---|---|
ID | Its id. |
rookery job stop
Stop a running job: its programs end, and its record says who stopped it.
rookery job stop ID| Argument | What it is |
|---|---|
ID | Its id. |
rookery key
The SSH keys rookery logs in to hosts with.
rookery key list
The keys of rookery's key ring, by their public halves.
rookery key ls is the same.
rookery key listrookery key show
One key's public half, which a host's operator takes.
rookery key show [NAME]| Argument | What it is |
|---|---|
NAME | Its name. By default rookery. |
rookery key create
Make a new ed25519 key.
rookery key create NAME| Argument | What it is |
|---|---|
NAME | Its name. |
rookery key import
Add an OpenSSH private key without a passphrase from FILE (- for standard input).
rookery key import NAME FILE| Argument | What it is |
|---|---|
NAME | Its name. |
FILE | The private key file, in OpenSSH format. |
rookery key remove
Remove a key no host logs in with.
rookery key rm is the same.
rookery key remove NAME| Argument | What it is |
|---|---|
NAME | Its name. |
rookery key rotate
Replace a key on every host that takes it.
rookery key rotate NAME [--detach]| Argument | What it is |
|---|---|
NAME | Its name. |
--detach | Print the job's id and return; rookery job wait ID waits for it. Needs a rookery serve. |
rookery key trust
Install a key on a host that does not take it yet, with a password used once.
rookery key trust HOST [--key NAME] [--password-stdin]| Argument | What it is |
|---|---|
HOST | A host's name. |
--key NAME | Log in once with this key of the ring, to install the one the host logs in with. |
--password-stdin | Read the password from standard input. |
rookery secret
Secret values the server keeps and gives to hosts.
rookery secret list
The names of the secrets.
rookery secret ls is the same.
rookery secret listrookery secret set
Set a secret's value: asked for, or read from a file or standard input.
rookery secret set NAME [--value-file FILE]| Argument | What it is |
|---|---|
NAME | Its name. |
--value-file FILE | Read the value from FILE. |
rookery secret rename
Give a secret another name. The profiles that hand it to hosts go on doing so.
rookery secret mv is the same.
rookery secret rename NAME NEW| Argument | What it is |
|---|---|
NAME | The secret, by its name or its id. |
NEW | Its new name. |
rookery secret remove
Remove a secret.
rookery secret rm is the same.
rookery secret remove NAME| Argument | What it is |
|---|---|
NAME | Its name. |
rookery registry
Registries: Nexus servers, npm, file and Docker registries.
rookery registry list
The registries.
rookery registry ls is the same.
rookery registry listrookery registry add
Add a registry, or change its address or user.
rookery registry add NAME TYPE URL [--user USER]| Argument | What it is |
|---|---|
NAME | Its name. |
TYPE | nexus, npm, raw or docker. |
URL | The address. |
--user USER | The user of its login; without one the login is a token. |
rookery registry add-repo
Add a repository of a Nexus registry.
rookery registry add-repo NAME FORMAT REPOSITORY [--address ADDRESS]| Argument | What it is |
|---|---|
NAME | Its name. |
FORMAT | npm, raw or docker. |
REPOSITORY | The repository's name on the registry. |
--address ADDRESS | Its own address, HOST[:PORT], for a Docker repository. |
rookery registry login
Keep the password or token of a registry.
rookery registry login NAME [--password-stdin]| Argument | What it is |
|---|---|
NAME | Its name. |
--password-stdin | Read it from standard input. |
rookery registry check
Whether a registry answers and takes its login.
rookery registry check [NAME]| Argument | What it is |
|---|---|
NAME | Its name. |
rookery registry rename
Give a registry another name. Its login and the hosts that use it stay with it.
rookery registry mv is the same.
rookery registry rename NAME NEW| Argument | What it is |
|---|---|
NAME | The registry, by its name or its id. |
NEW | Its new name. |
rookery registry remove
Remove a registry with its login.
rookery registry rm is the same.
rookery registry remove NAME| Argument | What it is |
|---|---|
NAME | Its name. |
rookery registry publish
Upload the release archive to a raw repository or file server, and use it as HOST's release address.
rookery registry publish DESTINATION [--host HOST] [--login REGISTRY]| Argument | What it is |
|---|---|
DESTINATION | REGISTRY or REGISTRY/REPOSITORY. |
--host HOST | A host's name. |
--login REGISTRY | The cloud seed carries this registry's login; the destination's without a name. |
rookery registry push-image
Push rookery's container image.
rookery registry push-image DESTINATION [TAG]| Argument | What it is |
|---|---|
DESTINATION | REGISTRY or REGISTRY/REPOSITORY. |
TAG | By default latest. |
rookery plugin
Plugins and what they install.
rookery plugin list
The plugins and where they come from.
rookery plugin ls is the same.
rookery plugin listrookery plugin show
What a plugin brings: its features with their actions, services and channels, and its provisioners.
rookery plugin show ID| Argument | What it is |
|---|---|
ID | Its id. |
rookery plugin add
Install a plugin with npm: a name, or the address of a tarball.
rookery plugin add SPEC| Argument | What it is |
|---|---|
SPEC | A plugin's npm name, or the address of its .tgz. |
rookery plugin remove
Remove one of the server's own plugins.
rookery plugin rm is the same.
rookery plugin remove ID| Argument | What it is |
|---|---|
ID | Its id. |
rookery plugin update
Update one plugin or all to their registry's latest version.
rookery plugin update [ID] [--check]| Argument | What it is |
|---|---|
ID | Its id. |
--check | Only say which have a newer version. |
rookery config
The settings: the server's, and this rookery's own, such as the server it uses.
rookery config list
The settings, with what each means and where it is kept.
rookery config ls is the same.
rookery config listrookery config get
One setting's value.
rookery config get KEY| Argument | What it is |
|---|---|
KEY | The setting or key. |
rookery config set
Change a setting.
rookery config set KEY VALUE| Argument | What it is |
|---|---|
KEY | The setting or key. |
VALUE | The value. |
rookery config unset
Set a setting back to its default.
rookery config unset KEY| Argument | What it is |
|---|---|
KEY | The setting or key. |
rookery port
Reach a port of a host, or an endpoint of a resource, from this machine.
rookery port forward
Listen on this machine and pass each connection to a port of a host, or to an endpoint of a resource.
TARGET is a host's name. A resource's id or name is taken when no host has that name, or always with --resource.
rookery port forward TARGET [LOCAL:]PORT|ENDPOINT… [--resource] [--address ADDRESS]| Argument | What it is |
|---|---|
TARGET | A host's name, or a resource's id or name. |
| `[LOCAL:]PORT | ENDPOINT…` |
--resource | TARGET is a resource, even where a host has the same name. |
--address ADDRESS | The address to listen on. By default 127.0.0.1. |
rookery inbox
Messages taken in from the hosts' channels.
rookery inbox list
The messages, oldest first.
rookery inbox ls is the same.
rookery inbox list [HOST] [--topic PREFIX] [--all] [--before SEQ]| Argument | What it is |
|---|---|
HOST | A host's name. |
--topic PREFIX | Only topics that start with PREFIX. |
--all | Done ones as well. |
--before SEQ | Only those taken in before this one, by the number the list ends with. |
rookery inbox done
Mark a message done, so the list leaves it out.
rookery inbox done HOST ID| Argument | What it is |
|---|---|
HOST | A host's name. |
ID | Its id. |
rookery inbox reopen
Mark a done message as open again.
rookery inbox reopen HOST ID| Argument | What it is |
|---|---|
HOST | A host's name. |
ID | Its id. |
rookery kv
The server's key-value store.
rookery kv list
The keys of a namespace with their values.
rookery kv ls is the same.
rookery kv list NAMESPACE| Argument | What it is |
|---|---|
NAMESPACE | The namespace. |
rookery kv get
One key's value.
rookery kv get NAMESPACE KEY| Argument | What it is |
|---|---|
NAMESPACE | The namespace. |
KEY | The setting or key. |
rookery kv set
Write a key: JSON, or else text.
rookery kv set NAMESPACE KEY VALUE| Argument | What it is |
|---|---|
NAMESPACE | The namespace. |
KEY | The setting or key. |
VALUE | The value. |
rookery kv remove
Remove a key.
rookery kv rm is the same.
rookery kv remove NAMESPACE KEY| Argument | What it is |
|---|---|
NAMESPACE | The namespace. |
KEY | The setting or key. |
rookery channel
A host's channel.
rookery channel listen
Messages on a host's channel as they come, one JSON object per line.
rookery channel listen HOST [--topic PREFIX] [--since ID]| Argument | What it is |
|---|---|
HOST | A host's name. |
--topic PREFIX | Only topics that start with PREFIX. |
--since ID | From after this message on. |
rookery service
Services that plugins run on a host.
rookery service call
Call a method of a service a plugin runs on the host.
rookery service call HOST SERVICE METHOD [BODY]| Argument | What it is |
|---|---|
HOST | A host's name. |
SERVICE | PLUGIN/NAME of the service. |
METHOD | The service's method. |
BODY | The body, as JSON. |
rookery server
The rookery server of this machine: running it, its setup key, its store and its API documents.
rookery server run
Serve the API over all hosts on a socket of this user, and over HTTP with --listen.
rookery server run [--listen ADDRESS:PORT] [--expose] [--simulate] [--seed FILE] [--delay SECONDS] [--data DIR] [--keep]| Argument | What it is |
|---|---|
--listen ADDRESS:PORT | Also listen over HTTP, behind a token. |
--expose | Allow an address other than this machine's own. |
--simulate | Run a simulated server to test an application against: the real API on a scratch store, with hosts and provisioners that reach no machine. |
--seed FILE | A JSON file with the hosts, provisioners, secrets and token the simulated server starts with. |
--delay SECONDS | Seconds a simulated step takes, 2 unless given; 0 for none. |
--data DIR | Keep the simulated server's state in DIR, an empty one or one of an earlier simulation, instead of a scratch directory. |
--keep | Leave the scratch directory when the simulated server ends. |
rookery server setup-key
Make a key, valid for a day, that lets the first user collect the server's token.
rookery server setup-key [--revoke]| Argument | What it is |
|---|---|
--revoke | End the key that is open. |
rookery server store
Where the server keeps its state, and sealing it.
rookery server store status
Where the store is, and whether it is sealed.
rookery server store statusrookery server store encrypt
Seal the store's values with a new key file.
rookery server store encryptrookery server store rekey
Seal them with another key.
rookery server store rekeyrookery server store decrypt
Write them plain again.
rookery server store decryptrookery server store copy
Copy the store into another SQLite file or PostgreSQL database, and switch to it.
rookery server store copy [TARGET] [--target-file FILE] [--into-existing]| Argument | What it is |
|---|---|
TARGET | A file, a PostgreSQL URL, or - to read it from standard input. |
--target-file FILE | Read the target from FILE. |
--into-existing | Copy into a database that holds a store already. |
rookery server api
The server's API documents.
rookery server api openapi
The OpenAPI document.
rookery server api openapirookery server api asyncapi
The AsyncAPI document of the streams.
rookery server api asyncapirookery server api operations
The operations, with their routes and roles.
rookery server api operationsrookery server image
Build the server's image from this rookery with this machine's Docker engine.
rookery server image [--tag TAG]| Argument | What it is |
|---|---|
--tag TAG | The image's tag: rookery:VERSION, this rookery's version, unless another is given. |
rookery server deploy
Run the rookery server on a machine with Docker, over SSH: from an image built there from this rookery, or from a release.
rookery server deploy [USER@]HOST [--container NAME] [--port PORT] [--release VERSION]| Argument | What it is |
|---|---|
[USER@]HOST | The machine, as ssh reaches it with your own keys and settings. |
--container NAME | The server's container there. By default rookery. |
--port PORT | The port the server listens on there, on 127.0.0.1. A new container gets 7777 without it. |
--release VERSION | Pull the published image of this version instead, as ghcr.io/aiviarium/rookery:VERSION. |
rookery serve
Short for rookery server run.
rookery serve [--listen ADDRESS:PORT] [--expose] [--simulate] [--seed FILE] [--delay SECONDS] [--data DIR] [--keep]| Argument | What it is |
|---|---|
--listen ADDRESS:PORT | Also listen over HTTP, behind a token. |
--expose | Allow an address other than this machine's own. |
--simulate | Run a simulated server to test an application against: the real API on a scratch store, with hosts and provisioners that reach no machine. |
--seed FILE | A JSON file with the hosts, provisioners, secrets and token the simulated server starts with. |
--delay SECONDS | Seconds a simulated step takes, 2 unless given; 0 for none. |
--data DIR | Keep the simulated server's state in DIR, an empty one or one of an earlier simulation, instead of a scratch directory. |
--keep | Leave the scratch directory when the simulated server ends. |
rookery login
Use the rookery server at URL, with a setup key made there.
rookery login URL [--setup-key-stdin]| Argument | What it is |
|---|---|
URL | https://HOST or http://HOST:PORT. |
--setup-key-stdin | Read the setup key from standard input. |
rookery logout
Stop using the rookery server rookery login kept.
rookery logoutrookery update
Install the latest release in this program's place.
rookery update [--check] [--from URL]| Argument | What it is |
|---|---|
--check | Only say whether there is a newer release. |
--from URL | Where releases are, instead of rookery's own. |
rookery version
The version of this rookery, and of the server it uses.
rookery versionrookery completion
The completions of a shell, to source from its start-up file.
rookery completion SHELL| Argument | What it is |
|---|---|
SHELL | bash, zsh, fish, elvish or powershell. One of bash, elvish, fish, powershell, zsh. |
Last updated on