コンテンツにスキップ
Backlog CLI Backlog CLI

はじめに

bee は、Backlog をターミナルから操作するためのコマンドラインツールです。課題の管理、プルリクエスト、ドキュメント、通知など、Backlog の主要な機能をコマンドラインから利用できます。

前提条件

Section titled “前提条件”
  • Node.js 20.18 以上

Node.js のバージョンを確認するには、以下のコマンドを実行します。

Terminal window
node --version

インストール

Section titled “インストール”
Terminal window
npm install -g @nulab/bee

バージョンを確認してインストールが成功したことを確認します。

Terminal window
bee --version

クイックスタート

Section titled “クイックスタート”

  1. ログイン

    Backlog スペースにログインします。対話形式でスペースのホスト名と API キーの入力を求められます。

    Terminal window
    bee auth login

  2. 課題を一覧表示する

    プロジェクトの課題を一覧表示してみましょう。YOUR_PROJECT の部分は、Backlog のプロジェクト設定で確認できるプロジェクトキー（例: MY_PROJECT、FRONTEND）に置き換えてください。

    Terminal window
    bee issue list --project YOUR_PROJECT

  3. 課題を作成する

    対話形式で新しい課題を作成します。プロジェクト、課題種別、優先度などを順番に選択できます。

    Terminal window
    bee issue create

    フラグを指定して非対話的に作成することもできます。

    Terminal window
    bee issue create --summary "最初の課題" --issue-type Bug --priority High

アンインストール

Section titled “アンインストール”

インストール時に使用したパッケージマネージャに合わせてアンインストールしてください。

Terminal window
npm uninstall -g @nulab/bee

次のステップ

Section titled “次のステップ”
🔑 認証 OAuth や API キーなど、認証方法の詳細を確認する
⚙️ 環境変数 環境変数でデフォルトのプロジェクトなどを設定する
🔄 CI/CD GitHub Actions などの CI/CD パイプラインとの連携
🤖 AI エージェント Claude Code や GitHub Copilot など AI エージェントとの連携