Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

External Subcommands

You can extend mq with custom subcommands by placing executable files starting with mq- in ~/.local/bin/ or anywhere in your PATH.

Command Resolution

When you run mq <subcommand>, mq searches for an executable named mq-<subcommand> in the following order:

  1. ~/.local/bin/ directory
  2. Directories in PATH

The first match found is used.

Listing Available Subcommands

Use the --list flag to see all available subcommands:

mq --list

This makes it easy to add your own tools and workflows to mq without modifying the core binary.

External Tools

The following external tools are available to extend mq’s functionality:

  • mq-check - A syntax and semantic checker for mq files.
  • mq-conv - A CLI tool for converting various file formats to Markdown.
  • mq-crawler - A web crawler that extracts structured data from websites and outputs it in Markdown format.
  • mq-docs - A documentation generator for mq functions, macros, and selectors.
  • mq-edit - A terminal-based Markdown and code editor with WYSIWYG rendering and LSP support.
  • mq-http - A lightweight HTTP server that executes mq scripts for each request.
  • mq-lsp - Language Server Protocol (LSP) implementation for mq query files, providing IDE features like completion, hover, and diagnostics.
  • mq-mcp - Model Context Protocol (MCP) server implementation for AI assistants.
  • mq-open - Graphical previewer for mq.
  • mq-serve - A browser-based Markdown viewer with mq query support.
  • mq-task - Task runner using mq for Markdown-based task definitions.
  • mq-tui - Terminal User Interface (TUI) for interactive mq query.
  • mq-update - Update mq binary to the latest version.
  • mq-view - Viewer for Markdown content.

AI Assistant Integration

  • MCP: mq-mcp provides a Model Context Protocol server, enabling mq to be used from any MCP-compatible AI assistant.
  • Skill: The processing-markdown skill adds mq-aware assistance directly to your AI coding workflow.