rwx logs

Download logs for a task (using the ID in the page's URL).

Usage

rwx logs <task-id> [flags]

Arguments

<task-id> (required)

The ID of the task to download logs for. You can find the task ID in the URL when viewing a task in the RWX UI.

Passing a top-level or "group" task ID (i.e. one with child tasks) will download a .zip file containing the logs for all child tasks.

Passing a "command" task ID (one without child tasks) will download a single .log file for that task.

Options

--output-file <path> or --output-dir <directory>

The path or directory to save the logs to. These two flags are mutually exclusive.

If not specified, the logs will be saved to your downloads directory.

--json

When specified, JSON will be emitted to stdout instead of plain text. The emitted JSON will be an array of locations of the output files, like so:

{
  "outputFiles": [
    "/Users/me/Downloads/task123.log",
    "/Users/me/Downloads/task456.log"
  ]
}

This can be helpful if you want to programmatically process the logs, as the output can easily be piped into jq, for example.

--auto-extract

When specified, if you have requested logs for a run or a group of tasks, the resulting .zip file will be automatically extracted to the directory you specified with --output-dir (defaulting to your downloads directory).

If you have requested logs for a single task, this flag will have no effect, as the original file will not be a .zip file.

--open

When specified, the CLI will automatically open the logs in your default application for viewing them.

In practice, while you certainly can combine the --open flag with --auto-extract, it may result in surprising behavior with .zip files (for entire runs or groups of tasks).

Consider the following examples:

  • rwx logs 123 --auto-extract --open will first auto-extract the .zip file and then open the contents in your default application. This could result in a larger-than-desired number of files being auto-opened.
  • rwx logs 123 --open will use your system's built-in default behavior for opening .zip files. On macOS, for example, this will extract and show the list of files in Finder.

In most cases, you likely want to either --auto-extract the .zip file and work with its contents programmatically, or pass --open to view the contents in your default application.