CLI overview

Install and use the blodemd command-line interface.

The blodemd CLI lets you authenticate, create, validate, preview, and deploy documentation from your terminal.

Installation

Install

npm i -g blodemd

Requires Node.js 24.x. The current version is 0.0.8.

Field	Type	Description	Required
`login`	command	Authenticate with Blode.md via GitHub in your browser.	Yes
`logout`	command	Remove stored credentials from your machine.	Yes
`whoami`	command	Show the current authentication status.	Yes
`new`	command	Create a new documentation site with a starter docs.json and index page.	Yes
`validate`	command	Validate your docs.json configuration file against the schema.	Yes
`push`	command	Deploy documentation to Blode.md.	Yes
`dev`	command	Start a local development server for real-time preview.	Yes

Create a docs directory with starter files.

Deploy your documentation to Blode.md.

Run a local dev server with live reload.

Validate your docs.json before deploying.

The CLI stores all authentication state at ~/.config/blodemd/credentials.json and never sends credentials to any third party.

You can configure the CLI with environment variables instead of flags.

Field	Type	Description	Required	Default
`BLODEMD_API_URL`	string	Override the API base URL.	Yes	https://api.blode.md
`BLODEMD_PROJECT`	string	Project slug. Overrides docs.json `slug`.	Yes	—
`BLODEMD_BRANCH`	string	Git branch name for the deployment.	Yes	—
`BLODEMD_COMMIT_MESSAGE`	string	Commit message attached to the deployment.	Yes	—