CLI overview

Install and use the blodemd command-line interface.

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

Installation

Install

npm install -g blodemd

Requires Node.js 20 or later. The current version is 0.0.3.

Field	Type	Description	Required
`login`	command	Authenticate with Blode.md using browser OAuth or an API key.	Yes
`logout`	command	Remove stored credentials from your machine.	Yes
`whoami`	command	Show the current authentication status.	Yes
`init`	command	Scaffold a new documentation directory 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

Authenticate with browser OAuth or an API key.

All authentication state is stored locally at ~/.config/blodemd/credentials.json. The CLI never sends credentials to any third party.

You can configure the CLI with environment variables instead of flags. This is useful in CI/CD pipelines.

Field	Type	Description	Required	Default
`BLODEMD_API_KEY`	string	API key for authentication. Overrides stored credentials.	Yes	—
`BLODEMD_API_URL`	string	Override the API base URL.	Yes	https://api.blode.md
`BLODEMD_PROJECT`	string	Project slug. Overrides the name field in docs.json.	Yes	—
`BLODEMD_BRANCH`	string	Git branch name for the deployment.	Yes	—