Skip to content

Get Started

Install

Python:

bash
pip install markback

Node.js:

bash
npm install markbackjs

Initialize Configuration

bash
mb --init

This creates a .env file with default configuration values.

First Lint

Create a tiny MarkBack file and save it as hello.mb:

mb
%markback 2

@id hello-001

Write a haiku about rain.
<<< good; clarity=high

Run the linter:

bash
mb --lint hello.mb

Minimal End-to-End Example

bash
# 1) Create a file
cat <<'MB' > prompt.mb
%markback 2

@id prompt-001

Write a haiku about programming.
<<< approved; tone=concise
MB

# 2) Lint it
mb --lint prompt.mb

# 3) Normalize to canonical form (in-place)
mb --normalize prompt.mb

# 4) List records
mb --list prompt.mb

# 5) Add feedback to a file via CLI
mb ./data/output.txt "approved; quality=high"

Next: read the format overview in MarkBack Format.