cluvo-custom-config

Cluvo Custom Config

Tune new Reporter() configuration to match your project's needs.

Prerequisites

Search for new Reporter( in the codebase. If not found:

Cluvo is not set up yet. Run /cluvo-setup first.

Then stop.

Steps

1. Read current config

Find the new Reporter(...) call and display the current configuration to the user.

2. Ask what to customize

Present the available config areas:

Area	What it controls
Preset	Environment preset: 'cli' or 'sdk' (sets defaults for interactive, argv, sections, presenter)
Presenter	Custom presenter adapter for TUI apps, or null to disable interactive prompts
Child Policy	Nested reporter behavior: 'absorb', 'passthrough', or 'silent'
Sanitize	Custom regex rules to mask project-specific secrets
Issue	Labels, title format, markdown sections, issue template
Dedupe	Duplicate issue search on/off, include GitHub Discussions
Store	Local report persistence on/off, max report count
Collect	What data to collect: argv, diagnostic report, envinfo
Mode	How to publish: browser, gh CLI, GitHub API, or file
Non-interactive	Behavior in non-TTY: save, log, or silent
Prompt	Custom prompt messages
Branding	Show/hide Cluvo name in output

Ask the user which area(s) they want to configure.

3. Apply configuration

Modify the new Reporter() config object based on user choices. Below are patterns for each area.

Preset

preset: 'cli'  // 'cli' | 'sdk'

Preset	Interactive	Argv	Sections	Presenter
'cli' (default)	'auto'	Yes	Includes command	TerminalPresenter
'sdk'	'never'	No	Excludes command	null

Preset values serve as defaults. Any explicit config overrides them.

Presenter: Custom Adapter

import type { PresenterAdapter, PromptContext, PresenterAction } from '@cluvo/core'

class MyPresenter implements PresenterAdapter {
  async prompt(context: PromptContext): Promise<PresenterAction | null> {
    // Show custom UI, return user action
    return { type: 'cancel' }
  }
}

const cluvo = new Reporter({
  // ...
  presenter: new MyPresenter(),
})

Set presenter: null to disable interactive prompts entirely (non-interactive fallback only).

Child Policy: Nested Reporters

childPolicy: 'absorb'  // 'absorb' | 'passthrough' | 'silent'

Policy	Behavior
absorb	Child forwards report to parent's presenter. Child still stores locally.
passthrough (default)	Child handles its own prompt normally.
silent	Child stores only, no prompt.

Sanitize: Custom Rules

Add custom SanitizeRule entries to catch project-specific secrets:

const cluvo = new Reporter({
  repo: 'owner/repo',
  app: { name: 'my-cli', version: '1.0.0' },
  sanitize: {
    enabled: true,
    customRules: [
      {
        name: 'internal-api-url',
        pattern: /https:\/\/internal\.company\.com\/[^\s]*/g,
        replacement: '[INTERNAL_URL]',
      },
      {
        name: 'custom-token',
        pattern: /myapp_[A-Za-z0-9]{32}/g,
        replacement: '[MYAPP_TOKEN]',
      },
    ],
  },
})

Note: Sensitive CLI argv (e.g., --token, --password) are sanitized by a separate mechanism (ARGV_SENSITIVE_FLAGS) independent of SanitizeRule pipeline.

Issue: Labels, Title, Sections

const cluvo = new Reporter({
  // ...
  issue: {
    labels: ['bug', 'cluvo-report', 'needs-triage'],
    title: (ctx) => `[${ctx.command ?? 'unknown'}] ${ctx.error.name}: ${ctx.error.message}`,
    sections: ['summary', 'environment', 'stackTrace', 'sanitizedNotice'],
    // template: 'bug_report'  // GitHub issue template name
  },
})

Available sections: summary, environment, command, stackTrace, causeChain, sanitizedNotice

Title callback receives { command?: string, error: ErrorPayload } where ErrorPayload has name, message, stack, cause?.

Dedupe

dedupe: {
  enabled: true,           // Search GitHub for similar issues before submitting
  searchDiscussions: false, // Also search GitHub Discussions
}

Store

store: {
  enabled: true,    // Persist reports to ~/.cluvo/reports/<app>/
  maxReports: 50,   // Auto-evict oldest when exceeded (default: 100)
}

Collect

collect: {
  argv: true,              // Capture CLI arguments (sanitized)
  diagnosticReport: false, // Capture heap memory stats
  envinfo: true,           // Capture OS, arch, Node version, etc.
}

Mode

mode: 'browser'  // 'browser' | 'gh' | 'api' | 'file'

Mode	Behavior
browser	Open GitHub new issue form in browser (default)
gh	Use gh issue create CLI command
api	Direct GitHub REST API (requires token)
file	Export to markdown file

Non-interactive

interactive: 'auto',       // 'auto' (detect TTY) or 'never'
nonInteractive: 'save',    // 'save' | 'log' | 'silent'

Prompt

prompt: {
  message: 'An error occurred. Would you like to report it?',
  detailMessage: 'Press v to view the full report.',
}

Branding

branding: {
  showName: false,  // Show/hide "Cluvo" name in output (default: false)
}

4. Completion message

Configuration updated. Your Cluvo reporter is now customized for this project.

Full ReporterConfig Reference

Read references/config-reference.md for the full ReporterConfig interface, SanitizeRule type, and built-in sanitize rules table.