Docs · Command-line flags

Command-line flags

Every flag the pockode server and pockode cluster accept, with their defaults.

pockode -h
pockode cluster -h

Flags use a single dash: -port 9000 or -port=9000. Turn a boolean off with =false, as in -relay=false. Durations are written like 90s, 30m or 2h.

Server

FlagDefaultWhat it does
-password—The password for the app. Required, unless the POCKODE_PASSWORD environment variable is set; Security says when to prefer it
-workcurrent directoryThe project directory Pockode works in
-port9870Port to listen on. If it is taken, the next free port is used; the banner shows which
-relaytrueConnect to the relay so the phone can reach the machine from anywhere. -relay=false keeps the app on your own network and turns off Port Preview
-data<work>/.pockodeWhere sessions, settings, work items and logs are kept
-log-levelinfodebug, info, warn or error
-log-formattexttext or json
-log-file<data>/server.logWhere the log is written
-idle-timeout5mHow long an idle session’s CLI process is kept for the next message. 0 keeps it
-turn-timeout0 (no limit)How long one agent turn may run before it is interrupted
-answer-timeout1hHow long a permission request waits for your decision before it is withdrawn. 0 for no limit
-background-timeout24hHow long a turn waiting on background work waits before it is ended. 0 for no limit
-version—Print the version and exit

For running on a server or in a container:

FlagDefaultWhat it does
-gitfalseClone a repository into -work at startup, if it has no .git yet. Needs the four flags below
-git-repo-url—The repository to clone
-git-repo-token—The access token used to fetch and push
-git-user-name—The commit author name
-git-user-email—The commit author email
-cloud-urlhttps://cloud.pockode.comThe relay service to connect to
-relay-frontend-portthe server’s portThe local port the relay forwards app requests to
-devfalseDevelopment mode, for working on Pockode itself

Cluster mode

FlagDefaultWhat it does
-password—The password for the cluster page; or set POCKODE_PASSWORD
-port9871Port to listen on
-data~/.pockode-clusterWhere the node list and logins are kept
-relaytrueConnect to the relay; -relay=false keeps the page on your own network
-cloud-urlhttps://cloud.pockode.comThe relay service to connect to
-relay-frontend-portthe server’s portThe local port the relay forwards page requests to
-devfalseDevelopment mode, for working on Pockode itself

See Cluster mode.