blodemd validate

Validate your docs.json configuration file.

Check that your docs.json file is valid JSON and can be parsed by the CLI before deploying.

blodemd validate [dir]

Directory resolution

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

The current working directory
./docs
./apps/docs

Options

Field	Type	Description	Required
`[dir]`	string	Path to the docs directory containing docs.json.	Yes

Examples

blodemd validate

Successful output

$ blodemd validate
~ docs.json is valid.
i Done

Use in CI

Add a validation step to your CI pipeline to catch configuration errors before deployment.

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm install -g blodemd
      - run: blodemd validate docs
      - run: blodemd push docs
        env:
          BLODEMD_API_KEY:

Running blodemd push also validates docs.json as its first step. A standalone validate step is useful when you want to fail fast in CI without needing authentication.