Skip to content
Blode.md

AI agents: fetch the documentation index at llms.txt. Markdown versions are available by appending .md to any page URL, including this page's markdown.

blodemd push

Deploy documentation to Blode.md.

Upload your documentation files and publish them to Blode.md in a single command.

blodemd push [dir]

Authenticate once with blodemd login first. The CLI uses your browser GitHub session for local deploys. For CI, use a project deploy key in BLODEMD_API_KEY — see Continuous deployment.

Directory resolution

If you omit the dir argument, the CLI searches for a docs.json file in these locations (in order):

  1. The current working directory
  2. ./docs
  3. ./apps/docs

If none contain a docs.json, the current directory is used.

Options

FieldTypeDescriptionRequiredDefault
[dir]stringPath to the docs directory containing docs.json.Yes—
--project <slug>stringProject slug. Falls back to the BLODEMD_PROJECT environment variable, then docs.json `slug`.Yes—
--api-key <token>stringProject deploy key for CI. Falls back to the BLODEMD_API_KEY environment variable, then stored credentials from `blodemd login`.Yes—
--api-url <url>stringAPI base URL.Yes"https://api.blode.md"
--branch <name>stringGit branch name attached to the deployment. Auto-detected from git if not provided.Yes"main"
--message <msg>stringDeploy message. Auto-detected from the latest git commit if not provided.Yes—

Deployment flow

When you run blodemd push, the CLI executes these steps:

Validate configuration

Reads and parses docs.json from the resolved docs directory.

Collect files

Recursively collects all files in the directory. Dotfiles and node_modules are skipped automatically.

Create deployment

Sends a request to the Blode.md API to create a new deployment record with the branch and commit message.

Upload files

Uploads files in batches of up to 4 MB each. Large documentation sets are split across multiple requests.

Finalize and promote

The CLI marks the deployment as complete and promotes it to production. Your docs are live immediately.

Auto-create projects

If the project slug does not match an existing project, the CLI prompts you to create one using your authenticated GitHub session.

Examples

blodemd push

Deploying from CI

Prefer not to run the CLI at all? Install the Blode.md GitHub App from the project Git tab in the dashboard. Pushes to your configured branch deploy automatically — no CLI, no tokens, no workflows. This is the recommended default.

To run the deploy yourself from GitHub Actions or another CI provider, use a project deploy key in BLODEMD_API_KEY. See Continuous deployment.

Skipped files

The CLI skips the following entries during file collection:

  • Files and directories starting with . (dotfiles)
  • The node_modules directory