Skip to content

Commands ​

Every command but init takes -c, --config FILE to use a specific portico.yaml instead of searching for one. portico --help lists the commands, and portico --version prints the version.

Commands ​

CommandDescription
portico initWrite a starter portico.yaml in the current directory.
portico up [service…]Start your services and the proxy in front of them.
portico routesPrint the resolved route table without starting anything.
portico statusShow the state of every service of a running Portico.
portico logs [service…]Print service output from .portico/logs.
portico restart <svc>…Restart services of a running Portico.
portico downStop a running Portico, or clean up what a crashed one left.

portico init ​

FlagDescription
-y, --yesAdd everything found without asking.
--forceReplace an existing portico.yaml.

portico up and portico routes ​

Both take the flags that add to or override portico.yaml:

FlagDescription
--run name=commandRun a command as a service; {port} is substituted. Repeatable.
--route /path=portRoute a path to a port, as a service you start yourself. Repeatable.
--route /path=nameRoute a path to an existing service. Repeatable.
--port PORTPort Portico listens on (overrides proxy.port).
--host ADDRAddress Portico listens on (overrides proxy.host).
--base PATHPrefix for every route (overrides proxy.base).

portico up also takes:

FlagDescription
--tuiShow a live dashboard instead of the log stream; needs a terminal.
--watchReload when portico.yaml changes, restarting only what changed.
--hide svc[,…]Keep services' output off the screen (it's still logged). Repeatable.
--timestampsPrefix every line with the time.
--rawPrint output without prefixes or colors, and Portico's own lines to stderr.
--no-logsDon't write service output to .portico/logs.

portico logs ​

FlagDescription
-f, --followKeep printing new output.
-n, --lines NLines to show from the end of each log (default: 20).

Released under the MIT License