Commands
Every command of zekno, one line each, with the page that describes it.
Pre-alpha and unaudited
The command-line tool, the runner and the core library have had internal reviews only. Do not use them for anything you could not afford to lose, and do not rely on them in production before an external audit.
zekno deploys Docker Compose apps to servers you own. Secrets are encrypted
and deploys are signed on your machine. The runner, a program
on your server, checks every signature before it decrypts or starts anything.
An app is deployed from a Compose file you write, or from its settings in
zekno.app.json, which zekno turns into Compose text on your machine and
signs. See zekno settings.
zekno init --name <you>
zekno server add <name> --ssh <user@host> [--runner-path <path>]
zekno server add <name> --ssh <user@host> --runner-file <path> (development only)
zekno server add <name> --local [--home <dir>]
zekno server update <name> [--yes]
zekno server ls
zekno secret set <NAME> [--app <app>] [--server <name>] [--stdin]
zekno secret import <file> [--app <app>] [--server <name>] [--yes]
zekno secret rm <NAME> [--app <app>] [--server <name>]
zekno secret ls [--app <app>] [--server <name>]
zekno deploy [--app <app>] [--server <name>] [-f <compose file>] [--json]
zekno rollback [--app <app>] [--server <name>] [--to <number>] [--json]
zekno status [--server <name>] [--json]
zekno logs [--app <app>] [--server <name>] [--tail <n>] [--no-follow]
zekno link [--app <app>] [--server <name>] [-f <compose file>] [--force] [--yes]
zekno settings [--json]
zekno settings set <service>.<setting> <value> [--yes]
zekno settings unset <service>.<setting> [--yes]
zekno settings compose
zekno settings init
zekno add [<template>] [--name <service>] [--for <service>] [--app <app>] [--server <name>] [--yes]
zekno add --list [--json]
zekno add <template> --show [--json]
zekno doctor [--server <name>] [--json]
zekno version [--json]
zekno --version [--json]zekno --help, zekno -h and zekno help print this list. In a folder
linked with zekno link, --app, --server and -f come from its
zekno.json. Flags win over it.
zekno --help: one line saying what zekno does, then every command with its flags, one to a line, and how a linked folder and a terminal change what a command needs.
Each command is described on one page:
| Command | What it does |
|---|---|
zekno | At a terminal, opens a full-screen app |
zekno init | Creates your signing key in the system keychain and starts a team with you as its admin |
zekno server add | Connects a server: the runner sets itself up for your team, and the server is added to your signed team list |
zekno server update | Replaces the runner on a server with the version this zekno carries |
zekno server ls | Lists the connected servers: name, SSH destination (or "this machine") and server id |
zekno secret set | Seals a value for one app on one server and signs it |
zekno secret import | Brings in a project's values from a file of NAME=value lines, such as a .env file, all at once |
zekno secret rm | Signs the removal of a secret |
zekno secret ls | Lists names and versions. No command shows a value |
zekno deploy | Signs a deploy with the next deploy number, and sends it to the runner over one connection |
zekno rollback | Deploys an earlier service definition again, under the next number, with the current secrets |
zekno status | Reads what a server holds: its team list version, each app's last deploy and whether it is running, and each secret's version |
zekno logs | Prints an app's logs, read straight from its server |
zekno link | Writes zekno.json in the current folder, signs it with your key, and records it as used on your machine |
zekno settings | Shows the settings in zekno.app.json, in sections |
zekno settings set | Changes one setting |
zekno settings unset | Removes one setting |
zekno settings compose | Prints the Compose text the settings turn into |
zekno settings init | Writes zekno.app.json in this folder with one service and its image |
zekno add | Adds a ready-made service, such as a database, to this folder's zekno.app.json, with the secrets it needs made on your machine |
zekno add --list, zekno add <template> --show | List the templates, or show what one would add. They change nothing |
zekno doctor | Checks this machine and each connected server, one line per check, and says what to do for each thing that is wrong |
zekno version, zekno --version | Prints the version of this zekno and of the runner release it installs |
zekno help, zekno --help, zekno -h | Print the list above |
At a terminal, a command that still lacks --server or --app asks for it:
$ zekno status
? Which server?
❯ prod deploy@203.0.113.7
staging this machine
↑↓ move enter choose esc leaveIt lists your servers, then the apps on the server you chose, read from its
runner (or, when the runner cannot be reached, the apps your machine deployed
there). With one server, that server is used and named:
Using prod, your only server. Esc or Ctrl-C leaves the question: nothing is
done, and the command ends with "Nothing was done." and exit status 1. With no
team yet, a command other than zekno init and zekno deploy says to run
zekno deploy in a project folder, or zekno init --name <you>.
With no terminal, with --json, or with input piped, a command never asks: one
that still lacks a detail stops and names the flag and the project file, as
before.
Names of apps and servers are lowercase letters, digits and hyphens, starting with a letter or a digit.