bklg

Backlog (backlog.jp / backlog.com) API v2 thin wrapper CLI. It aims to make issues and wiki pages easy to work with from terminals and editors.

• Japanese README: README-ja.md

Features

• View/search issues and post comments from the CLI
• Switch output with --format md|json|text
• Keep a thin mapping to Backlog API resources
• Store auth locally, override with environment variables

Installation

npm (global)

npm i -g bklg

npx

npx bklg --help

Quick Start

1) Set space and API key

Generate an API key in Backlog personal settings, then run:

bklg auth login --space your-space --api-key YOUR_API_KEY

Or use environment variables (CI or short-lived usage):

export BACKLOG_SPACE=your-space
export BACKLOG_API_KEY=YOUR_API_KEY

2) View an issue

bklg issue view PROJ-123 --format md

3) Post a comment

bklg issue writeComment PROJ-123 -m "Please review the fix."

Practical Examples

• Check auth status

  bklg auth status --format md

• Search issues (projectId/statusId are numeric)

  bklg issue search --project 123 --status 1 --assignee me --keyword "login" --format text

• List comments

  bklg issue comments PROJ-123 --format md

• Post a comment from a file

  bklg issue writeComment PROJ-123 --message-file ./comment.md --notify 1001,1002

• View a wiki page (project key or id)

  bklg wiki view "Wiki Page" --project PROJ --format md

Main Commands

• bklg auth login / bklg auth status / bklg auth logout
• bklg issue view <issueKeyOrId>
• bklg issue search [--project <projectId>] [--assignee me] [--status <statusId>] [--keyword "..."]
• bklg issue writeComment <issueKeyOrId> -m "..." [--notify userId,...] [--dry-run]
• bklg issue comments <issueKeyOrId>
• bklg wiki view <pageName> --project <projectKeyOrId>

See docs/spec.md for the full CLI spec.

Configuration

Priority order (highest first):

1. CLI args
2. Env vars (BACKLOG_SPACE, BACKLOG_API_KEY, BACKLOG_HOST)
3. Config file (~/.config/bklg/config.json)

bklg auth login creates the config file.

Security Notes

• API keys are sensitive. Do not share them.
• Prefer env vars in CI.

Development

Requirements

• Node.js (LTS recommended)
• npm

Setup

npm ci
npm run build
npm test

Local run

npm run build
node dist/cli/index.js issue view PROJ-123 --format md

License

MIT License

Disclaimer

Unofficial tool. Behavior may change if Backlog API changes.