CLI reference
genosyn is the cluster-maintainer CLI — a thin bash wrapper around docker. No Node, no Python, just one shell script.
Installing the CLI
The installer at genosyn.com/install.sh downloads the script to /usr/local/bin/genosyn, marks it executable, then runs genosyn install. You can also grab the raw script:
curl -fsSL https://genosyn.com/genosyn -o /usr/local/bin/genosyn
chmod +x /usr/local/bin/genosynCommands
Pull the image, start the container, and enable daily automatic updates. Pass --no-auto-update to opt out. Idempotent on clean machines and existing installs.
Self-upgrade the CLI, pull the latest image, and recreate the container while retaining the previous container until the new one is ready. Backups are off by default; pass --backup to create a verified data backup and restore it on failure. Pass --no-self-upgrade to skip the script update.
Update only the genosyn CLI script in place. Useful when the container is fine but you want a newer CLI.
Enable, disable, or inspect the host's daily 03:17 automatic upgrade. Each run self-upgrades the CLI, pulls the latest image, and safely recreates the container around the existing data volume.
Start a stopped container.
Stop the running container.
Stop, then start.
Show container state, image, volume, mapped port, and the URL to open.
Show container logs. -f follows. --tail caps how many lines to print.
Tarball the data volume. Defaults to a timestamped file in the current directory.
Restore a backup tarball. Destructive — prompts before overwriting unless -y is set.
Remove the container. --purge also deletes the data volume. Without --purge, data survives for the next install.
Remove orphaned Genosyn images left over from prior upgrades. --dry-run lists what would be removed.
Stand up a self-hosted, OpenAI-compatible vLLM server on a GPU host, then print the Base URL / Model id / API key to paste into Genosyn's Custom provider. Writes a compose file + .env to ~/.genosyn/vllm and drives docker compose. Idempotent — re-run to change the model or add a key. Requires an NVIDIA GPU + nvidia-container-toolkit + Docker Compose on the host.
Show the vLLM container state, whether the API is answering, and the connect URL. (Alias: genosyn vllm ps.)
Show vLLM server logs — useful for watching the first model download and load. -f follows.
Stop the vLLM server. Downloaded weights are kept by default; --purge also deletes the model cache volume.
List all users — email, name, handle, company count, signup date. Reads the app database inside the container (SQLite or Postgres). Pass --json for machine-readable output. (Alias: genosyn users.)
Reset a user's password — the operator escape hatch when someone is locked out and email isn't configured. Generates a strong password and prints it, or set your own with --password (min 8 chars). Prompts before overwriting unless -y. (Alias: genosyn reset-password.)
Delete a user. Removes their account and company memberships; content they authored (chat, todos, notes) is preserved but unlinked. Refuses if the user is the owner of a company — transfer ownership or delete that company first. Prompts before deleting unless -y.
Print CLI and container image versions.
Show usage.
Environment overrides
Every flag has a matching environment variable. Flags on individual commands take precedence:
- GENOSYN_PORT
- Host port to expose. Default
8471. Override flag:--port. - GENOSYN_NAME
- Container name. Default
genosyn. Override flag:--name. - GENOSYN_VOLUME
- Data volume name. Default
genosyn-data. Override flag:--volume. - GENOSYN_IMAGE
- Image reference. Default
ghcr.io/genosyn/app:latest. Override flag:--image. - GENOSYN_CLI_URL
- Fetch URL for the CLI script used by
self-upgrade. Defaulthttps://genosyn.com/genosyn. - GENOSYN_AUTO_UPDATE
- Enable the daily automatic update during installation. Default
1; set0to opt out. - GENOSYN_BACKUP_DIR
- Host directory for optional, verified pre-upgrade backups. Default
~/.genosyn/backups.
Examples
Install on a non-default port
genosyn install --port 9000Follow logs, last 100 lines
genosyn logs -f --tail 100Manage automatic updates
genosyn auto-update status
genosyn auto-update off
genosyn auto-update onAutomatic updates use the host's crontab and write logs under ~/.genosyn. If cron is unavailable, installation still completes and prints the command to retry after cron is installed.
Automatic updates do not create a data backup. The previous container is retained until the new one becomes ready and is restarted if the upgrade fails, using the current data volume.
Upgrade with a verified backup
genosyn upgrade --backupThis writes an archive under ~/.genosyn/backups before replacing the container. A failed upgrade restores the archive before restarting the previous version. Successful upgrade backups are kept for manual recovery.
Daily backup to a known path
genosyn backup --out ~/backups/genosyn-$(date +%F).tar.gzRemove the container and the data
genosyn uninstall --purge