AugmentClaude
BackendDevOps

OpenKnowledge Bug Report

By inkeep· inkeep/open-knowledge· 0

Capture diagnostic information and file bug reports for OpenKnowledge issues.

Installation

  1. Make sure Claude is on your device and in your terminal.

    Skills load from ~/.claude/skills/ when Claude Code starts up — so you need it on your machine first. If you don't have it yet, install it once with the command below, then run claude in any terminal to verify.

    One-time setup
    npm i -g @anthropic-ai/claude-code

    Already have it? Skip ahead.

  2. Paste into Claude Code or into your terminal.
    Install
    Sign up to copy
    Sign up free to reveal

    This copies the whole skill folder into ~/.claude/skills/open-knowledge-bug-report-inkeep/ — the SKILL.md plus any scripts, reference docs, or templates the skill ships with. Safe default: works for every skill.

    Faster alternative (instruction-only skills)

    Skips the clone and grabs only the SKILL.md file. Don't use this if the skill ships Python scripts, reference markdowns, or asset templates — they won't be downloaded and the skill will fail when it tries to load them.

    Quick install (SKILL.md only)
    Sign up to copy
    Sign up free to reveal
  3. Restart Claude Code.

    Quit and reopen Claude Code (or any other agent that loads from ~/.claude/skills/). New skills are picked up on startup.

  4. Just ask Claude.

    Skills auto-activate when your request matches the skill's description — no slash command needed. Trigger phrases live in the skill's own frontmatter; you can read them in the “What this skill does” section above.

Prefer to read the source first? Open on GitHub.

When Claude uses it

Use when the user reports a problem with OpenKnowledge, asks for help debugging OK, or wants to file a bug report. This skill guides the agent to capture diagnostic information via the ok bug-report CLI command.

What this skill does

Bug Report — agent guidance

When a user reports a problem with OpenKnowledge or asks for debugging help, use the ok bug-report command to capture a structured diagnostic bundle.

Quick path

ok bug-report --no-reveal

The --no-reveal flag suppresses the Finder reveal (use it when running as an agent — you want the file path, not a Finder window).

What the command does

  1. Gathers all structured log files from ~/.ok/logs/ (NDJSON format, pino)
  2. When invoked inside an OK project directory, filters logs to that project's records
  3. Collects system info: OK version, Node/Bun versions, macOS version, locale, timezone, free disk space
  4. Collects lock directory contents (server.lock, spawn-error-log) when a project context exists
  5. Extracts recent IPC error records from desktop logs
  6. Runs an auto-redaction pass over all content (home paths, API tokens, credentials are scrubbed)
  7. Writes ~/.ok/bug-reports/<timestamp>-bugreport.zip
  8. Prints the bundle path to stdout

What's in the bundle

<timestamp>-bugreport.zip
├── MANIFEST.json       — what's inside, redaction audit report
├── sysinfo.json        — versions, locale, disk, build channel
├── README.md           — what's safe to share, discipline version
├── logs/               — NDJSON log files (auto-redacted)
├── lockdir/            — server.lock, spawn-error-log (if project)
└── recent-ipc-errors.json — last 50 structured IPC errors

Agent workflow

  1. Run ok bug-report --no-reveal in the user's project directory (or home if no project)
  2. Read the path from stdout
  3. Unzip to a temp directory: unzip -o <path> -d /tmp/ok-diag-<timestamp>/
  4. Read MANIFEST.json — check the redactions array (if non-empty, some content was scrubbed)
  5. Read sysinfo.json — check versions, disk space, build channel
  6. Grep the log files for errors: grep '"level":50' logs/*.log | head -20 (level 50 = error in pino)
  7. Read recent-ipc-errors.json for IPC-layer failures
  8. Report findings to the user with actionable next steps

If the command is not available

The ok bug-report command ships with @inkeep/open-knowledge >= 0.7.0. If the user's version is older:

  1. Check version: ok --version
  2. If < 0.7.0: suggest npm install -g @inkeep/open-knowledge@latest to update
  3. Fallback: manually inspect ~/.ok/logs/ for recent .log files (NDJSON format, greppable)

Privacy

The bundle auto-redacts:

  • macOS home paths (/Users/<name>/ → ~/)
  • GitHub PAT prefixes (ghp_, gho_, ghu_, ghs_, ghr_)
  • AWS access keys, Anthropic tokens, OpenAI tokens
  • Bearer authorization headers

The MANIFEST.json redactions array lists every file and pattern that was scrubbed. The bundle is safe for the user to attach to a GitHub issue.

Related skills

G

Generative Code Art

anthropics

Create algorithmic art with p5.js using randomness and interactive parameters.

OfficialComplete terms in LICENSE.txt
P

Poster & Visual Design

anthropics

Create original posters and visual art in PNG and PDF formats.

OfficialComplete terms in LICENSE.txt
C

Claude API Helper

anthropics

Build, debug, and optimize Claude API applications with caching and model migration support.

OfficialComplete terms in LICENSE.txt
M

MCP Server Builder

anthropics

Build protocol servers that connect language models to external APIs and services.

OfficialComplete terms in LICENSE.txt