Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Logs and bugs report

kater report

Reports a bug in Kater, and follows it to the fix.

Run kater report alone and describe the bug in your own words, and Kater writes the report. Kater shows you the report, and it sends nothing until you say yes. Each report command needs kater login. See Report a bug.

Commands

CommandWhat it does
kater report draftHave Kater write a report, and show it. Sends nothing.
kater report sendSend a report to Kater, after you say yes.
kater report showSee a report’s status, check and activity.
kater report listList your bug reports.
kater report me-tooAdd your team to a report another team shared, or remove it.

Examples

Terminal window
# Describe a bug at the prompts, then check the report before Kater sends it
kater report
# Have Kater write a report from your words, and send nothing
kater report draft "The chart sorts months in alphabetical order."
# List your bug reports
kater report list
# See a report's status and activity
kater report show 1042

Options

OptionDescription
--impact <level>How much the bug stops your work: stops, workaround or small. Kater starts on workaround.
--no-share, --shareShows, or does not show, the report’s title and status to other Kater teams, who can add a Me too. Kater starts on --share. Your organization’s settings can decide for you.
--creditPuts your name in the changelog when Kater fixes the bug.
--no-contextAttaches nothing: not the last command, its exit code, the CLI version or the OS.

It also takes the global options --json and --help.

How kater report works

  1. Type the bug at the prompt. To finish, press Enter on an empty line.
  2. Kater writes the report. This can take up to a minute. When Kater cannot write it, you can write it yourself at the prompts.
  3. Kater shows the report and what it attaches.
  4. When a report that another team shared looks the same, Kater asks whether to add your team to it instead.
  5. Kater asks before it sends the report. It sends only when you answer y.

Without a terminal, such as in a script, kater report reads the words from stdin. It shows the report and sends nothing. In the Files terminal or through an agent, use kater report draft.

What Kater attaches

In your own terminal, Kater attaches the last kater command that you ran in the last day, and its exit code. It keeps only the command’s words and option names, never a value. It also attaches the CLI version and the OS. Through an agent, it attaches the Kater tab you have open and where the report comes from. It also attaches the queries that the agent ran. Kater never attaches file contents, rows, credentials or tokens.

Report statuses

A report is Sent, Reproduced, Fix in progress, Fixed or Closed. An open report is a report in any status before Fixed.

Options

kater report alone takes these options. kater report draft takes them too.

See also