Install

npm i -g deploylog

Node 18+ required. Installs two equivalent commands: deploylog and the short alias dpl.

Authenticate

Create an API key in your dashboard at deploylog.dev/dashboard/api-keys, then:

deploylog login --key dk_xxx

Credentials are stored with conf in your OS's standard config directory.

Quick start

# List your projects
deploylog projects

# Publish an entry
deploylog push \
  --project my-app \
  --title "Dark mode" \
  --body "Auto-detects system preference." \
  --type feature \
  --version 1.4.0 \
  --publish

Project config

Create a .deploylog.yml at your repo root so you don't have to pass --project every time:

project: my-app

Commands

deploylog login

Authenticate with an API key.

--key <key>       API key (starts with dk_)
--api-url <url>   API base URL (default: https://deploylog.dev)

deploylog logout

Remove stored credentials.

deploylog projects

List projects in your organization.

deploylog list

List recent entries for a project.

-p, --project <slug>   Project slug (or set in .deploylog.yml)

deploylog push

Create a new changelog entry.

-t, --title <title>       Entry title
-b, --body <markdown>     Entry body (Markdown)
-p, --project <slug>      Project slug (or set in .deploylog.yml)
-T, --type <type>         feature | fix | improvement | breaking | announcement
--version <version>       Semver (e.g. 1.2.3)
-P, --publish             Publish immediately
-D, --draft               Save as draft (default)
-g, --from-git            Derive title/body from commits since the last tag (alias: --git)
-a, --ai-summarize        Rewrite the entry with Claude Haiku (alias: --ai)
-y, --yes                 Skip interactive confirmation for AI-generated content

Recipes

Draft from recent commits:

deploylog push --from-git

Collects commits since the last git tag, formats them as a Markdown list, and opens the entry as a draft.

AI-polished release notes:

deploylog push --from-git --ai-summarize --version 1.4.0 --publish
# or, with short flags and the dpl alias:
dpl push -g -a --version 1.4.0 --publish

Uses Claude Haiku to rewrite your raw commits into user-friendly release notes. Free plan includes 5 AI summaries per month; paid plans are unlimited.

CI / GitHub Actions:

For CI workflows, prefer the official Action:

• deploylogdev/action on the GitHub Marketplace

Related

• Dashboard — deploylog.dev
• Widget — embeddable changelog widget at cdn.deploylog.dev
• GitHub Action — deploylogdev/action@v1

License

MIT © DeployLog