Synopsis

homeboy server <COMMAND>

Subcommands

create

homeboy server create [--json <spec>] [--skip-existing] <id> --host <host> --user <user> [--port <port>]

- `--port` defaults to `22`.
- When `--json` is provided, CLI mode arguments are not required.
- `id` is the server ID (not a display name); it should match what you’ll reference from projects.

server_id is the <id> you provide (CLI mode) or the id field in the JSON body (JSON mode).

show

homeboy server show <server_id>

set

homeboy server set <server_id> --json <JSON>
homeboy server set <server_id> '<JSON>'
homeboy server set --json <JSON>   # server_id may be provided in JSON body

Updates a server by merging a JSON object into servers/<id>.json.

Use null in JSON to clear a field (for example, {"identity_file": null}).

Options:

• --json <JSON>: JSON object to merge into config (supports @file and - for stdin)
• --replace <field>: replace array fields instead of union (repeatable)

delete

homeboy server delete <server_id>

Deletion is safety-checked:

• If any project references this server ID, the command errors and asks you to update/delete those projects first.

list

homeboy server list

key

homeboy server key <COMMAND>

Key subcommands:

• generate <server_id>
• show <server_id>
• import <server_id> <private_key_path>
• use <server_id> <private_key_path>
• unset <server_id>

JSON output

Note: all command output is wrapped in the global JSON envelope described in the JSON output contract. homeboy server returns a single ServerOutput object as the data payload. Fields are optional based on subcommand.

Note: all command output is wrapped in the global JSON envelope described in the JSON output contract. homeboy server returns a single ServerOutput object as the data payload. Fields are optional based on subcommand.

• command: action identifier (examples: server.create, server.key.generate)
• server_id: present for single-server actions
• server: server configuration (where applicable)
• servers: list for list
• updated: list of updated field names (values are command-specific)
• deleted: list of deleted IDs
• key: object for key actions

Note: all command output is wrapped in the global JSON envelope described in the JSON output contract. homeboy server returns a single ServerOutput object as the data payload. Fields are optional based on subcommand.

• action: generate | show | import | use | unset
• server_id
• public_key (when available)
• identity_file (when set/known)
• imported (original path used for import; ~ is expanded)

Related

• ssh