/

For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quarkdown

2.5.1

Docs

On this page

CLI - Doctor

quarkdown doctor groups commands that report information about the current Quarkdown installation.

doctor env

quarkdown doctor env reports the status of the external runtimes Quarkdown depends on: the JVM, Node.js, and Puppeteer (required for PDF export).

quarkdown doctor env

doctor get

The get subgroup exposes single-value getters that print one piece of information to standard output, one per line. This makes them well suited for shell substitution.

install-dir

quarkdown doctor get install-dir prints the absolute path of the Quarkdown install directory: the root of the distribution layout that contains bin/, lib/, and docs/.

quarkdown doctor get install-dir

A common use is to locate bundled resources from a shell script, without resolving the binary path manually:

INSTALL="$(quarkdown doctor get install-dir)"
ls "$INSTALL/docs"

agent-skill

quarkdown doctor get agent-skill prints the absolute path of the bundled agent skill directory, which contains the SKILL.md entrypoint that AI agent tools can read or symlink.

quarkdown doctor get agent-skill

See Use with AI agents for installation instructions.