Chukke documentation

Getting Started

Open a workspace or individual document and learn Chukke’s core local-first workflow.

Chukke 1.0 is a macOS app for developers who maintain prompts and technical documentation in plain Markdown. It targets macOS 14 or later on Apple Silicon and Intel Macs.

Open a workspace or file

Use a workspace when you want Chukke’s complete repo-native workflow:

  1. Launch Chukke and choose Open Workspace.
  2. Select a folder containing your Markdown or text documents.
  3. Open a file from the workspace tree, or create a new file or folder.

Chukke works directly with .md, .markdown, and .txt files in the folder you select. The workspace stays in its existing location and remains usable with Git, Finder, editors, and other tools.

To work with one existing document without opening its folder as a workspace, choose Open File…, use File > Open Recent > Files, or choose Chukke through Finder’s Open With menu. The file remains at its original location. Open Editors includes both workspace and individually opened documents, while the workspace tree continues to show only workspace content.

Edit and preview

Use Edit, Split, or Preview from the document toolbar. Formatting controls edit the underlying Markdown syntax rather than introducing a separate rich-text format.

Preview supports common Markdown, tables, task lists, syntax-highlighted code blocks, and Mermaid diagrams. The Outline panel gives you heading-based navigation.

Save your work

Chukke uses atomic file writes and reports save conflicts instead of silently overwriting external changes. Workspace documents receive bounded local history before a content-changing save. Individually opened files do not receive Chukke history or a recovery copy, so keep an appropriate backup for important files.

Run Model-ready

Open Model-ready for the active document to run deterministic local checks. Review the score and findings, compare Source, Prepared, and Diff views, then apply only the changes you want.

Model-ready uses deterministic local checks. It does not use AI or send the document to a model provider.

Optional provider assistance

Assist is disabled until you enable it. Before an Assist action sends document content, Chukke shows the provider, endpoint, model, source scope, and exact Markdown payload for your confirmation. The separate Settings connection test sends a short provider check without document content. Non-local API keys remain in memory for the current app session only.

Next, learn how workspaces and files are handled.