lc-semba-ryuichiro Jira 情報取得ガイド
目次
概要
atl-fetchはAtlassian CloudからJira課題情報を取得するCLIツール。課題の詳細、コメント、変更履歴、添付ファイルを一括で取得できる。
事前準備チェックリスト
取得する前に確認する。
- 環境変数
ATLASSIAN_EMAILが設定されているか - 環境変数
ATLASSIAN_API_TOKENが設定されているか - 対象のJiraプロジェクトへのアクセス権があるか
- Node.jsがインストールされているか
実行方法
atl-fetchはnpxで都度実行する。グローバルインストールは不要。
npx atl-fetch [Jira URL] [オプション]
CLI オプション一覧
| オプション | 説明 | デフォルト |
|---|---|---|
-f, --format |
出力形式 (json/markdown/yaml) | json |
-d, --download |
添付ファイルをダウンロード | false |
-o, --dir <path> |
ダウンロード先ディレクトリ（--download 必須） |
- |
--diff |
差分のみ表示 | false |
--color |
カラー出力有効 | true |
--no-color |
カラー出力無効 | false |
-v, --verbose |
詳細出力を有効化 | false |
--debug |
デバッグ出力を有効化（開発者向け） | false |
認証情報の確認
認証情報が正しく設定されているか確認する。
npx atl-fetch auth check
URL フォーマット
Jira課題URLは以下の形式で指定する。
https://{org}.atlassian.net/browse/{KEY}
例:
https://mycompany.atlassian.net/browse/PROJ-123https://example.atlassian.net/browse/DEV-456
よくある使用パターン
課題情報を JSON で取得
npx atl-fetch https://mycompany.atlassian.net/browse/PROJ-123
Markdown 形式で取得
npx atl-fetch https://mycompany.atlassian.net/browse/PROJ-123 -f markdown
添付ファイルをダウンロード
npx atl-fetch https://mycompany.atlassian.net/browse/PROJ-123 -d -o ./downloads
差分のみ表示
npx atl-fetch https://mycompany.atlassian.net/browse/PROJ-123 --diff
出力内容
Jira課題から以下の情報を取得する。
| フィールド | 説明 |
|---|---|
| key | 課題キー（例: PROJ-123） |
| summary | 課題タイトル |
| description | 課題の説明 |
| comments[] | コメント一覧 |
| changelog[] | 変更履歴 |
| attachments[] | 添付ファイル一覧 |
出力形式
JSON 形式（デフォルト）
{
"key": "PROJ-123",
"summary": "課題タイトル",
"description": "課題の詳細説明...",
"comments": [],
"changelog": [],
"attachments": []
}
Markdown 形式
# PROJ-123: 課題タイトル
## 説明
課題の詳細説明...
## コメント
- [2024-01-01] ユーザー名: コメント内容...
## 変更履歴
- [2024-01-01] ステータス: Open → In Progress
トラブルシューティング
認証エラーが発生する
環境変数を確認する。
echo $ATLASSIAN_EMAIL
echo $ATLASSIAN_API_TOKEN
権限エラーが発生する
対象プロジェクトへのアクセス権を確認する。
URL が認識されない
URLフォーマットが正しいか確認する。/browse/ が含まれているか確認。
追加リソース
リファレンスファイル
詳細なオプション説明については以下を参照。
references/jira-options.md... オプションの詳細説明、環境変数設定ガイド