backlog-exporter 0.2.3 → 0.5.0

package/README.md

@@ -13,7 +13,8 @@ Backlog のデータをエクスポートするためのコマンドラインツ
 * [使用方法](#使用方法)
 * [課題のエクスポート](#課題のエクスポート)
 * [Wikiのエクスポート](#wikiのエクスポート)
-* [課題とWikiの一括エクスポート](#課題とwikiの一括エクスポート)
+* [ドキュメントのエクスポート](#ドキュメントのエクスポート)
+* [課題・Wiki・ドキュメントの一括エクスポート](#課題wikiドキュメントの一括エクスポート)
 * [データの更新](#データの更新)
 * [npxを使った課題のエクスポート](#npxを使った課題のエクスポート)
 * [npxを使ったデータの更新](#npxを使ったデータの更新)
@@ -23,7 +24,11 @@ Backlog のデータをエクスポートするためのコマンドラインツ
 * [Wiki のエクスポート](#wiki-のエクスポート)
 * [基本的な使用方法](#基本的な使用方法)
 * [出力先を指定](#出力先を指定)
-* [課題と Wiki の一括エクスポート](#課題と-wiki-の一括エクスポート)
+* [ドキュメント のエクスポート](#ドキュメント-のエクスポート)
+* [基本的な使用方法](#基本的な使用方法)
+* [出力先を指定](#出力先を指定)
+* [キーワード検索](#キーワード検索)
+* [課題・Wiki・ドキュメント の一括エクスポート](#課題wikiドキュメント-の一括エクスポート)
 * [基本的な使用方法](#基本的な使用方法)
 * [出力先を指定](#出力先を指定)
 * [データの更新](#データの更新)
@@ -32,11 +37,13 @@ Backlog のデータをエクスポートするためのコマンドラインツ
 * [確認プロンプトをスキップして更新](#確認プロンプトをスキップして更新)
 * [課題のみを更新](#課題のみを更新)
 * [Wikiのみを更新](#wikiのみを更新)
+* [ドキュメントのみを更新](#ドキュメントのみを更新)
 * [APIキーを指定して更新](#apiキーを指定して更新)
 * [コマンド](#コマンド)
 * [出力形式](#出力形式)
 * [課題のタイトル](#課題のタイトル)
 * [Wiki のタイトル](#wiki-のタイトル)
+* [ドキュメントのタイトル](#ドキュメントのタイトル)
 * [その他の特徴](#その他の特徴)
 <!-- tocstop -->
 
@@ -47,7 +54,8 @@ backlog-exporter は、Backlog のデータをローカルにエクスポート
 
 - **課題（Issue）のエクスポート**：Backlog の課題を Markdown ファイルとして保存
 - **Wiki 記事のエクスポート**：Backlog の Wiki 記事を Markdown ファイルとして保存
-- **一括エクスポート**：課題と Wiki を同時に取得する機能
+- **ドキュメントのエクスポート**：Backlog のドキュメントを Markdown ファイルとして保存
+- **一括エクスポート**：課題・Wiki・ドキュメントを同時に取得する機能
 - **データの更新**：既存のエクスポートデータを最新の状態に更新する機能
 
 # インストール
@@ -58,7 +66,7 @@ $ npm install -g backlog-exporter
 $ backlog-exporter COMMAND
 running command...
 $ backlog-exporter (--version)
-backlog-exporter/0.2.3 linux-x64 node-v23.9.0
+backlog-exporter/0.5.0 linux-x64 node-v24.2.0
 $ backlog-exporter --help [COMMAND]
 USAGE
   $ backlog-exporter COMMAND
@@ -85,7 +93,10 @@ $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KE
 # Wikiのエクスポート
 $ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./wiki
 
-# 課題とWikiの一括エクスポート
+# ドキュメントのエクスポート
+$ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./documents
+
+# 課題・Wiki・ドキュメントの一括エクスポート
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./backlog-data
 
 # データの更新
@@ -130,9 +141,56 @@ $ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
 
 エクスポートされた Wiki は、指定したディレクトリ内に Markdown ファイルとして保存されます。Wiki の階層構造は保持され、ディレクトリ構造として再現されます。
 
-# 課題と Wiki の一括エクスポート
+# ドキュメント のエクスポート
+
+`document`コマンドを使用すると、Backlog のドキュメントページを Markdown ファイルとしてエクスポートできます。
+
+```sh
+# 基本的な使用方法
+$ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
+
+# 出力先を指定
+$ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./documents
+
+# キーワード検索
+$ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --keyword 仕様書
+```
+
+## ドキュメントの出力方法
+
+ドキュメントは **ツリー構造を保持** してエクスポートされます：
 
-`all`コマンドを使用すると、課題と Wiki を一度に取得できます。
+### ディレクトリ構造の保持
+- Backlogのドキュメントツリーの階層構造がそのままローカルディレクトリ構造として再現されます
+- フォルダはディレクトリとして作成され、ドキュメントはMarkdownファイルとして保存されます
+
+### 出力例
+```
+documents/
+├── プロジェクト概要/
+│   ├── 要件定義書.md
+│   └── 仕様書.md
+├── 設計書/
+│   ├── システム設計/
+│   │   ├── アーキテクチャ設計.md
+│   │   └── データベース設計.md
+│   └── UI設計/
+│       ├── 画面設計書.md
+│       └── ワイヤーフレーム.md
+└── 運用手順書.md
+```
+
+### 特徴
+- **階層構造の完全再現**: Backlogのフォルダ階層がそのまま保持されます
+- **重複処理の防止**: 同じドキュメントが複数回処理されることを防ぎます
+- **ファイル名の自動サニタイズ**: 不正な文字を自動的に除去して安全なファイル名を生成します
+- **メタデータの保持**: 作成者、更新者、タグ、添付ファイル情報なども含めて保存されます
+
+エクスポートされたドキュメントは、指定したディレクトリ内にツリー構造を保持したMarkdownファイルとして保存されます。
+
+# 課題・Wiki・ドキュメント の一括エクスポート
+
+`all`コマンドを使用すると、課題・Wiki・ドキュメントを一度に取得できます。
 
 ```sh
 # 基本的な使用方法
@@ -142,7 +200,7 @@ $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./backlog-data
 ```
 
-一括エクスポートでは、課題は`issues`ディレクトリに、Wiki は`wiki`ディレクトリに保存されます。
+一括エクスポートでは、課題は`issues`ディレクトリに、Wiki は`wiki`ディレクトリに、ドキュメントは`documents`ディレクトリに保存されます。
 
 # データの更新
 
@@ -164,16 +222,20 @@ $ backlog-exporter update --issuesOnly
 # Wikiのみを更新
 $ backlog-exporter update --wikisOnly
 
+# ドキュメントのみを更新
+$ backlog-exporter update --documentsOnly
+
 # APIキーを指定して更新
 $ backlog-exporter update --apiKey YOUR_API_KEY
 ```
 
-更新コマンドは、各ディレクトリの設定ファイルに基づいて、課題や Wiki を自動的に更新します。設定ファイルが見つかったディレクトリでは、そのディレクトリ内のファイルが直接更新されます（サブフォルダは作成されません）。
+更新コマンドは、各ディレクトリの設定ファイルに基づいて、課題・Wiki・ドキュメントを自動的に更新します。設定ファイルが見つかったディレクトリでは、そのディレクトリ内のファイルが直接更新されます（サブフォルダは作成されません）。
 
 # コマンド
 
 <!-- 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)
@@ -191,7 +253,7 @@ $ backlog-exporter update --apiKey YOUR_API_KEY
 
 ## `backlog-exporter all`
 
-Backlogから課題とWikiを取得してMarkdownファイルとして保存する
+Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイルとして保存する
 
 ```
 USAGE
@@ -206,20 +268,52 @@ FLAGS
       --projectIdOrKey=<value>  (required) Backlog project ID or key
 
 DESCRIPTION
-  Backlogから課題とWikiを取得してMarkdownファイルとして保存する
+  Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイルとして保存する
 
 EXAMPLES
   $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
-  課題とWikiをMarkdownファイルとして保存する
+  課題・Wiki・ドキュメントをMarkdownファイルとして保存する
 
   $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project
-  指定したディレクトリに課題とWikiを保存する
+  指定したディレクトリに課題・Wiki・ドキュメントを保存する
 
   $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 1000
-  最大1000件の課題を取得する（デフォルトは100件）
+  最大1000件の課題を取得する（デフォルトは5000件）
+```
+
+_See code: [src/commands/all/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.0/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/all/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.2.3/src/commands/all/index.ts)_
+_See code: [src/commands/document/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.0/src/commands/document/index.ts)_
 
 ## `backlog-exporter help [COMMAND]`
 
@@ -275,7 +369,7 @@ EXAMPLES
   最大10000件の課題を取得する（デフォルトは5000件）
 ```
 
-_See code: [src/commands/issue/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.2.3/src/commands/issue/index.ts)_
+_See code: [src/commands/issue/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.0/src/commands/issue/index.ts)_
 
 ## `backlog-exporter plugins`
 
@@ -573,8 +667,8 @@ Backlogから最新データを取得して更新する
 
 ```
 USAGE
-  $ backlog-exporter update [DIRECTORY] [--apiKey <value>] [--domain <value>] [-f] [--issuesOnly]
-    [--projectIdOrKey <value>] [--wikisOnly]
+  $ backlog-exporter update [DIRECTORY] [--apiKey <value>] [--documentsOnly] [--domain <value>] [-f]
+    [--issuesOnly] [--projectIdOrKey <value>] [--wikisOnly]
 
 ARGUMENTS
   DIRECTORY  更新対象のディレクトリ（設定ファイルが保存されている場所）
@@ -582,6 +676,7 @@ ARGUMENTS
 FLAGS
   -f, --force                   確認プロンプトをスキップする
       --apiKey=<value>          Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)
+      --documentsOnly           ドキュメントのみを更新する
       --domain=<value>          Backlog domain (e.g. example.backlog.jp)
       --issuesOnly              課題のみを更新する
       --projectIdOrKey=<value>  Backlog project ID or key
@@ -604,7 +699,7 @@ EXAMPLES
   指定したディレクトリの設定を使用して更新する
 ```
 
-_See code: [src/commands/update/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.2.3/src/commands/update/index.ts)_
+_See code: [src/commands/update/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.0/src/commands/update/index.ts)_
 
 ## `backlog-exporter wiki`
 
@@ -631,7 +726,7 @@ EXAMPLES
   指定したディレクトリにWikiを保存する
 ```
 
-_See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.2.3/src/commands/wiki/index.ts)_
+_See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.0/src/commands/wiki/index.ts)_
 <!-- commandsstop -->
 
 # 出力形式
@@ -689,6 +784,35 @@ Wiki は以下の形式で Markdown ファイルとして保存されます：
 Backlog の書式がそのまま保持されます。
 ```
 
+## ドキュメント の出力形式
+
+ドキュメントは以下の形式で Markdown ファイルとして保存されます：
+
+```markdown
+# ドキュメントのタイトル
+
+[Backlog Document Link](https://example.backlog.jp/document/DOC-ID)
+
+**ステータス**: 1 🎉
+**作成者**: 山田太郎
+**作成日時**: 2023/01/01 10:00:00
+**更新者**: 佐藤次郎
+**更新日時**: 2023/01/02 15:30:45
+
+## 内容
+
+ここにドキュメントの本文内容が入ります。
+Backlog の書式がそのまま保持されます。
+
+## 添付ファイル
+- **資料.pdf** (1024.5 KB) - 作成者: 山田太郎, 作成日時: 2023/01/01 10:00:00
+- **画像.png** (256.3 KB) - 作成者: 佐藤次郎, 作成日時: 2023/01/01 10:30:00
+
+## タグ
+- 仕様書
+- 設計書
+```
+
 # その他の特徴
 
 - **環境変数サポート**: 環境変数 `BACKLOG_API_KEY` を使用して API キーを設定可能
@@ -696,3 +820,5 @@ Backlog の書式がそのまま保持されます。
 - **並列処理**: 並列処理による高速なダウンロード
 - **ファイル名サニタイズ**: ファイル名の自動サニタイズ（不正な文字の除去）
 - **階層構造の保持**: Wiki の階層構造を保持したエクスポート
+- **キーワード検索**: ドキュメントの検索キーワード対応
+- **差分更新**: 前回の更新以降に変更されたデータのみを更新

package/dist/commands/all/index.js

@@ -1,23 +1,23 @@
 import { Command, Flags } from '@oclif/core';
 import * as dotenv from 'dotenv';
 import path from 'node:path';
-import { downloadIssues, downloadWikis } from '../../utils/backlog-api.js';
+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 description = 'Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイルとして保存する';
     static examples = [
         `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
-課題とWikiをMarkdownファイルとして保存する
+課題・Wiki・ドキュメントをMarkdownファイルとして保存する
 `,
         `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project
-指定したディレクトリに課題とWikiを保存する
+指定したディレクトリに課題・Wiki・ドキュメントを保存する
 `,
         `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 1000
-最大1000件の課題を取得する（デフォルトは100件）
+最大1000件の課題を取得する（デフォルトは5000件）
 `,
     ];
     static flags = {
@@ -62,6 +62,9 @@ export default class All extends Command {
             // Wikiの出力ディレクトリ
             const wikiOutput = path.join(outputRoot, 'wiki');
             await createOutputDirectory(wikiOutput);
+            // ドキュメントの出力ディレクトリ
+            const documentOutput = path.join(outputRoot, 'documents');
+            await createOutputDirectory(documentOutput);
             // 課題フォルダに設定ファイルを保存
             await updateSettings(issueOutput, {
                 apiKey,
@@ -78,6 +81,14 @@ export default class All extends Command {
                 outputDir: wikiOutput,
                 projectIdOrKey,
             });
+            // ドキュメントフォルダに設定ファイルを保存
+            await updateSettings(documentOutput, {
+                apiKey,
+                domain,
+                folderType: FolderType.DOCUMENT,
+                outputDir: documentOutput,
+                projectIdOrKey,
+            });
             // 課題の取得と保存
             this.log('課題の取得を開始します...');
             await downloadIssues(this, {
@@ -105,6 +116,19 @@ export default class All extends Command {
                 lastUpdated: new Date().toISOString(),
             });
             this.log('Wikiの取得が完了しました');
+            // ドキュメントの取得と保存
+            this.log('ドキュメントの取得を開始します...');
+            await downloadDocuments(this, {
+                apiKey,
+                domain,
+                outputDir: documentOutput,
+                projectId,
+            });
+            // ドキュメントフォルダの最終更新日時を更新
+            await updateSettings(documentOutput, {
+                lastUpdated: new Date().toISOString(),
+            });
+            this.log('ドキュメントの取得が完了しました');
             this.log('すべてのデータの取得が完了しました！');
         }
         catch (error) {

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,83 @@
+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,
+            });
+            // 最終更新日時を更新
+            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/update/index.d.ts

@@ -7,6 +7,7 @@ export default class Update extends Command {
     static examples: string[];
     static flags: {
         apiKey: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        documentsOnly: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         domain: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         issuesOnly: import("@oclif/core/interfaces").BooleanFlag<boolean>;
@@ -18,6 +19,7 @@ export default class Update extends Command {
     private determineUpdateTargets;
     private findAndUpdateSettings;
     private updateDirectory;
+    private updateDocuments;
     private updateIssues;
     private updateWikis;
 }

package/dist/commands/update/index.js

@@ -2,7 +2,7 @@ import { Args, Command, Flags } from '@oclif/core';
 import * as dotenv from 'dotenv';
 import { access, readdir } from 'node:fs/promises';
 import { join } from 'node:path';
-import { downloadIssues, downloadWikis } from '../../utils/backlog-api.js';
+import { downloadDocuments, downloadIssues, downloadWikis } from '../../utils/backlog-api.js';
 import { validateAndGetProjectId } from '../../utils/backlog.js';
 import { createOutputDirectory, getApiKey } from '../../utils/common.js';
 import { FolderType, getSettingsFilePath, loadSettings, updateSettings } from '../../utils/settings.js';
@@ -35,6 +35,10 @@ export default class Update extends Command {
             description: 'Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)',
             required: false,
         }),
+        documentsOnly: Flags.boolean({
+            description: 'ドキュメントのみを更新する',
+            required: false,
+        }),
         domain: Flags.string({
             description: 'Backlog domain (e.g. example.backlog.jp)',
             required: false,
@@ -81,7 +85,14 @@ export default class Update extends Command {
         if (options.folderType) {
             this.log(`- フォルダタイプ: ${options.folderType}`);
         }
-        this.log(`- 更新対象: ${options.updateIssues ? '課題' : ''}${options.updateIssues && options.updateWikis ? 'と' : ''}${options.updateWikis ? 'Wiki' : ''}`);
+        const updateTargets = [];
+        if (options.updateIssues)
+            updateTargets.push('課題');
+        if (options.updateWikis)
+            updateTargets.push('Wiki');
+        if (options.updateDocuments)
+            updateTargets.push('ドキュメント');
+        this.log(`- 更新対象: ${updateTargets.join('・')}`);
         // 確認プロンプトを表示
         this.log('更新を実行しますか？ (y/n)');
         process.stdin.resume();
@@ -99,20 +110,32 @@ export default class Update extends Command {
         return response;
     }
     // 更新対象の決定
-    determineUpdateTargets(folderType, issuesOnly, wikisOnly) {
-        let updateIssues = !wikisOnly;
-        let updateWikis = !issuesOnly;
-        // フォルダタイプがISSUEの場合は課題のみ更新
-        if (folderType === FolderType.ISSUE) {
-            updateIssues = true;
-            updateWikis = false;
-        }
-        // フォルダタイプがWIKIの場合はWikiのみ更新
-        else if (folderType === FolderType.WIKI) {
-            updateIssues = false;
-            updateWikis = true;
-        }
-        return { updateIssues, updateWikis };
+    determineUpdateTargets(folderType, documentsOnly, issuesOnly, wikisOnly) {
+        let updateIssues = !wikisOnly && !documentsOnly;
+        let updateWikis = !issuesOnly && !documentsOnly;
+        let updateDocuments = !issuesOnly && !wikisOnly;
+        // フォルダタイプに応じて更新対象を決定
+        switch (folderType) {
+            case FolderType.DOCUMENT: {
+                updateIssues = false;
+                updateWikis = false;
+                updateDocuments = true;
+                break;
+            }
+            case FolderType.ISSUE: {
+                updateIssues = true;
+                updateWikis = false;
+                updateDocuments = false;
+                break;
+            }
+            case FolderType.WIKI: {
+                updateIssues = false;
+                updateWikis = true;
+                updateDocuments = false;
+                break;
+            }
+        }
+        return { updateDocuments, updateIssues, updateWikis };
     }
     // 設定ファイルを探索して更新を実行
     async findAndUpdateSettings(targetDir, flags) {
@@ -150,11 +173,10 @@ export default class Update extends Command {
         // 設定ファイルを読み込む
         const settings = await loadSettings(targetDir);
         // コマンドライン引数と設定ファイルを組み合わせて使用する値を決定
-        const apiKey = flags.apiKey || settings.apiKey || getApiKey(this);
         const domain = flags.domain || settings.domain;
         const projectIdOrKey = flags.projectIdOrKey || settings.projectIdOrKey;
         const { folderType } = settings;
-        const { force, issuesOnly, wikisOnly } = flags;
+        const { documentsOnly, force, issuesOnly, wikisOnly } = flags;
         // 必須パラメータの検証
         if (!domain) {
             this.warn(`${targetDir}: ドメインが指定されていません。スキップします。`);
@@ -164,8 +186,17 @@ export default class Update extends Command {
             this.warn(`${targetDir}: プロジェクトIDまたはキーが指定されていません。スキップします。`);
             return;
         }
+        // APIキーの検証
+        let apiKey;
+        try {
+            apiKey = flags.apiKey || settings.apiKey || getApiKey(this);
+        }
+        catch {
+            this.warn(`${targetDir}: APIキーが指定されていません。--apiKey フラグまたは BACKLOG_API_KEY 環境変数で設定してください。`);
+            return;
+        }
         // 更新対象の決定
-        const { updateIssues, updateWikis } = this.determineUpdateTargets(folderType, issuesOnly, wikisOnly);
+        const { updateDocuments, updateIssues, updateWikis } = this.determineUpdateTargets(folderType, documentsOnly, issuesOnly, wikisOnly);
         // 更新前の確認
         const confirmed = await this.confirmUpdate({
             domain,
@@ -173,6 +204,7 @@ export default class Update extends Command {
             force: force || false,
             projectIdOrKey,
             targetDir,
+            updateDocuments,
             updateIssues,
             updateWikis,
         });
@@ -202,8 +234,41 @@ export default class Update extends Command {
                 targetDir,
             });
         }
+        // ドキュメントの更新
+        if (updateDocuments) {
+            await this.updateDocuments({
+                apiKey,
+                domain,
+                projectId,
+                projectIdOrKey,
+                targetDir,
+            });
+        }
         this.log(`${targetDir} の更新が完了しました！`);
     }
+    // ドキュメントの更新
+    async updateDocuments(options) {
+        this.log('ドキュメントの更新を開始します...');
+        // 設定ファイルから前回の更新日時を取得
+        const { lastUpdated } = await loadSettings(options.targetDir);
+        await downloadDocuments(this, {
+            apiKey: options.apiKey,
+            domain: options.domain,
+            lastUpdated,
+            outputDir: options.targetDir,
+            projectId: options.projectId,
+        });
+        // 設定ファイルを更新
+        await updateSettings(options.targetDir, {
+            apiKey: options.apiKey,
+            domain: options.domain,
+            folderType: FolderType.DOCUMENT,
+            lastUpdated: new Date().toISOString(),
+            outputDir: options.targetDir,
+            projectIdOrKey: options.projectIdOrKey,
+        });
+        this.log('ドキュメントの更新が完了しました');
+    }
     // 課題の更新
     async updateIssues(options) {
         this.log('課題の更新を開始します...');

package/dist/utils/backlog-api.d.ts

@@ -25,3 +25,16 @@ export declare function downloadWikis(command: Command, options: {
     outputDir: string;
     projectIdOrKey: string;
 }): Promise<void>;
+/**
+ * Backlogからドキュメントをダウンロードする
+ * @param command コマンドインスタンス
+ * @param options ドキュメントダウンロードのオプション
+ */
+export declare function downloadDocuments(command: Command, options: {
+    apiKey: string;
+    domain: string;
+    keyword?: string;
+    lastUpdated?: string;
+    outputDir: string;
+    projectId: number;
+}): Promise<void>;

package/dist/utils/backlog-api.js

@@ -3,6 +3,7 @@ import * as fs from 'node:fs/promises';
 import path from 'node:path';
 import process from 'node:process';
 import { sanitizeFileName, sanitizeWikiFileName } from './common.js';
+import { appendLog } from './log.js';
 import { RateLimiter } from './sleep.js';
 /**
  * Backlogから課題をダウンロードする
@@ -130,6 +131,9 @@ export async function downloadIssues(command, options) {
 ${issue.description || '詳細情報なし'}${commentsSection}`;
             // eslint-disable-next-line no-await-in-loop
             await fs.writeFile(issueFilePath, markdownContent);
+            // ログに記録
+            // eslint-disable-next-line no-await-in-loop
+            await appendLog(options.outputDir, `課題「${issue.summary}」を更新しました: ${backlogIssueUrl}`);
         }
         catch (error) {
             command.warn(`課題 ${issue.issueKey} の保存に失敗しました: ${error instanceof Error ? error.message : String(error)}`);
@@ -238,6 +242,9 @@ export async function downloadWikis(command, options) {
             const markdownContent = `# ${wiki.name}\n\n[Backlog Wiki Link](${backlogWikiUrl})\n\n${content}`;
             // eslint-disable-next-line no-await-in-loop
             await fs.writeFile(wikiFilePath, markdownContent);
+            // ログに記録
+            // eslint-disable-next-line no-await-in-loop
+            await appendLog(options.outputDir, `Wiki「${wiki.name}」を更新しました: ${backlogWikiUrl}`);
             // 進捗状況を一行で更新
             const wikiIndex = filteredWikis.indexOf(wiki) + 1;
             process.stdout.write(`\rWikiを保存中... (${wikiIndex}/${filteredWikis.length}件)`);
@@ -248,3 +255,123 @@ export async function downloadWikis(command, options) {
     }
     command.log('\nWikiのダウンロードが完了しました！');
 }
+/**
+ * Backlogからドキュメントをダウンロードする
+ * @param command コマンドインスタンス
+ * @param options ドキュメントダウンロードのオプション
+ */
+export async function downloadDocuments(command, options) {
+    const baseUrl = `https://${options.domain}/api/v2`;
+    command.log('ドキュメントの取得を開始します...');
+    // APIリクエスト数をカウントするためのRateLimiterを作成
+    const rateLimiter = new RateLimiter(command);
+    // ドキュメントツリーの取得
+    command.log('ドキュメントツリーを取得しています...');
+    // APIリクエスト数をインクリメント
+    await rateLimiter.increment();
+    const documentTree = await ky
+        .get(`${baseUrl}/documents/tree?projectIdOrKey=${options.projectId}&apiKey=${options.apiKey}`)
+        .json();
+    command.log('アクティブなドキュメントツリーを処理します...');
+    // ツリー構造をトラバースして、各ドキュメントの詳細を取得・保存
+    const processedDocuments = [];
+    /**
+     * ドキュメントノードを再帰的に処理する
+     */
+    const processDocumentNode = async (node, currentPath) => {
+        // フォルダの場合
+        if (node.children && node.children.length > 0) {
+            // フォルダを作成
+            const folderPath = path.join(options.outputDir, currentPath, sanitizeFileName(node.name));
+            await fs.mkdir(folderPath, { recursive: true });
+            // 子ノードを処理
+            for (const child of node.children) {
+                // eslint-disable-next-line no-await-in-loop
+                await processDocumentNode(child, path.join(currentPath, sanitizeFileName(node.name)));
+            }
+        }
+        else {
+            // ドキュメントファイルの場合
+            try {
+                // 既に処理済みのドキュメントはスキップ
+                if (processedDocuments.includes(node.id)) {
+                    return;
+                }
+                processedDocuments.push(node.id);
+                // APIリクエスト数をインクリメント
+                await rateLimiter.increment();
+                // 進捗状況を表示
+                process.stdout.write(`\rドキュメント「${node.name}」を処理中...`);
+                // ドキュメント詳細を取得
+                const documentDetail = await ky.get(`${baseUrl}/documents/${node.id}?apiKey=${options.apiKey}`).json();
+                // 前回の更新日時チェック
+                if (options.lastUpdated) {
+                    const lastUpdatedDate = new Date(options.lastUpdated);
+                    const documentUpdatedDate = new Date(documentDetail.updated);
+                    if (documentUpdatedDate <= lastUpdatedDate) {
+                        return; // 更新が必要ない場合はスキップ
+                    }
+                }
+                // ファイルパスを構築
+                const sanitizedTitle = sanitizeFileName(documentDetail.title);
+                const documentFileName = `${sanitizedTitle}.md`;
+                const documentFilePath = path.join(options.outputDir, currentPath, documentFileName);
+                // ディレクトリを作成（必要に応じて）
+                const dirPath = path.dirname(documentFilePath);
+                await fs.mkdir(dirPath, { recursive: true });
+                // Backlogのドキュメントへのリンクを作成
+                const backlogDocumentUrl = `https://${options.domain}/document/${node.id}`;
+                // 添付ファイルリストの作成
+                let attachmentsSection = '';
+                if (documentDetail.attachments && documentDetail.attachments.length > 0) {
+                    attachmentsSection = '\n\n## 添付ファイル\n';
+                    for (const attachment of documentDetail.attachments) {
+                        const attachmentDate = new Date(attachment.created).toLocaleString('ja-JP');
+                        const fileSize = (attachment.size / 1024).toFixed(1);
+                        attachmentsSection += `- **${attachment.name}** (${fileSize} KB) - 作成者: ${attachment.createdUser.name}, 作成日時: ${attachmentDate}\n`;
+                    }
+                }
+                // タグリストの作成
+                let tagsSection = '';
+                if (documentDetail.tags && documentDetail.tags.length > 0) {
+                    tagsSection = '\n\n## タグ\n';
+                    for (const tag of documentDetail.tags) {
+                        tagsSection += `- ${tag.name}\n`;
+                    }
+                }
+                // 作成者・更新者情報
+                const createdDate = new Date(documentDetail.created).toLocaleString('ja-JP');
+                const updatedDate = new Date(documentDetail.updated).toLocaleString('ja-JP');
+                // Markdownファイルに書き込む
+                const markdownContent = `# ${documentDetail.title}
+
+[Backlog Document Link](${backlogDocumentUrl})
+
+**ステータス**: ${documentDetail.statusId}${documentDetail.emoji ? ` ${documentDetail.emoji}` : ''}
+**作成者**: ${documentDetail.createdUser.name}
+**作成日時**: ${createdDate}
+**更新者**: ${documentDetail.updatedUser.name}
+**更新日時**: ${updatedDate}
+
+## 内容
+
+${documentDetail.plain || '（内容なし）'}${attachmentsSection}${tagsSection}`;
+                await fs.writeFile(documentFilePath, markdownContent);
+                // ログに記録
+                await appendLog(options.outputDir, `ドキュメント「${documentDetail.title}」を更新しました: ${backlogDocumentUrl}`);
+            }
+            catch (error) {
+                command.warn(`ドキュメント ${node.name} の取得に失敗しました: ${error instanceof Error ? error.message : String(error)}`);
+            }
+        }
+    };
+    // アクティブツリーのルートから処理開始
+    if (documentTree.activeTree.children && documentTree.activeTree.children.length > 0) {
+        for (const rootNode of documentTree.activeTree.children) {
+            // eslint-disable-next-line no-await-in-loop
+            await processDocumentNode(rootNode, '');
+        }
+    }
+    command.log(`\n合計 ${processedDocuments.length}件のドキュメントが処理されました。`);
+    command.log('ドキュメントのダウンロードが完了しました！');
+}

package/dist/utils/log.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 更新ログを記録する
+ * @param outputDir 出力ディレクトリ
+ * @param message ログメッセージ
+ */
+export declare function appendLog(outputDir: string, message: string): Promise<void>;

package/dist/utils/log.js

@@ -0,0 +1,18 @@
+import * as fs from 'node:fs/promises';
+import path from 'node:path';
+/**
+ * 更新ログを記録する
+ * @param outputDir 出力ディレクトリ
+ * @param message ログメッセージ
+ */
+export async function appendLog(outputDir, message) {
+    const logPath = path.join(outputDir, 'backlog-update.log');
+    const timestamp = new Date().toLocaleString('ja-JP');
+    const logMessage = `[${timestamp}] ${message}\n`;
+    try {
+        await fs.appendFile(logPath, logMessage, 'utf8');
+    }
+    catch (error) {
+        console.error(`ログの記録に失敗しました: ${error instanceof Error ? error.message : String(error)}`);
+    }
+}

package/dist/utils/settings.d.ts

@@ -2,6 +2,7 @@
  * フォルダタイプの定義
  */
 export declare enum FolderType {
+    DOCUMENT = "document",
     ISSUE = "issue",
     WIKI = "wiki"
 }

package/dist/utils/settings.js

@@ -5,6 +5,7 @@ import { join } from 'node:path';
  */
 export var FolderType;
 (function (FolderType) {
+    FolderType["DOCUMENT"] = "document";
     FolderType["ISSUE"] = "issue";
     FolderType["WIKI"] = "wiki";
 })(FolderType || (FolderType = {}));

package/oclif.manifest.json

@@ -3,11 +3,11 @@
     "all": {
       "aliases": [],
       "args": {},
-      "description": "Backlogから課題とWikiを取得してMarkdownファイルとして保存する",
+      "description": "Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイルとして保存する",
       "examples": [
-        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY\n課題とWikiをMarkdownファイルとして保存する\n",
-        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project\n指定したディレクトリに課題とWikiを保存する\n",
-        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 1000\n最大1000件の課題を取得する（デフォルトは100件）\n"
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY\n課題・Wiki・ドキュメントをMarkdownファイルとして保存する\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project\n指定したディレクトリに課題・Wiki・ドキュメントを保存する\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 1000\n最大1000件の課題を取得する（デフォルトは5000件）\n"
       ],
       "flags": {
         "apiKey": {
@@ -70,6 +70,74 @@
         "index.js"
       ]
     },
+    "document": {
+      "aliases": [],
+      "args": {},
+      "description": "Backlogからドキュメントを取得してMarkdownファイルとして保存する",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY\nドキュメントをMarkdownファイルとして保存する\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-documents\n指定したディレクトリにドキュメントを保存する\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --keyword 仕様書\nキーワード「仕様書」を含むドキュメントのみを取得する\n"
+      ],
+      "flags": {
+        "apiKey": {
+          "description": "Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)",
+          "name": "apiKey",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "domain": {
+          "description": "Backlog domain (e.g. example.backlog.jp)",
+          "name": "domain",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "keyword": {
+          "description": "検索キーワード",
+          "name": "keyword",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "output": {
+          "char": "o",
+          "description": "出力ディレクトリパス",
+          "name": "output",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "projectIdOrKey": {
+          "description": "Backlog project ID or key",
+          "name": "projectIdOrKey",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "document",
+      "pluginAlias": "backlog-exporter",
+      "pluginName": "backlog-exporter",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "document",
+        "index.js"
+      ]
+    },
     "issue": {
       "aliases": [],
       "args": {},
@@ -174,6 +242,13 @@
           "multiple": false,
           "type": "option"
         },
+        "documentsOnly": {
+          "description": "ドキュメントのみを更新する",
+          "name": "documentsOnly",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
         "domain": {
           "description": "Backlog domain (e.g. example.backlog.jp)",
           "name": "domain",
@@ -289,5 +364,5 @@
       ]
     }
   },
-  "version": "0.2.3"
+  "version": "0.5.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "backlog-exporter",
   "description": "A new CLI generated with oclif",
-  "version": "0.2.3",
+  "version": "0.5.0",
   "author": "ShuntaToda",
   "bin": {
     "backlog-exporter": "bin/run.js"
@@ -76,4 +76,4 @@
     "version": "oclif readme && git add README.md"
   },
   "types": "dist/index.d.ts"
-}
+}