Skip to Content

Output and exit status

Exit status, and what zekno prints with and without a terminal.

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.

Exit status

StatusMeans
0Success. Also the app when you quit, and zekno logs stopped with Ctrl-C or a closed pipe
1Refused or failed, including a deploy whose app did not start, a deploy whose domains the server could not put in force or that was not healthy in time, a deploy stopped by its DNS check, and a question left with Esc or Ctrl-C
2Wrong usage, including a zekno.json not signed by your team, one not used here yet when there is no terminal to ask on, zekno with no arguments and no terminal, a folder with both zekno.app.json and compose.yaml and nothing to say which when there is no terminal to ask on, a setting value not allowed, a domain zekno domain add or rm refuses, and zekno domain in a folder that deploys a Compose file written by hand

Output

At a terminal, single commands use the app's symbols, wording and panels. zekno deploy and zekno rollback show the summary panel, the stage row and a result line with what to run next; a failed start shows what Docker reported. Over SSH nothing is animated, because SSH may ask for a password in the same terminal.

When standard output or standard input is not a terminal (piped, in a script, < /dev/null), with TERM=dumb or with --json, commands print plain lines: results on standard output with table cells separated by tabs, warnings and failures on standard error, no colour, symbols or panels. With --json, one JSON object. That form is stable, and these are the changes from the first version:

CommandPlain outputChanged from the first version?
deploy, rollbackDeploy <n> of <app> is running on <server> with <k> secrets.Yes: "<k> secret(s)" became "<k> secrets", "1 secret" or "no secrets"
deploy with a domainBefore it: dns\t<domain>\t<address> for each new domain that points to the server. After it: https\t<domain>\tlive\t<last day> or https\t<domain>\twaitingNew. A deploy with no domain prints what it printed before
deploy --json{"outcome","app","sequence","server"}No. A deploy with a domain or a health check can also have the outcome routes_failed, with a field routes, or unhealthy, with a field health
status<server>: team list version <v>, then <app>\tdeploy <n>\t<state>, then <app>/<NAME>\tversion <v>Yes: a third cell, running, stopped, partly running or unknown; the apps in Home's order, the latest deploy from your machine first. After an app's line, domain\t<app>\t<domain> for each domain the server holds for it
status --jsonAs before, plus "apps": { "<app>": { "state", "services": [...] } }Yes: one added field, and routes for a server that holds a domain
domain<domain>\t<service>\t<port>\t<state>\t<last day>, one line per domainNew
domain --jsonA list: {"domain","service","port","state","until"} for each domainNew
domain add, domain rmAs settings set, but after an rm the result is Written Run zekno deploy to release it.; then record\tA\t<domain>\t<address> (or AAAA) after an add when the server's address is knownNew
secret ls, server lsUnchangedNo
logs<time>\t<service>\t<text>, one line per log lineNew
settings<service>\t<place>\t<value>, one line per setting that is setNew
settings --jsonThe file's own data, one objectNew
settings set, settings unset<service> · <label> <old> → <new>, then Written Run zekno deploy to use it.New
settings composeThe Compose text, byte for byteNew

Docker's output is not printed during a deploy. On a failed start in plain mode, the lines Docker reported are written to standard error after the failure sentence.

A script that gives zekno a terminal on both ends (expect, script, docker run -t) gets the questions a person gets. Pass --server and --app, or --json, or < /dev/null, so that nothing waits on a question.

Lines that a runner, Docker or SSH write on standard error are passed on after the mark remote:, so they cannot pass for the tool's own. One place has no mark: at a terminal, zekno deploy and zekno rollback show Docker's latest line dim and set in by two columns under the stage row, and on a failed start show Docker's lines inside a panel titled "Docker said". Those lines are the server's words, not the tool's. Text from a server is cleaned of terminal control sequences before it reaches the terminal, in the app and in single commands.

On this page