CLI

One evertap binary is both the server (evertap serve) and the CLI. evertap help lists every command with its flags. Errors go to standard error with the next step to take, and the exit status is 1.

The CLI talks to the evertap on the same machine over its socket, which needs no sign-in, or to the one evertap login paired it with, or to EVERTAP_URL with EVERTAP_API_KEY in CI (Configuration).

ResourcesCopy Anchor Link

A resource is a database or a bucket. Commands that take <name> also take the resource's id. Database names are unique per service, so if a database and a bucket share one, add --engine <service>. Bucket names are unique across RustFS and Garage.

Services are postgres (also postgresql or pg), mysql, redis, rustfs, and garage.

createCopy Anchor Link

evertap create postgres blog
evertap create postgres search --version 17 --extension vector --note "search prototype"
evertap create redis cache
evertap create rustfs photos

• --version picks the major version, newest by default: PostgreSQL 18, 17, 16, or 15; MySQL 9.7 or 8.4; Redis 8.10, 8.2, or 7.4. Buckets have none. A version cannot be changed after creation.
• --extension adds a PostgreSQL extension, such as vector, and can be repeated.
• --note sets the one-line note shown in lists.
• --temporary makes a resource that is deleted after 7 days without a connection. Each connection moves that to 7 days later. keep or protect makes it permanent. The UI never makes temporary resources.
• --json prints the resource as JSON, connection details included.

Names:

• PostgreSQL and MySQL: a lowercase letter first, then lowercase letters, digits, or _, up to 63 characters. Names the server keeps for itself, such as postgres or mysql, are refused.
• Redis: the same, and - is allowed too.
• Buckets: 3 to 63 lowercase letters, digits, or -, starting and ending with a letter or digit. RustFS keeps rustfs, minio, and health for itself. A RustFS and a Garage bucket cannot share a name: buckets reached from anywhere share one address, where only the name tells them apart.

The first database of a version, or the first bucket of a service, waits while its image downloads. If that takes over a minute, create asks you to try again in a minute while the download goes on.

reachableCopy Anchor Link

reachable makes a bucket's signed links work on any device, through the address buckets have of their own, and prints the S3_PUBLIC_ENDPOINT to sign them with; --off undoes it. Objects still need a signature (Signed links that work anywhere). It is refused in local mode, until buckets have an address, and for a bucket that shares its name with a bucket on the other service, which an earlier evertap allowed.

deleteCopy Anchor Link

delete asks you to type the name to confirm; --yes skips that, and is required without a terminal. A protected resource cannot be deleted: run evertap unprotect <name> first. Deleting removes the data for good; evertap keeps no backups.

Pairing and statusCopy Anchor Link

evertap doctor works from anywhere. On the machine running evertap it also shows the Docker socket, the data directory, and why a service failed to start, which it leaves out over the network.

On the machine running evertapCopy Anchor Link

These run as the user that runs evertap serve, over its socket.

setup asks questions in a terminal. With any flag, or without a terminal, it asks nothing and takes the flags, the answers saved before, and the defaults. For a Cloudflare Tunnel it creates, it takes the API token from CLOUDFLARE_API_TOKEN and the domain from --zone (Cloudflare Tunnel). --s3-url gives buckets reached from anywhere their address behind your proxy or your own tunnel; setup keeps the one saved before without it, and never asks for one. A tunnel setup creates serves them at s3.<your domain>.

uninstall lists what it will remove and asks you to type uninstall: evertap's Docker containers, volumes, and network, its files in the data directory, this machine's sign-in, the ev.internal line in the hosts file, and on macOS the loopback alias and its startup job. Stop evertap serve first. A Cloudflare Tunnel that setup created stays in Cloudflare, and uninstall lists what to remove there (Cloudflare Tunnel). On a laptop, it signs out and removes the ev.internal line. It does not remove the evertap binary or a systemd unit you installed (Limitations).

OtherCopy Anchor Link