atl-fetch
v1.2.0
Published
Atlassianの情報をfetchする
Downloads
354
Readme
atl-fetch
Atlassian Cloud(Jira / Confluence)から情報を取得する Node.js CLI ツール兼ライブラリです。
主な機能
- Jira Issue 取得: タイトル、説明、コメント、変更履歴、添付ファイル
- Confluence ページ取得: タイトル、本文、バージョン履歴、添付ファイル
- 複数出力形式: JSON / Markdown / YAML
- 差分表示: バージョン間の Unified diff 形式表示
- 添付ファイルダウンロード: 指定ディレクトリへの保存
- 親切なエラーメッセージ: エラーコード、原因、解決策を表示
- 進捗表示: スピナーによる処理状況の可視化
- 認証チェック:
atl-fetch auth checkで設定状態を確認
動作要件
- Node.js 22.0.0 以上
- pnpm(推奨)または npm
インストール
# npm
npm install -g atl-fetch
# pnpm
pnpm add -g atl-fetchクイックスタート
1. 環境変数の設定
export ATLASSIAN_EMAIL="[email protected]"
export ATLASSIAN_API_TOKEN="your-api-token"API トークンは Atlassian Account Settings から取得できます。
2. 基本的な使用方法
# Jira Issue を取得
atl-fetch https://your-domain.atlassian.net/browse/PROJECT-123
# Confluence ページを取得
atl-fetch https://your-domain.atlassian.net/wiki/spaces/SPACE/pages/123456/Page+Title
# Markdown 形式で出力
atl-fetch https://your-domain.atlassian.net/browse/PROJECT-123 --format markdown
# 添付ファイルをダウンロード
atl-fetch https://your-domain.atlassian.net/browse/PROJECT-123 --download --dir ./output
# ファイルに保存(リダイレクト)
atl-fetch https://your-domain.atlassian.net/browse/PROJECT-123 > result.jsonCLI オプション
| オプション | 短縮形 | 説明 | デフォルト |
| ------------ | ---- | ---------------------------- | ----- |
| --format | -f | 出力形式(json / markdown / yaml) | json |
| --download | -d | 添付ファイルをダウンロード | false |
| --dir | -o | 保存先ディレクトリ | - |
| --diff | | 差分のみを出力 | false |
| --color | | カラー出力を有効化 | true |
| --verbose | -v | 詳細出力を有効化 | false |
| --debug | | デバッグ出力を有効化(開発者向け) | false |
| --help | -h | ヘルプを表示 | - |
| --version | -V | バージョンを表示 | - |
注意: --dir は --download と一緒に使用する必要があります。
サブコマンド
atl-fetch auth check
認証情報の設定状態を確認します。
atl-fetch auth check出力例(設定済み):
認証情報チェック
────────────────────────────────────────
✓ 認証情報が正しく設定されています
設定状態:
ATLASSIAN_EMAIL: [email protected]
ATLASSIAN_API_TOKEN: ***abcdエラーコード
問題が発生した場合、以下のエラーコードと解決策が表示されます。
| コード | 説明 | 主な原因 |
| ------------ | ------------------ | ----------------------- |
| ATL-URL-001 | URL の形式が不正 | サポートされていない URL 形式 |
| ATL-AUTH-001 | 認証失敗 | API トークンが無効または期限切れ |
| ATL-404-001 | リソースが見つからない | URL が間違っている、または削除済み |
| ATL-403-001 | アクセス権限なし | 該当リソースへの権限がない |
| ATL-NET-001 | ネットワークエラー | インターネット接続の問題 |
ライセンス
貢献
CONTRIBUTING.md をご覧ください。
