Skip to main content

ephervex logs

Inspect launcher, client, and server logs and crash reports

Usage and options​

Inspect launcher, client, and server logs and crash reports

Usage: ephervex logs [OPTIONS] <COMMAND>

Commands:
  list    List the log or crash-report files that exist, newest first
  bundle  Collect diagnostics into one archive to attach to a bug report
  show    Print part of one log or crash report
  search  Find text in one log or crash report
  open    Open the folder holding these files in the desktop's file manager
  help    Print this message or the help of the given subcommand(s)

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex logs list​

List the log or crash-report files that exist, newest first

Usage: ephervex logs list [OPTIONS] <--instance <INSTANCE>|--server <SERVER>|--launcher>

Options:
      --instance <INSTANCE>  A client instance's own logs and crash reports
      --json                 Emit machine-readable JSON where the command supports it
      --server <SERVER>      A server's own logs and crash reports
      --launcher             Ephervex's own log
      --crash-reports        Work on crash reports rather than logs
  -h, --help                 Print help

ephervex logs bundle​

Collect diagnostics into one archive to attach to a bug report.

Nothing is uploaded: the archive is written where you say and goes no further than you take it.

Files go in exactly as they are on disk. A crash report that has been tidied is a crash report missing the line somebody needed, so Ephervex does not tidy one. What it guarantees instead is that it adds no secret of its own, and the configuration file is never included.

Without `--include`, everything on offer goes in. Run `ephervex logs bundle --list` to see what that is, then name the parts you want.

Usage: ephervex logs bundle [OPTIONS] <--instance <INSTANCE>|--server <SERVER>|--launcher>

Options:
      --instance <INSTANCE>
          A client instance's own logs and crash reports

      --json
          Emit machine-readable JSON where the command supports it

      --server <SERVER>
          A server's own logs and crash reports

      --launcher
          Ephervex's own log

      --output <FILE>
          Where to write the archive

      --include <NAME>
          Take only these parts, by the names `--list` prints. Repeatable

      --list
          Show what could go in, with what each part costs, and write nothing

  -h, --help
          Print help (see a summary with '-h')

ephervex logs show​

Print part of one log or crash report.

Logs are shown from their end and crash reports from their beginning, which is where each keeps the part worth reading first. Large files are read in a bounded window rather than whole.

Usage: ephervex logs show [OPTIONS] <--instance <INSTANCE>|--server <SERVER>|--launcher> <NAME>

Arguments:
  <NAME>
          The file name, as listed by `ephervex logs list`

Options:
      --instance <INSTANCE>
          A client instance's own logs and crash reports

      --json
          Emit machine-readable JSON where the command supports it

      --server <SERVER>
          A server's own logs and crash reports

      --launcher
          Ephervex's own log

      --crash-reports
          Work on crash reports rather than logs

      --head
          Read the beginning of the file rather than its end

      --bytes <BYTES>
          How many bytes to read

          [default: 524288]

      --path
          Print the file's full path instead of its contents

  -h, --help
          Print help (see a summary with '-h')
Find text in one log or crash report.

Reads the same bounded window `show` does and searches it. The file is never modified.

Usage: ephervex logs search [OPTIONS] <--instance <INSTANCE>|--server <SERVER>|--launcher> <NAME> <QUERY>

Arguments:
  <NAME>
          The file name, as listed by `ephervex logs list`

  <QUERY>
          The text to find

Options:
      --instance <INSTANCE>
          A client instance's own logs and crash reports

      --json
          Emit machine-readable JSON where the command supports it

      --server <SERVER>
          A server's own logs and crash reports

      --launcher
          Ephervex's own log

      --crash-reports
          Work on crash reports rather than logs

      --case-sensitive
          Match capitalization exactly

      --head
          Search the beginning of the file rather than its end

      --bytes <BYTES>
          How many bytes to search

          [default: 524288]

      --limit <LIMIT>
          Stop after this many matches

          [default: 500]

  -h, --help
          Print help (see a summary with '-h')

ephervex logs open​

Open the folder holding these files in the desktop's file manager

Usage: ephervex logs open [OPTIONS] <--instance <INSTANCE>|--server <SERVER>|--launcher>

Options:
      --instance <INSTANCE>  A client instance's own logs and crash reports
      --json                 Emit machine-readable JSON where the command supports it
      --server <SERVER>      A server's own logs and crash reports
      --launcher             Ephervex's own log
      --crash-reports        Work on crash reports rather than logs
      --print                Print the path without handing it to a file manager
  -h, --help                 Print help