FerryDocs
Getting startedSet up the CLI

JSON output

With --json, ferry prints the exact answer of the API. Use it in scripts.

Edit on GitHub
Terminal
$

Add --json to a command. ferry then prints , not text for people.

The JSON is exactly what the REST API sends. In the example, the jq program reads it and prints two fields.

Logs: one object for each line

For a log, --json prints one JSON object on each line. This applies to ferry logs, and to --follow on deploys and jobs.

Terminal
ferry --json logs echo-worker --tail 2
Output
{"ts":"2026-09-27T07:42:26.092974420Z","stream":"stdout","instance":"4e772d","line":"tick"}
{"ts":"2026-09-27T07:42:31.100289672Z","stream":"stdout","instance":"4e772d","line":"tick"}

The values of stream

streamThe line comes from
stdoutThe standard output of the instance
stderrThe standard error of the instance
systemFerry: the ==> messages

Output for people

By default, ferry prints text for people. The results and the progress messages use two different channels.

Follow a deploy or a job

With --follow, a command shows the log until the deploy or the job stops, then gives the result.

On this page

Logs: one object for each lineThe values of stream