Skip to main content

installation

the declared-md CLI is a Node.js package. you can use it without installing via npx, or install it globally.

prerequisites​

  • Node.js 18 or later
  • npm, yarn, or pnpm

no installation required. run any command directly:

npx declared-md init whoami
npx declared-md validate ./whoami.md
npx declared-md preview ./whoami.md

global install​

npm install -g declared-md

then run without npx:

declared-md init whoami
declared-md validate ./whoami.md
declared-md preview

next step​

create your first whoami.md