backlog-exporter 0.7.0 → 0.7.2

package/README.md

@@ -12,44 +12,10 @@ Backlog のデータをエクスポートするためのコマンドラインツ
 * [インストール](#インストール)
 * [使用方法](#使用方法)
 * [課題のエクスポート](#課題のエクスポート)
-* [Wikiのエクスポート](#wikiのエクスポート)
-* [ドキュメントのエクスポート](#ドキュメントのエクスポート)
-* [課題・Wiki・ドキュメントの一括エクスポート](#課題wikiドキュメントの一括エクスポート)
-* [特定のデータタイプのみをエクスポート（onlyフラグ）](#特定のデータタイプのみをエクスポートonlyフラグ)
-* [特定のデータタイプを除外してエクスポート（excludeフラグ）](#特定のデータタイプを除外してエクスポートexcludeフラグ)
-* [データの更新](#データの更新)
-* [npxを使った課題のエクスポート](#npxを使った課題のエクスポート)
-* [npxを使ったデータの更新](#npxを使ったデータの更新)
-* [課題のエクスポート](#課題のエクスポート)
-* [基本的な使用方法](#基本的な使用方法)
-* [出力先を指定](#出力先を指定)
-* [Markdownファイル名を課題キーにする](#markdownファイル名を課題キーにする)
-* [課題キーでフォルダを作成する](#課題キーでフォルダを作成する)
-* [課題キーでフォルダを作成し、Markdownファイル名も課題キーにする](#課題キーでフォルダを作成しmarkdownファイル名も課題キーにする)
 * [Wiki のエクスポート](#wiki-のエクスポート)
-* [基本的な使用方法](#基本的な使用方法)
-* [出力先を指定](#出力先を指定)
 * [ドキュメント のエクスポート](#ドキュメント-のエクスポート)
-* [基本的な使用方法](#基本的な使用方法)
-* [出力先を指定](#出力先を指定)
-* [キーワード検索](#キーワード検索)
 * [課題・Wiki・ドキュメント の一括エクスポート](#課題wikiドキュメント-の一括エクスポート)
-* [基本的な使用方法](#基本的な使用方法)
-* [出力先を指定](#出力先を指定)
-* [特定のデータタイプのみをエクスポート（onlyフラグ）](#特定のデータタイプのみをエクスポートonlyフラグ)
-* [特定のデータタイプを除外してエクスポート（excludeフラグ）](#特定のデータタイプを除外してエクスポートexcludeフラグ)
-* [課題とWikiのみをエクスポート](#課題とwikiのみをエクスポート)
-* [ドキュメントのみをエクスポート](#ドキュメントのみをエクスポート)
-* [ドキュメント以外（課題とWiki）をエクスポート](#ドキュメント以外課題とwikiをエクスポート)
-* [課題以外（WikiとDocuments）をエクスポート](#課題以外wikiとdocumentsをエクスポート)
 * [データの更新](#データの更新)
-* [カレントディレクトリとそのサブディレクトリのデータを更新](#カレントディレクトリとそのサブディレクトリのデータを更新)
-* [指定したディレクトリとそのサブディレクトリのデータを更新](#指定したディレクトリとそのサブディレクトリのデータを更新)
-* [確認プロンプトをスキップして更新](#確認プロンプトをスキップして更新)
-* [課題のみを更新](#課題のみを更新)
-* [Wikiのみを更新](#wikiのみを更新)
-* [ドキュメントのみを更新](#ドキュメントのみを更新)
-* [APIキーを指定して更新](#apiキーを指定して更新)
 * [コマンド](#コマンド)
 * [出力形式](#出力形式)
 * [課題のタイトル](#課題のタイトル)
@@ -77,7 +43,7 @@ $ npm install -g backlog-exporter
 $ backlog-exporter COMMAND
 running command...
 $ backlog-exporter (--version)
-backlog-exporter/0.7.0 linux-x64 node-v24.4.1
+backlog-exporter/0.7.2 linux-x64 node-v25.2.1
 $ backlog-exporter --help [COMMAND]
 USAGE
   $ backlog-exporter COMMAND
@@ -97,36 +63,59 @@ API キーは以下の方法で指定できます：
 
 ## 基本的な使用例
 
+**課題のエクスポート**
+
 ```sh
-# 課題のエクスポート
 $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./issues
+```
+
+**Wikiのエクスポート**
 
-# Wikiのエクスポート
+```sh
 $ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./wiki
+```
+
+**ドキュメントのエクスポート**
 
-# ドキュメントのエクスポート
+```sh
 $ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./documents
+```
+
+**課題・Wiki・ドキュメントの一括エクスポート**
 
-# 課題・Wiki・ドキュメントの一括エクスポート
+```sh
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./backlog-data
+```
+
+**特定のデータタイプのみをエクスポート（onlyフラグ）**
 
-# 特定のデータタイプのみをエクスポート（onlyフラグ）
+```sh
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --only issues,wiki
+```
+
+**特定のデータタイプを除外してエクスポート（excludeフラグ）**
 
-# 特定のデータタイプを除外してエクスポート（excludeフラグ）
+```sh
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --exclude documents
+```
 
-# データの更新
+**データの更新**
+
+```sh
 $ backlog-exporter update
 ```
 
 npx を使用する場合は、コマンドの前に`npx`を付けるだけです：
 
+**npxを使った課題のエクスポート**
+
 ```sh
-# npxを使った課題のエクスポート
 $ npx backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./issues
+```
+
+**npxを使ったデータの更新**
 
-# npxを使ったデータの更新
+```sh
 $ npx backlog-exporter update
 ```
 
@@ -134,20 +123,33 @@ $ npx backlog-exporter update
 
 `issue`コマンドを使用すると、Backlog の課題を Markdown ファイルとしてエクスポートできます。
 
+**基本的な使用方法**
+
 ```sh
-# 基本的な使用方法
 $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
+```
 
-# 出力先を指定
+**出力先を指定**
+
+```sh
 $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./issues
+```
 
-# Markdownファイル名を課題キーにする
+**Markdownファイル名を課題キーにする**
+
+```sh
 $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName
+```
+
+**課題キーでフォルダを作成する**
 
-# 課題キーでフォルダを作成する
+```sh
 $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder
+```
+
+**課題キーでフォルダを作成し、Markdownファイル名も課題キーにする**
 
-# 課題キーでフォルダを作成し、Markdownファイル名も課題キーにする
+```sh
 $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
 ```
 
@@ -181,11 +183,15 @@ $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KE
 
 `wiki`コマンドを使用すると、Backlog の Wiki ページを Markdown ファイルとしてエクスポートできます。
 
+**基本的な使用方法**
+
 ```sh
-# 基本的な使用方法
 $ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
+```
+
+**出力先を指定**
 
-# 出力先を指定
+```sh
 $ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./wiki
 ```
 
@@ -195,14 +201,21 @@ $ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
 
 `document`コマンドを使用すると、Backlog のドキュメントページを Markdown ファイルとしてエクスポートできます。
 
+**基本的な使用方法**
+
 ```sh
-# 基本的な使用方法
 $ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
+```
+
+**出力先を指定**
 
-# 出力先を指定
+```sh
 $ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./documents
+```
+
+**キーワード検索**
 
-# キーワード検索
+```sh
 $ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --keyword 仕様書
 ```
 
@@ -245,17 +258,27 @@ documents/
 
 `all`コマンドを使用すると、課題・Wiki・ドキュメントを一度に取得できます。
 
+**基本的な使用方法**
+
 ```sh
-# 基本的な使用方法
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
+```
+
+**出力先を指定**
 
-# 出力先を指定
+```sh
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./backlog-data
+```
+
+**特定のデータタイプのみをエクスポート（onlyフラグ）**
 
-# 特定のデータタイプのみをエクスポート（onlyフラグ）
+```sh
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --only issues,wiki
+```
+
+**特定のデータタイプを除外してエクスポート（excludeフラグ）**
 
-# 特定のデータタイプを除外してエクスポート（excludeフラグ）
+```sh
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --exclude documents
 ```
 
@@ -269,11 +292,15 @@ $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
 
 特定のデータタイプのみをエクスポートします。カンマ区切りで複数指定可能です。
 
+**課題とWikiのみをエクスポート**
+
 ```sh
-# 課題とWikiのみをエクスポート
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --only issues,wiki
+```
 
-# ドキュメントのみをエクスポート
+**ドキュメントのみをエクスポート**
+
+```sh
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --only documents
 ```
 
@@ -281,11 +308,15 @@ $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
 
 特定のデータタイプを除外してエクスポートします。カンマ区切りで複数指定可能です。
 
+**ドキュメント以外（課題とWiki）をエクスポート**
+
 ```sh
-# ドキュメント以外（課題とWiki）をエクスポート
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --exclude documents
+```
+
+**課題以外（WikiとDocuments）をエクスポート**
 
-# 課題以外（WikiとDocuments）をエクスポート
+```sh
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --exclude issues
 ```
 
@@ -295,26 +326,45 @@ $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
 
 `update`コマンドを使用すると、既存のエクスポートデータを最新の状態に更新できます。このコマンドは、ディレクトリ内の`backlog-settings.json`ファイルを探索し、見つかったディレクトリでデータを更新します。
 
+**カレントディレクトリとそのサブディレクトリのデータを更新**
+
 ```sh
-# カレントディレクトリとそのサブディレクトリのデータを更新
 $ backlog-exporter update
+```
 
-# 指定したディレクトリとそのサブディレクトリのデータを更新
+**指定したディレクトリとそのサブディレクトリのデータを更新**
+
+```sh
 $ backlog-exporter update ./my-project
+```
 
-# 確認プロンプトをスキップして更新
+**確認プロンプトをスキップして更新**
+
+```sh
 $ backlog-exporter update --force
+```
 
-# 課題のみを更新
+**課題のみを更新**
+
+```sh
 $ backlog-exporter update --issuesOnly
+```
+
+**Wikiのみを更新**
 
-# Wikiのみを更新
+```sh
 $ backlog-exporter update --wikisOnly
+```
+
+**ドキュメントのみを更新**
 
-# ドキュメントのみを更新
+```sh
 $ backlog-exporter update --documentsOnly
+```
+
+**APIキーを指定して更新**
 
-# APIキーを指定して更新
+```sh
 $ backlog-exporter update --apiKey YOUR_API_KEY
 ```
 
@@ -322,19 +372,6 @@ $ backlog-exporter update --apiKey YOUR_API_KEY
 
 # コマンド
 
-<!-- commands -->
-* [`backlog-exporter help [COMMAND]`](#backlog-exporter-help-command)
-* [`backlog-exporter plugins`](#backlog-exporter-plugins)
-* [`backlog-exporter plugins add PLUGIN`](#backlog-exporter-plugins-add-plugin)
-* [`backlog-exporter plugins:inspect PLUGIN...`](#backlog-exporter-pluginsinspect-plugin)
-* [`backlog-exporter plugins install PLUGIN`](#backlog-exporter-plugins-install-plugin)
-* [`backlog-exporter plugins link PATH`](#backlog-exporter-plugins-link-path)
-* [`backlog-exporter plugins remove [PLUGIN]`](#backlog-exporter-plugins-remove-plugin)
-* [`backlog-exporter plugins reset`](#backlog-exporter-plugins-reset)
-* [`backlog-exporter plugins uninstall [PLUGIN]`](#backlog-exporter-plugins-uninstall-plugin)
-* [`backlog-exporter plugins unlink [PLUGIN]`](#backlog-exporter-plugins-unlink-plugin)
-* [`backlog-exporter plugins update`](#backlog-exporter-plugins-update)
-
 ## `backlog-exporter help [COMMAND]`
 
 Display help for backlog-exporter.
@@ -644,6 +681,7 @@ DESCRIPTION
 ```
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/update.ts)_
+
 <!-- commandsstop -->
 
 # 出力形式

package/dist/commands/all/index.d.ts

@@ -0,0 +1,17 @@
+import { Command } from '@oclif/core';
+export default class All extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        apiKey: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        domain: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        exclude: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        issueKeyFileName: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        issueKeyFolder: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        maxCount: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        only: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        projectIdOrKey: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/all/index.js

@@ -0,0 +1,210 @@
+import { Command, Flags } from '@oclif/core';
+import * as dotenv from 'dotenv';
+import path from 'node:path';
+import { downloadDocuments, downloadIssues, downloadWikis } from '../../utils/backlog-api.js';
+import { validateAndGetProjectId } from '../../utils/backlog.js';
+import { createOutputDirectory, getApiKey } from '../../utils/common.js';
+import { FolderType, updateSettings } from '../../utils/settings.js';
+// .envファイルを読み込む
+dotenv.config();
+export default class All extends Command {
+    static description = 'Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイルとして保存する';
+    static examples = [
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
+課題・Wiki・ドキュメントをMarkdownファイルとして保存する
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project
+指定したディレクトリに課題・Wiki・ドキュメントを保存する
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --only issues,wiki
+課題とWikiのみを取得する
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --exclude documents
+ドキュメント以外（課題とWiki）を取得する
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 1000
+最大1000件の課題を取得する（デフォルトは5000件）
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName
+ファイル名を課題キーにする
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder
+課題キーでフォルダを作成する
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
+課題キーでフォルダを作成し、ファイル名も課題キーにする
+`,
+    ];
+    static flags = {
+        apiKey: Flags.string({
+            description: 'Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)',
+            required: false,
+        }),
+        domain: Flags.string({
+            description: 'Backlog domain (e.g. example.backlog.jp)',
+            required: true,
+        }),
+        exclude: Flags.string({
+            description: "Exclude the specified types, separated by commas (e.g., 'documents,wiki')",
+            required: false,
+        }),
+        issueKeyFileName: Flags.boolean({
+            description: 'ファイル名を課題キーにする',
+            required: false,
+        }),
+        issueKeyFolder: Flags.boolean({
+            description: '課題キーでフォルダを作成する',
+            required: false,
+        }),
+        maxCount: Flags.integer({
+            char: 'm',
+            default: 5000,
+            description: '一度に取得する課題の最大数（デフォルト: 5000）',
+            required: false,
+        }),
+        only: Flags.string({
+            description: "Export only the specified types, separated by commas (e.g., 'issues,wiki')",
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            description: '出力ディレクトリパス',
+            required: false,
+        }),
+        projectIdOrKey: Flags.string({
+            description: 'Backlog project ID or key',
+            required: true,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(All);
+        try {
+            const { domain, exclude, issueKeyFileName, issueKeyFolder, maxCount, only, projectIdOrKey } = flags;
+            const apiKey = flags.apiKey || getApiKey(this);
+            const outputRoot = flags.output || './backlog-data';
+            // Check for conflicting flags
+            if (only && exclude) {
+                this.error('Cannot use both --only and --exclude flags together. Please use only one.');
+            }
+            // Determine targets based on flags
+            let targets;
+            if (only) {
+                targets = only.split(',');
+            }
+            else if (exclude) {
+                const excludeTargets = exclude.split(',');
+                const allTargets = ['issues', 'wiki', 'documents'];
+                targets = allTargets.filter((target) => !excludeTargets.includes(target));
+            }
+            else {
+                targets = ['issues', 'wiki', 'documents'];
+            }
+            // Validate targets
+            const validTargets = ['issues', 'wiki', 'documents'];
+            const inputTargets = only ? only.split(',') : exclude ? exclude.split(',') : [];
+            for (const target of inputTargets) {
+                if (!validTargets.includes(target)) {
+                    this.error(`Invalid target '${target}'. Available targets are: ${validTargets.join(', ')}`);
+                }
+            }
+            // Check if any targets remain after exclusion
+            if (targets.length === 0) {
+                this.error('No targets remaining after exclusion. Please specify valid targets to export.');
+            }
+            // 出力ディレクトリの作成
+            await createOutputDirectory(outputRoot);
+            // プロジェクトキーからプロジェクトIDを取得
+            const projectId = await validateAndGetProjectId(domain, projectIdOrKey, apiKey);
+            this.log(`プロジェクトID: ${projectId} を使用します`);
+            if (targets.includes('issues')) {
+                // 課題の出力ディレクトリ
+                const issueOutput = path.join(outputRoot, 'issues');
+                await createOutputDirectory(issueOutput);
+                // 課題フォルダに設定ファイルを保存
+                await updateSettings(issueOutput, {
+                    apiKey,
+                    domain,
+                    folderType: FolderType.ISSUE,
+                    issueKeyFileName,
+                    issueKeyFolder,
+                    outputDir: issueOutput,
+                    projectIdOrKey,
+                });
+                // 課題の取得と保存
+                this.log('課題の取得を開始します...');
+                await downloadIssues(this, {
+                    apiKey,
+                    count: maxCount,
+                    domain,
+                    issueKeyFileName,
+                    issueKeyFolder,
+                    outputDir: issueOutput,
+                    projectId,
+                });
+                // 課題フォルダの最終更新日時を更新
+                await updateSettings(issueOutput, {
+                    lastUpdated: new Date().toISOString(),
+                });
+                this.log('課題の取得が完了しました');
+            }
+            if (targets.includes('wiki')) {
+                // Wikiの出力ディレクトリ
+                const wikiOutput = path.join(outputRoot, 'wiki');
+                await createOutputDirectory(wikiOutput);
+                // Wikiフォルダに設定ファイルを保存
+                await updateSettings(wikiOutput, {
+                    apiKey,
+                    domain,
+                    folderType: FolderType.WIKI,
+                    outputDir: wikiOutput,
+                    projectIdOrKey,
+                });
+                // Wikiの取得と保存
+                this.log('Wikiの取得を開始します...');
+                await downloadWikis(this, {
+                    apiKey,
+                    domain,
+                    outputDir: wikiOutput,
+                    projectIdOrKey,
+                });
+                // Wikiフォルダの最終更新日時を更新
+                await updateSettings(wikiOutput, {
+                    lastUpdated: new Date().toISOString(),
+                });
+                this.log('Wikiの取得が完了しました');
+            }
+            if (targets.includes('documents')) {
+                // ドキュメントの出力ディレクトリ
+                const documentOutput = path.join(outputRoot, 'documents');
+                await createOutputDirectory(documentOutput);
+                // ドキュメントフォルダに設定ファイルを保存
+                await updateSettings(documentOutput, {
+                    apiKey,
+                    domain,
+                    folderType: FolderType.DOCUMENT,
+                    outputDir: documentOutput,
+                    projectIdOrKey,
+                });
+                // ドキュメントの取得と保存
+                this.log('ドキュメントの取得を開始します...');
+                await downloadDocuments(this, {
+                    apiKey,
+                    domain,
+                    outputDir: documentOutput,
+                    projectId,
+                    projectIdOrKey,
+                });
+                // ドキュメントフォルダの最終更新日時を更新
+                await updateSettings(documentOutput, {
+                    lastUpdated: new Date().toISOString(),
+                });
+                this.log('ドキュメントの取得が完了しました');
+            }
+            this.log('すべてのデータの取得が完了しました！');
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            this.error(`データの取得に失敗しました: ${errorMessage}`);
+        }
+    }
+}

package/dist/commands/document/index.d.ts

@@ -0,0 +1,13 @@
+import { Command } from '@oclif/core';
+export default class Document extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        apiKey: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        domain: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        keyword: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        projectIdOrKey: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/document/index.js

@@ -0,0 +1,84 @@
+import { Command, Flags } from '@oclif/core';
+import * as dotenv from 'dotenv';
+import { downloadDocuments } from '../../utils/backlog-api.js';
+import { validateAndGetProjectId } from '../../utils/backlog.js';
+import { createOutputDirectory, getApiKey } from '../../utils/common.js';
+import { FolderType, updateSettings } from '../../utils/settings.js';
+// .envファイルを読み込む
+dotenv.config();
+export default class Document extends Command {
+    static description = 'Backlogからドキュメントを取得してMarkdownファイルとして保存する';
+    static examples = [
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
+ドキュメントをMarkdownファイルとして保存する
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-documents
+指定したディレクトリにドキュメントを保存する
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --keyword 仕様書
+キーワード「仕様書」を含むドキュメントのみを取得する
+`,
+    ];
+    static flags = {
+        apiKey: Flags.string({
+            description: 'Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)',
+            required: false,
+        }),
+        domain: Flags.string({
+            description: 'Backlog domain (e.g. example.backlog.jp)',
+            required: true,
+        }),
+        keyword: Flags.string({
+            description: '検索キーワード',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            description: '出力ディレクトリパス',
+            required: false,
+        }),
+        projectIdOrKey: Flags.string({
+            description: 'Backlog project ID or key',
+            required: true,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(Document);
+        try {
+            const { domain, keyword, projectIdOrKey } = flags;
+            const apiKey = flags.apiKey || getApiKey(this);
+            const outputDir = flags.output || './backlog-documents';
+            // 出力ディレクトリの作成
+            await createOutputDirectory(outputDir);
+            // プロジェクトキーからプロジェクトIDを取得
+            const projectId = await validateAndGetProjectId(domain, projectIdOrKey, apiKey);
+            this.log(`プロジェクトID: ${projectId} を使用します`);
+            // 設定ファイルを保存
+            await updateSettings(outputDir, {
+                apiKey,
+                domain,
+                folderType: FolderType.DOCUMENT,
+                outputDir,
+                projectIdOrKey,
+            });
+            // ドキュメントの取得と保存
+            await downloadDocuments(this, {
+                apiKey,
+                domain,
+                keyword,
+                outputDir,
+                projectId,
+                projectIdOrKey,
+            });
+            // 最終更新日時を更新
+            await updateSettings(outputDir, {
+                lastUpdated: new Date().toISOString(),
+            });
+            this.log('ドキュメントの取得が完了しました！');
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            this.error(`ドキュメントの取得に失敗しました: ${errorMessage}`);
+        }
+    }
+}