QUICKSTART-USER.adoc

pandoc-k9 — Quick Start for Users

Table of Contents

• What is pandoc-k9?
• Prerequisites
• Install
  • Option 1: Standard Install (recommended)
  • Option 2: Container (via Stapeln)
  • Option 3: Portable (no system changes)
• First Run
• Self-Diagnostic
• Get Help
• Uninstall
• Next Steps

What is pandoc-k9?

Pandoc K9 — See README.adoc for details.

Prerequisites

Before you begin, ensure you have:

• just — task runner (install guide)

• Platform-specific requirements listed below

Platform	Additional Requirements
Linux	See README.adoc
macOS	See README.adoc
Windows	See README.adoc

Install

Option 1: Standard Install (recommended)

# Clone and set up
git clone https://github.com/hyperpolymath/pandoc-k9.git
cd pandoc-k9
just setup

The setup script will:

• Detect your platform and shell

• Install missing dependencies (with your permission)

• Configure the application

• Offer install location choices

• Run a self-diagnostic to verify everything works

Option 2: Container (via Stapeln)

just stapeln-run

Option 3: Portable (no system changes)

just install --portable --prefix=./pandoc-k9-portable

First Run

just run

Expected output:

Pandoc K9 started successfully.

Self-Diagnostic

If something isn’t working:

just doctor

This checks all dependencies, permissions, paths, and connectivity. If it finds issues, it will suggest fixes.

To attempt automatic repair:

just heal

Get Help

• In-app: just run --help

• Guided tour: just tour

• Report a problem: just help-me (pre-fills diagnostic context)

• Wiki: https://github.com/hyperpolymath/pandoc-k9/wiki

Uninstall

just uninstall

You will be asked:

1. Which uninstall tier (Bennett reversible, parameter-based, standard, or secure)

2. Whether to include or exclude your data

3. Whether to clear caches and LLM models

Next Steps

• Read the README for full feature overview

• Read the EXPLAINME for architecture and design decisions

• Try just tour for a guided walkthrough