backlog-exporter 0.7.0 → 0.7.1

package/README.md

@@ -77,7 +77,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.1 linux-x64 node-v24.4.1
 $ backlog-exporter --help [COMMAND]
 USAGE
   $ backlog-exporter COMMAND
@@ -323,7 +323,10 @@ $ backlog-exporter update --apiKey YOUR_API_KEY
 # コマンド
 
 <!-- commands -->
+* [`backlog-exporter all`](#backlog-exporter-all)
+* [`backlog-exporter document`](#backlog-exporter-document)
 * [`backlog-exporter help [COMMAND]`](#backlog-exporter-help-command)
+* [`backlog-exporter issue`](#backlog-exporter-issue)
 * [`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)
@@ -334,6 +337,91 @@ $ backlog-exporter update --apiKey YOUR_API_KEY
 * [`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 update [DIRECTORY]`](#backlog-exporter-update-directory)
+* [`backlog-exporter wiki`](#backlog-exporter-wiki)
+
+## `backlog-exporter all`
+
+Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイルとして保存する
+
+```
+USAGE
+  $ backlog-exporter all --domain <value> --projectIdOrKey <value> [--apiKey <value>] [--exclude <value>]
+    [--issueKeyFileName] [--issueKeyFolder] [-m <value>] [--only <value>] [-o <value>]
+
+FLAGS
+  -m, --maxCount=<value>        [default: 5000] 一度に取得する課題の最大数（デフォルト: 5000）
+  -o, --output=<value>          出力ディレクトリパス
+      --apiKey=<value>          Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)
+      --domain=<value>          (required) Backlog domain (e.g. example.backlog.jp)
+      --exclude=<value>         Exclude the specified types, separated by commas (e.g., 'documents,wiki')
+      --issueKeyFileName        ファイル名を課題キーにする
+      --issueKeyFolder          課題キーでフォルダを作成する
+      --only=<value>            Export only the specified types, separated by commas (e.g., 'issues,wiki')
+      --projectIdOrKey=<value>  (required) Backlog project ID or key
+
+DESCRIPTION
+  Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイルとして保存する
+
+EXAMPLES
+  $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
+  課題・Wiki・ドキュメントをMarkdownファイルとして保存する
+
+  $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project
+  指定したディレクトリに課題・Wiki・ドキュメントを保存する
+
+  $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --only issues,wiki
+  課題とWikiのみを取得する
+
+  $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --exclude documents
+  ドキュメント以外（課題とWiki）を取得する
+
+  $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 1000
+  最大1000件の課題を取得する（デフォルトは5000件）
+
+  $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName
+  ファイル名を課題キーにする
+
+  $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder
+  課題キーでフォルダを作成する
+
+  $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
+  課題キーでフォルダを作成し、ファイル名も課題キーにする
+```
+
+_See code: [src/commands/all/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.7.1/src/commands/all/index.ts)_
+
+## `backlog-exporter document`
+
+Backlogからドキュメントを取得してMarkdownファイルとして保存する
+
+```
+USAGE
+  $ backlog-exporter document --domain <value> --projectIdOrKey <value> [--apiKey <value>] [--keyword <value>]
+    [-o <value>]
+
+FLAGS
+  -o, --output=<value>          出力ディレクトリパス
+      --apiKey=<value>          Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)
+      --domain=<value>          (required) Backlog domain (e.g. example.backlog.jp)
+      --keyword=<value>         検索キーワード
+      --projectIdOrKey=<value>  (required) Backlog project ID or key
+
+DESCRIPTION
+  Backlogからドキュメントを取得してMarkdownファイルとして保存する
+
+EXAMPLES
+  $ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
+  ドキュメントをMarkdownファイルとして保存する
+
+  $ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-documents
+  指定したディレクトリにドキュメントを保存する
+
+  $ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --keyword 仕様書
+  キーワード「仕様書」を含むドキュメントのみを取得する
+```
+
+_See code: [src/commands/document/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.7.1/src/commands/document/index.ts)_
 
 ## `backlog-exporter help [COMMAND]`
 
@@ -355,6 +443,53 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.26/src/commands/help.ts)_
 
+## `backlog-exporter issue`
+
+Backlogから課題を取得してMarkdownファイルとして保存する
+
+```
+USAGE
+  $ backlog-exporter issue --domain <value> --projectIdOrKey <value> [--apiKey <value>]
+    [--issueKeyFileName] [--issueKeyFolder] [-m <value>] [-o <value>] [--statusId <value>]
+
+FLAGS
+  -m, --maxCount=<value>        [default: 5000] 一度に取得する課題の最大数（デフォルト: 5000）
+  -o, --output=<value>          出力ディレクトリパス
+      --apiKey=<value>          Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)
+      --domain=<value>          (required) Backlog domain (e.g. example.backlog.jp)
+      --issueKeyFileName        ファイル名を課題キーにする
+      --issueKeyFolder          課題キーでフォルダを作成する
+      --projectIdOrKey=<value>  (required) Backlog project ID or key
+      --statusId=<value>        ステータスID（カンマ区切りで複数指定可能）
+
+DESCRIPTION
+  Backlogから課題を取得してMarkdownファイルとして保存する
+
+EXAMPLES
+  $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
+  課題をMarkdownファイルとして保存する
+
+  $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-issues
+  指定したディレクトリに課題を保存する
+
+  $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --statusId 1,2,3
+  指定したステータスIDの課題のみを取得する
+
+  $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 10000
+  最大10000件の課題を取得する（デフォルトは5000件）
+
+  $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName
+  ファイル名を課題キーにする
+
+  $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder
+  課題キーでフォルダを作成する
+
+  $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
+  課題キーでフォルダを作成し、ファイル名も課題キーにする
+```
+
+_See code: [src/commands/issue/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.7.1/src/commands/issue/index.ts)_
+
 ## `backlog-exporter plugins`
 
 List installed plugins.
@@ -644,6 +779,84 @@ DESCRIPTION
 ```
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/update.ts)_
+
+## `backlog-exporter update [DIRECTORY]`
+
+Backlogから最新データを取得して更新する
+
+```
+USAGE
+  $ backlog-exporter update [DIRECTORY] [--apiKey <value>] [--documentsOnly] [--domain <value>] [-f]
+    [--issueKeyFileName] [--issueKeyFolder] [--issuesOnly] [--projectIdOrKey <value>] [--wikisOnly]
+
+ARGUMENTS
+  DIRECTORY  更新対象のディレクトリ（設定ファイルが保存されている場所）
+
+FLAGS
+  -f, --force                   確認プロンプトをスキップする
+      --apiKey=<value>          Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)
+      --documentsOnly           ドキュメントのみを更新する
+      --domain=<value>          Backlog domain (e.g. example.backlog.jp)
+      --issueKeyFileName        ファイル名を課題キーにする
+      --issueKeyFolder          課題キーでフォルダを作成する
+      --issuesOnly              課題のみを更新する
+      --projectIdOrKey=<value>  Backlog project ID or key
+      --wikisOnly               Wikiのみを更新する
+
+DESCRIPTION
+  Backlogから最新データを取得して更新する
+
+EXAMPLES
+  $ backlog-exporter update
+  カレントディレクトリの設定を使用して更新する
+
+  $ backlog-exporter update --force
+  確認プロンプトをスキップする
+
+  $ backlog-exporter update --apiKey YOUR_API_KEY --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
+  指定したパラメータで更新する（設定ファイルが存在する場合は上書きされます）
+
+  $ backlog-exporter update ./my-project
+  指定したディレクトリの設定を使用して更新する
+
+  $ backlog-exporter update --issueKeyFileName
+  ファイル名を課題キーにする
+
+  $ backlog-exporter update --issueKeyFolder
+  課題キーでフォルダを作成する
+
+  $ backlog-exporter update --issueKeyFileName --issueKeyFolder
+  課題キーでフォルダを作成し、ファイル名も課題キーにする
+```
+
+_See code: [src/commands/update/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.7.1/src/commands/update/index.ts)_
+
+## `backlog-exporter wiki`
+
+Backlogから Wiki を取得してMarkdownファイルとして保存する
+
+```
+USAGE
+  $ backlog-exporter wiki --domain <value> --projectIdOrKey <value> [--apiKey <value>] [-o <value>]
+
+FLAGS
+  -o, --output=<value>          出力ディレクトリパス
+      --apiKey=<value>          Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)
+      --domain=<value>          (required) Backlog domain (e.g. example.backlog.jp)
+      --projectIdOrKey=<value>  (required) Backlog project ID or key
+
+DESCRIPTION
+  Backlogから Wiki を取得してMarkdownファイルとして保存する
+
+EXAMPLES
+  $ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
+  Wikiをダウンロードする
+
+  $ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project
+  指定したディレクトリにWikiを保存する
+```
+
+_See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.7.1/src/commands/wiki/index.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}`);
+        }
+    }
+}

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

@@ -0,0 +1,16 @@
+import { Command } from '@oclif/core';
+export default class Issue 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>;
+        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>;
+        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>;
+        statusId: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}