MarkForge

English | Русский | العربية | Français

Cross-platform command-line application for database-driven document generation.

Supported platforms:

• Windows x64
• Linux x64
• macOS (Intel and Apple Silicon)

---

Installation

Download a Release Build

Download the latest binary from the project's GitHub Releases page.

Linux / macOS

Make the binary executable:

chmod +x markforge

Run:

./markforge --help

Windows

Run from PowerShell or Command Prompt:

.\markforge.exe --help

---

Quick Start

Create a demo database:

markforge db --init --template students

List available tables:

markforge db --list

Show records:

markforge data --show students

Generate documents:

markforge generate --source students --template invitation

---

Command Reference

General Commands

Show Help

Display application description, version information, and available commands.

markforge --help

Show Version

Display application version.

markforge --version

---

Database Commands

Initialize Database

Interactive initialization:

markforge db --init

Show available templates:

markforge db --init --templates

Create a database using a predefined template:

markforge db --init --template employees

markforge db --init --template students

Remove Tables

Remove a table:

markforge db --drop <table_name>

Remove all tables:

markforge db --drop --all

List Tables

User tables only:

markforge db --list

All tables:

markforge db --list --all

Show Table Schema

markforge db --schema-show <table_name>

---

Data Commands

Show Records

Interactive mode:

markforge data --show

Show records from a specific table:

markforge data --show <table_name>

---

Template Commands

List Templates

markforge template --list

Show Template

markforge template --show <template_name>

Register Template

TXT, Markdown, and DOCX templates can be registered for later use.

markforge template --add <path/to/template.docx> -as <template_name>

Remove Template

markforge template --remove <template_name>

---

Document Generation

Generate documents using a table as the data source and a registered template.

Generate for Selected Records

markforge generate --source <table_name> --template <template_name>

Custom Output Directory

markforge generate --source <table_name> --template <template_name> --output <path/to/output>

---

Supported Template Formats

Currently supported:

• TXT
• Markdown (.md)
• DOCX
• XLS
• XLSX

Planned support:

• PDF import
• ODT
• HTML

---

Example Workflow

markforge db --init --template students
markforge db --list
markforge data --show students
markforge template --list
markforge generate --source students --template invitation

---

License

Academic course work project.