Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Logs and bugs report

kater report draft

Has Kater write a bug report from your words, and shows it.

It sends nothing. Use it in a script or through an agent, then send the report with kater report send.

Examples

Terminal window
# Have Kater write a report from your words, and show it
kater report draft "The chart sorts months in alphabetical order."
# Say that the bug stops your work, and put your name in the changelog
kater report draft "The chart sorts months in alphabetical order." --impact stops --credit
# Keep the report in a file, to send it later
kater report draft "The chart sorts months in alphabetical order." --json > report.json
# Show a report that you wrote yourself in bug.json
kater report draft --request-file bug.json

Arguments

ArgumentDescription
<words>Optional. The bug in your own words. Kater writes the report from them. Give one or more.

Options

OptionDescription
--request-file <file>The report as JSON. Give words for Kater to write it from. Or give title and what_happened, and expected, steps and agent_findings if you have them, as you or your agent wrote them. It can also hold impact, share, credit, the page_urls that the bug is on, and the queries that ran, each {what, request_id}. Give - to read stdin.
--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.

What it shows

It shows the report, what it attaches, and the reports that other teams shared that look the same. To add your team to one of them in place of a new report, run kater report me-too. With --json, the answer’s request is what kater report send takes.

  • Words or a file. Give the words or --request-file, not both.
  • What it attaches. In your terminal, the last kater command, its exit code, the CLI version and the OS. Through an agent, the Kater tab you have open and where it comes from.
  • When Kater cannot write it. Write the report yourself, and give its title and what_happened in --request-file.

See also