Docs Blog Apps Pricing

Getting Started

1. Install the CLI 2. Login 3. Build and Push 4. Boot on GCP 5. Boot on Bare Metal

Guides

Authentication Pushing and Pulling Images Configuring Images Working with Hosts Working with GCP Working with Bare Metal latitude.sh OVHcloud Working with AWS Backups Tips and Tricks

CLI Reference

kheeper auth kheeper authorizations kheeper bots kheeper clouds kheeper contexts kheeper hosts kheeper images kheeper orgs kheeper push kheeper releases kheeper status

kheeper hosts

Manage host images

Flags

Flag Description Default
--context Config context to use default

Commands

kheeper hosts create

Create a host

kheeper hosts create <org>/<name> --public-key-file=pub.pem

Flags:

Flag Description Default
--public-key-file Path to a PEM-encoded ECDSA P-256 public key
--json Output in JSON format

Arguments:

  • name

kheeper hosts get

Get a host

kheeper hosts get <org>/<name>

Flags:

Flag Description Default
--json Output in JSON format

Arguments:

  • name

kheeper hosts activate

Set the active tag for a host

kheeper hosts activate <org>/<name>:<tag>

Flags:

Flag Description Default
--json Output in JSON format

Arguments:

  • name

kheeper hosts checkin

Report this host's bootc state and learn whether to pull

kheeper hosts checkin

kheeper hosts delete

Delete a host

kheeper hosts delete <org>/<name>

Flags:

Flag Description Default
--json Output in JSON format

Arguments:

  • name

kheeper hosts list

List hosts

kheeper hosts list [--org=<org>]

Flags:

Flag Description Default
--org Limit results to a specific org
--json Output in JSON format

kheeper hosts me

Print this host's identity (org/name) from the Kheeper API

kheeper hosts me [--env] [--proxy http://127.0.0.1:5000]

Flags:

Flag Description Default
--env Print env-file lines (AWS_ENDPOINT, WALG_S3_PREFIX, etc.) instead of the human-readable summary
--proxy URL of the local object-proxy to point AWS_ENDPOINT at when --env is set http://127.0.0.1:5000

kheeper hosts ipxe

Manage iPXE scripts for bare metal provisioning

kheeper hosts ipxe create

Create an iPXE script and print it to stdout

kheeper hosts ipxe create <org>/<name>

Arguments:

  • name

kheeper hosts ipxe delete

Delete an iPXE script

kheeper hosts ipxe delete <org>/<name>

Arguments:

  • name

kheeper hosts ipxe list

List active iPXE scripts

kheeper hosts ipxe list [--org <org>]

Flags:

Flag Description Default
--org Limit results to a specific org
--json Output in JSON format

kheeper hosts ovh

Provision bare-metal hosts on OVHcloud (BYOI)

kheeper hosts ovh prepare

Print the values to paste into OVH's BYOI Control Panel form

kheeper hosts ovh prepare <org>/<name>

Flags:

Flag Description Default
--context Config context to use default

Arguments:

  • name

kheeper hosts ovh install

Provision an OVH dedicated server via BYOI (needs OVH API creds)

kheeper hosts ovh install <org>/<name> --server <serviceName>

Flags:

Flag Description Default
--context Config context to use default
--server OVH dedicated server service name (e.g. ns1234567.ip-1-2-3.eu)

Arguments:

  • name