backlog-cli

backlog-cli は Nulab Backlog の課題・ドキュメント・プロジェクトをターミナルから操作する CLI ツールです。setup / profile による接続情報管理と、issue / document / project / whoami による日常操作を一貫したフローで提供します。

Table of contents

• Overview
• Features
• Installation
  • Install globally
  • Run with npx
  • Run from source
• Quick start
• Profiles
• Environment variables
• Authentication check
• Credential precedence
• Usage
  • Issue commands
  • Document commands
  • Project commands
  • Profile commands
• Development
• License

Overview

backlog-cli は Backlog の API をシンプルに扱うための CLI です。初回は backlog setup で接続情報を保存し、その後は backlog issue ...、backlog document ...、backlog project ... をそのまま実行できます。複数スペースを扱う場合も profile で切り替えできます。

Features

• 課題の一覧取得・詳細確認・作成・更新・削除・コメント操作
• ドキュメントの一覧取得・本文確認
• プロジェクト一覧取得・詳細確認
• setup / profile による複数スペース管理
• whoami による接続確認
• フラグ / プロファイル / 環境変数の優先順位による資格情報解決

Installation

Install globally

npm install -g @niiiiiiile/iw-backlog-cli

Run with npx

npx @niiiiiiile/iw-backlog-cli --help
npx @niiiiiiile/iw-backlog-cli issue list

Run from source

git clone https://github.com/Niiiiile/backlog-cli.git
cd backlog-cli
npm install
npm run dev -- --help

Quick start

backlog setup \
  --url https://yourspace.backlog.com \
  --api-key YOUR_API_KEY \
  --project-key MYPROJECT

初回登録時は default プロファイルに保存され、自動でデフォルトになります。

Profiles

複数スペースを使い分ける場合は profile を使います。

# work プロファイルを追加
backlog profile add work \
  --url https://yourspace.backlog.com \
  --api-key YOUR_API_KEY \
  --project-key MYPROJECT

# プロファイル一覧
backlog profile list

# デフォルト切り替え
backlog profile use work

# 実行時だけ別プロファイルを使う
backlog issue list --profile work

Environment variables

.env.example を参考に環境変数を設定することもできます。

export BACKLOG_BASE_URL=https://yourspace.backlog.com
export BACKLOG_API_KEY=your_api_key_here
export BACKLOG_PROJECT_KEY=MYPROJECT

Authentication check

backlog whoami

Credential precedence

1. コマンドフラグ（--url, --api-key, --project-key）
2. 設定ファイルのプロファイル（--profile または default）
3. 環境変数（BACKLOG_BASE_URL, BACKLOG_API_KEY, BACKLOG_PROJECT_KEY）

Usage

backlog --help

Issue commands

| サブコマンド | 説明 | |---|---| | list | 課題の一覧を取得（キーワード・ステータス・担当者でフィルタ可） | | get <issueIdOrKey> | 課題の詳細を取得 | | add | 課題を作成 | | update <issueIdOrKey> | 課題を更新（ステータス変更・コメント追加など） | | delete <issueIdOrKey> | 課題を削除 | | comments <issueIdOrKey> | コメント一覧を取得 | | comment-add <issueIdOrKey> <content> | コメントを追加 |

# 最新20件を取得
backlog issue list

# キーワード検索
backlog issue list --keyword バグ

# 未対応・処理中のみ
backlog issue list --status-id 1,2

# 課題の詳細
backlog issue get PROJ-123

# 課題を作成
backlog issue add --summary "画面表示のバグ" --issue-type-id 2 --priority-id 2

# ステータスを完了に変更しコメントを追加
backlog issue update PROJ-123 --status-id 4 --comment "対応完了"

# コメント一覧
backlog issue comments PROJ-123

Document commands

Backlog のドキュメント機能から、プロジェクト内のドキュメント一覧と本文を取得できます。

| サブコマンド | 説明 | |---|---| | list | プロジェクト内ドキュメントの一覧を取得（キーワード検索可） | | get <documentIdOrUrl> | ドキュメントの詳細を取得（本文は plain / json） |

# 最新20件を取得
backlog document list

# キーワード検索
backlog document list --keyword 手順

# ドキュメント URL から詳細を取得
backlog document get https://yourspace.backlog.com/document/MYPROJECT/019d897d557b77d6a6dcda7ecb857ec7

Project commands

| サブコマンド | 説明 | |---|---| | list | 参加しているプロジェクトの一覧を取得 | | get <projectIdOrKey> | プロジェクトの詳細を取得 |

backlog project list
backlog project get MYPROJECT

Profile commands

| サブコマンド | 説明 | |---|---| | list | 登録済みプロファイルの一覧を表示 | | add <name> | プロファイルを追加・更新 | | remove <name> | プロファイルを削除 | | use <name> | デフォルトプロファイルを変更 |

backlog profile add personal --url https://myspace.backlog.jp --api-key KEY2 --project-key MYPROJ

# プロファイル一覧
backlog profile list

Development

# 依存関係のインストール
npm install

# TypeScript のビルド
npm run build

# ビルドなしで直接実行
npm run dev -- --help

ライセンス

MIT