> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blode.md/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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

```bash
npm i -g blodemd
```

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

## Commands

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

## Command reference

  ### [blodemd login](/cli/login)

Sign in with GitHub in your browser.
  ### [blodemd new](/cli/new)

Create a docs directory with starter files.
  ### [blodemd push](/cli/push)

Deploy your documentation to Blode.md.
  ### [blodemd dev](/cli/dev)

Run a local dev server with live reload.
  ### [blodemd validate](/cli/validate)

Validate your docs.json before deploying.

## Global behavior

### Credentials

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

### Environment variables

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

- `BLODEMD_API_URL` (type: string, default: https://api.blode.md): Override the API base URL.
- `BLODEMD_PROJECT` (type: string): Project slug. Overrides docs.json `slug`.
- `BLODEMD_BRANCH` (type: string): Git branch name for the deployment.
- `BLODEMD_COMMIT_MESSAGE` (type: string): Commit message attached to the deployment.