Walkmark
Docs Download

Documentation

Overview

Using Walkmark

Getting startedRecordingEditing guidesSettingsAI writingLocal modelsExportKeyboard shortcutsTroubleshootingPrivacy and data

Open source

Build from sourceArchitecture

Walkmark documentation

How to use the open source Walkmark app: record a workflow, run AI writing, export your guide. Plus notes for building from source and contributing.

Using Walkmark

  • Getting started

    Install, permissions, library, first recording, and writing.

  • Recording

    Sources, HUD, step detection, manual marks, and recording settings.

  • Editing guides

    Reorder, merge, exclude, annotations, alternates, and locked steps.

  • Settings

    Models, writing voice, recording preferences, and appearance.

  • AI writing

    Two-pass writing, providers, API keys, concurrency, and tips.

  • Local models

    Ollama, LM Studio, and OpenAI-compatible servers on your hardware.

  • Export

    Markdown, HTML, and PDF: options and what gets included.

  • Keyboard shortcuts

    Main window, global recording, selection, and image editor.

  • Troubleshooting

    Permissions, capture, AI errors, local models, and export.

  • Privacy and data

    What stays local, when cloud is used, and how keys are stored.

Open source

  • Build from source

    Prerequisites, dev run, release builds, tests, and layout.

  • Architecture

    Tauri modules, IPC, capture and AI pipelines, adding providers.

  • Contributing

    PR workflow, tests, and code style on GitHub.

Download Walkmark from walkmark.app or GitHub Releases.