status

Displays an overview of the Unsterwerx data directory, including document counts, file types, similarity data, and classification totals.

Usage

bash

unsterwerx status [OPTIONS]
unsterwerx status <SUBCOMMAND>

Options

Option	Short	Type	Description
`--detailed`	`-d`	flag	Show a detailed breakdown by file type, similarity, and classification
`--document`		UUID	Show info for a specific document ID
`--json`		flag	Emit machine-readable JSON output

Subcommands

Subcommand	Description
`errors`	List all documents in error states (`error`, `image_only`)
`dismiss`	Mark a document as unrecoverable (transitions to `dismissed` status)

Examples

Basic status

bash

unsterwerx status

Unsterwerx Status
══════════════════════════════════════════
  Data directory:  /home/user/.unsterwerx
  Total documents:     2074
  Total size:        2.7 GB
  Indexed (FTS5):      1807
  Audit events:         148

  By Status:
    canonical          685
    classified        1122
    error              126
    unsupported        141

══════════════════════════════════════════

Detailed status

bash

unsterwerx status --detailed

Unsterwerx Status
══════════════════════════════════════════
  Data directory:  /home/user/.unsterwerx
  Total documents:     2074
  Total size:        2.7 GB
  Indexed (FTS5):      1807
  Audit events:         148

  By Status:
    canonical          685
    classified        1122
    error              126
    unsupported        141

  By File Type:
    pdf           879
    docx          492
    pptx          309
    txt           122
    xlsx          103
    doc            68
    ppt            62
    csv            28
    xls             9
    rtf             2

  Similarity:
    Candidate pairs:    371
    Exact dupes:         97

  Classification:
    Active rules:         6
    Classified docs:   1122
══════════════════════════════════════════

Single document info

bash

unsterwerx status --document a1b2c3d4-5678-9abc-def0-123456789abc

Document: a1b2c3d4-5678-9abc-def0-123456789abc
══════════════════════════════════════════
  Name:        Request-For-Order_v.92.docx
  Path:        /path/to/documents/Request-For-Order_v.92.docx
  Type:        docx
  Size:        67.4 KB
  Hash:        0b7cbd97ebd6376a
  Signed:      no
  Status:      canonical
  Retention:   anchor=2026-02-25 16:25:52
  Created:     2026-02-25 16:25:52
  Updated:     2026-02-25 16:25:52
══════════════════════════════════════════

List error documents

bash

unsterwerx status errors

Lists all documents in error or image_only status with their error details, so you can decide whether to retry or dismiss them.

Dismiss a document

bash

unsterwerx status dismiss <ID> [--reason <REASON>]

Marks a document as unrecoverable. Only documents in error or image_only status can be dismissed. Dismissed documents are excluded from search, scoring, and reconstruction.

Option	Short	Type	Default	Description
`--reason`		string	"Dismissed by user"	Reason for dismissal (recorded in audit log)

bash

unsterwerx status dismiss a1b2c3 --reason "Encrypted PDF, no password available"

Notes

The --document flag accepts a full UUID or a unique prefix (or filename).
When error documents exist, status prints hints for ingest --retry-errors and status dismiss.
Document statuses: canonical (extracted), classified (rules applied), error (parse failed), unsupported (no parser available), image_only (scanned PDF with no extractable text), deduplicated (removed by BI dedup), dismissed (marked unrecoverable by user).