Skip to main content
Boat keeps the output of the processes in a sandbox. You can read it while the sandbox is stopped. A sandbox created with monitoring off has no history. In the dashboard, open the ⋯ menu of a sandbox and select History. A background command that runs shows its output live. You can stop it there.

What Boat keeps

The start answer of each command holds the commandId of its record.

Read the history

  1. List the history.
  2. Read the output of one command.
  • Each read gives at most 1 MiB.
  • Read again from nextOffset until done is true.
  • To get the exact bytes of binary output, pass encoding=base64.
An account keeps at most 10 MiB of compressed command output per hour. This is about 50 MiB of plain text. Boat drops the output past that, and the command shows outputTruncated: true.

Every process in the sandbox

Boat records what each process writes to its terminal, to a pipe, or to a socket such as the journal. You do not change your programs for this. Each process is one process record, with its command line, its process id and its exit code. Boat records a command that you run through boat exec one time, as a command. Its child processes do not show again as process records.
A busy sandbox has many short processes, such as shell prompts and login scripts. To see only what you ran, use --mode commands (mode=commands in the API). To see only the other processes, use --mode process.

Retention and deletion

The history is account data, the same as your sandbox files.
  • When you delete the sandbox, Boat deletes its history.
  • With zero data retention, a stop queues the history for deletion with the rest of the sandbox.

List processes

List every process in a sandbox, the busiest first. A stopped sandbox answers with the last sample that Boat kept, and live: false. Boat takes the 12 busiest processes every 30 seconds and keeps them for 7 days.
On a running sandbox, each process with a history record shows its commandId in the HISTORY column. To read its output, run boat history <sandbox> <commandId>.