jira-cli は何をしますか？
開発者とAIエージェント向けのJira CLI。構造化JSON、フィルタリング、バッチ操作を備えています。
概要
このCLIツールは、JiraのREST APIと対話するための簡潔なコマンドラインインターフェースを提供します。出力は構造化JSON形式で行われ、jqなどのツールと組み合わせて容易に処理できます。
機能
- 構造化JSON出力: すべてのコマンドは解析可能なJSONを出力します。
- フィルタリング: JQL（Jira Query Language）を使用した高度な課題検索。
- バッチ操作: 複数の課題を一度に作成、更新、遷移。
- 認証: 環境変数または設定ファイルによる安全な認証情報管理。
インストール
npm install -g @sofq/jira-cli
または、リポジトリから直接ビルド:
git clone https://github.com/sofq/jira-cli.git
cd jira-cli
npm install
npm run build
npm link
設定
認証情報を環境変数で設定:
export JIRA_HOST=https://your-domain.atlassian.net
export [email protected]
export JIRA_API_TOKEN=your-api-token
または、~/.jira-cli/config.json に設定ファイルを作成:
{
"host": "https://your-domain.atlassian.net",
"email": "[email protected]",
"apiToken": "your-api-token"
}
使用方法
課題の検索
jira-cli search --jql "project = PROJ AND status != Closed" --limit 20
課題の作成
jira-cli create --project PROJ --summary "新しいバグ" --description "..." --type Bug
課題の更新
jira-cli update PROJ-123 --field summary "更新された件名"
バッチ操作
jira-cli batch --file operations.json
operations.json の例:
[
{"action": "create", "project": "PROJ", "summary": "課題1", "type": "Task"},
{"action": "update", "issue": "PROJ-456", "field": "assignee", "value": "[email protected]"}
]
課題のコメント
jira-cli comment PROJ-789 --body "これはコメントです。"
高度なフィルタリング
JQLと追加オプションを組み合わせて検索結果を絞り込む:
jira-cli search --jql "project = PROJ" --fields "summary,status,assignee" --order-by "created" --max-results 50
ヘルプ
すべての利用可能なコマンドを表示:
jira-cli --help
特定のコマンドのヘルプ:
jira-cli search --help