backlog-exporter 0.7.1 → 0.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +118 -293
- package/oclif.manifest.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,44 +12,10 @@ Backlog のデータをエクスポートするためのコマンドラインツ
|
|
|
12
12
|
* [インストール](#インストール)
|
|
13
13
|
* [使用方法](#使用方法)
|
|
14
14
|
* [課題のエクスポート](#課題のエクスポート)
|
|
15
|
-
* [Wikiのエクスポート](#wikiのエクスポート)
|
|
16
|
-
* [ドキュメントのエクスポート](#ドキュメントのエクスポート)
|
|
17
|
-
* [課題・Wiki・ドキュメントの一括エクスポート](#課題wikiドキュメントの一括エクスポート)
|
|
18
|
-
* [特定のデータタイプのみをエクスポート(onlyフラグ)](#特定のデータタイプのみをエクスポートonlyフラグ)
|
|
19
|
-
* [特定のデータタイプを除外してエクスポート(excludeフラグ)](#特定のデータタイプを除外してエクスポートexcludeフラグ)
|
|
20
|
-
* [データの更新](#データの更新)
|
|
21
|
-
* [npxを使った課題のエクスポート](#npxを使った課題のエクスポート)
|
|
22
|
-
* [npxを使ったデータの更新](#npxを使ったデータの更新)
|
|
23
|
-
* [課題のエクスポート](#課題のエクスポート)
|
|
24
|
-
* [基本的な使用方法](#基本的な使用方法)
|
|
25
|
-
* [出力先を指定](#出力先を指定)
|
|
26
|
-
* [Markdownファイル名を課題キーにする](#markdownファイル名を課題キーにする)
|
|
27
|
-
* [課題キーでフォルダを作成する](#課題キーでフォルダを作成する)
|
|
28
|
-
* [課題キーでフォルダを作成し、Markdownファイル名も課題キーにする](#課題キーでフォルダを作成しmarkdownファイル名も課題キーにする)
|
|
29
15
|
* [Wiki のエクスポート](#wiki-のエクスポート)
|
|
30
|
-
* [基本的な使用方法](#基本的な使用方法)
|
|
31
|
-
* [出力先を指定](#出力先を指定)
|
|
32
16
|
* [ドキュメント のエクスポート](#ドキュメント-のエクスポート)
|
|
33
|
-
* [基本的な使用方法](#基本的な使用方法)
|
|
34
|
-
* [出力先を指定](#出力先を指定)
|
|
35
|
-
* [キーワード検索](#キーワード検索)
|
|
36
17
|
* [課題・Wiki・ドキュメント の一括エクスポート](#課題wikiドキュメント-の一括エクスポート)
|
|
37
|
-
* [基本的な使用方法](#基本的な使用方法)
|
|
38
|
-
* [出力先を指定](#出力先を指定)
|
|
39
|
-
* [特定のデータタイプのみをエクスポート(onlyフラグ)](#特定のデータタイプのみをエクスポートonlyフラグ)
|
|
40
|
-
* [特定のデータタイプを除外してエクスポート(excludeフラグ)](#特定のデータタイプを除外してエクスポートexcludeフラグ)
|
|
41
|
-
* [課題とWikiのみをエクスポート](#課題とwikiのみをエクスポート)
|
|
42
|
-
* [ドキュメントのみをエクスポート](#ドキュメントのみをエクスポート)
|
|
43
|
-
* [ドキュメント以外(課題とWiki)をエクスポート](#ドキュメント以外課題とwikiをエクスポート)
|
|
44
|
-
* [課題以外(WikiとDocuments)をエクスポート](#課題以外wikiとdocumentsをエクスポート)
|
|
45
18
|
* [データの更新](#データの更新)
|
|
46
|
-
* [カレントディレクトリとそのサブディレクトリのデータを更新](#カレントディレクトリとそのサブディレクトリのデータを更新)
|
|
47
|
-
* [指定したディレクトリとそのサブディレクトリのデータを更新](#指定したディレクトリとそのサブディレクトリのデータを更新)
|
|
48
|
-
* [確認プロンプトをスキップして更新](#確認プロンプトをスキップして更新)
|
|
49
|
-
* [課題のみを更新](#課題のみを更新)
|
|
50
|
-
* [Wikiのみを更新](#wikiのみを更新)
|
|
51
|
-
* [ドキュメントのみを更新](#ドキュメントのみを更新)
|
|
52
|
-
* [APIキーを指定して更新](#apiキーを指定して更新)
|
|
53
19
|
* [コマンド](#コマンド)
|
|
54
20
|
* [出力形式](#出力形式)
|
|
55
21
|
* [課題のタイトル](#課題のタイトル)
|
|
@@ -77,7 +43,7 @@ $ npm install -g backlog-exporter
|
|
|
77
43
|
$ backlog-exporter COMMAND
|
|
78
44
|
running command...
|
|
79
45
|
$ backlog-exporter (--version)
|
|
80
|
-
backlog-exporter/0.7.
|
|
46
|
+
backlog-exporter/0.7.2 linux-x64 node-v25.2.1
|
|
81
47
|
$ backlog-exporter --help [COMMAND]
|
|
82
48
|
USAGE
|
|
83
49
|
$ backlog-exporter COMMAND
|
|
@@ -97,36 +63,59 @@ API キーは以下の方法で指定できます:
|
|
|
97
63
|
|
|
98
64
|
## 基本的な使用例
|
|
99
65
|
|
|
66
|
+
**課題のエクスポート**
|
|
67
|
+
|
|
100
68
|
```sh
|
|
101
|
-
# 課題のエクスポート
|
|
102
69
|
$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./issues
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
**Wikiのエクスポート**
|
|
103
73
|
|
|
104
|
-
|
|
74
|
+
```sh
|
|
105
75
|
$ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./wiki
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
**ドキュメントのエクスポート**
|
|
106
79
|
|
|
107
|
-
|
|
80
|
+
```sh
|
|
108
81
|
$ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./documents
|
|
82
|
+
```
|
|
109
83
|
|
|
110
|
-
|
|
84
|
+
**課題・Wiki・ドキュメントの一括エクスポート**
|
|
85
|
+
|
|
86
|
+
```sh
|
|
111
87
|
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./backlog-data
|
|
88
|
+
```
|
|
112
89
|
|
|
113
|
-
|
|
90
|
+
**特定のデータタイプのみをエクスポート(onlyフラグ)**
|
|
91
|
+
|
|
92
|
+
```sh
|
|
114
93
|
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --only issues,wiki
|
|
94
|
+
```
|
|
115
95
|
|
|
116
|
-
|
|
96
|
+
**特定のデータタイプを除外してエクスポート(excludeフラグ)**
|
|
97
|
+
|
|
98
|
+
```sh
|
|
117
99
|
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --exclude documents
|
|
100
|
+
```
|
|
118
101
|
|
|
119
|
-
|
|
102
|
+
**データの更新**
|
|
103
|
+
|
|
104
|
+
```sh
|
|
120
105
|
$ backlog-exporter update
|
|
121
106
|
```
|
|
122
107
|
|
|
123
108
|
npx を使用する場合は、コマンドの前に`npx`を付けるだけです:
|
|
124
109
|
|
|
110
|
+
**npxを使った課題のエクスポート**
|
|
111
|
+
|
|
125
112
|
```sh
|
|
126
|
-
# npxを使った課題のエクスポート
|
|
127
113
|
$ npx backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./issues
|
|
114
|
+
```
|
|
128
115
|
|
|
129
|
-
|
|
116
|
+
**npxを使ったデータの更新**
|
|
117
|
+
|
|
118
|
+
```sh
|
|
130
119
|
$ npx backlog-exporter update
|
|
131
120
|
```
|
|
132
121
|
|
|
@@ -134,20 +123,33 @@ $ npx backlog-exporter update
|
|
|
134
123
|
|
|
135
124
|
`issue`コマンドを使用すると、Backlog の課題を Markdown ファイルとしてエクスポートできます。
|
|
136
125
|
|
|
126
|
+
**基本的な使用方法**
|
|
127
|
+
|
|
137
128
|
```sh
|
|
138
|
-
# 基本的な使用方法
|
|
139
129
|
$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
**出力先を指定**
|
|
140
133
|
|
|
141
|
-
|
|
134
|
+
```sh
|
|
142
135
|
$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./issues
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
**Markdownファイル名を課題キーにする**
|
|
143
139
|
|
|
144
|
-
|
|
140
|
+
```sh
|
|
145
141
|
$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
**課題キーでフォルダを作成する**
|
|
146
145
|
|
|
147
|
-
|
|
146
|
+
```sh
|
|
148
147
|
$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
**課題キーでフォルダを作成し、Markdownファイル名も課題キーにする**
|
|
149
151
|
|
|
150
|
-
|
|
152
|
+
```sh
|
|
151
153
|
$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
|
|
152
154
|
```
|
|
153
155
|
|
|
@@ -181,11 +183,15 @@ $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KE
|
|
|
181
183
|
|
|
182
184
|
`wiki`コマンドを使用すると、Backlog の Wiki ページを Markdown ファイルとしてエクスポートできます。
|
|
183
185
|
|
|
186
|
+
**基本的な使用方法**
|
|
187
|
+
|
|
184
188
|
```sh
|
|
185
|
-
# 基本的な使用方法
|
|
186
189
|
$ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
|
|
190
|
+
```
|
|
187
191
|
|
|
188
|
-
|
|
192
|
+
**出力先を指定**
|
|
193
|
+
|
|
194
|
+
```sh
|
|
189
195
|
$ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./wiki
|
|
190
196
|
```
|
|
191
197
|
|
|
@@ -195,14 +201,21 @@ $ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
|
|
|
195
201
|
|
|
196
202
|
`document`コマンドを使用すると、Backlog のドキュメントページを Markdown ファイルとしてエクスポートできます。
|
|
197
203
|
|
|
204
|
+
**基本的な使用方法**
|
|
205
|
+
|
|
198
206
|
```sh
|
|
199
|
-
# 基本的な使用方法
|
|
200
207
|
$ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
**出力先を指定**
|
|
201
211
|
|
|
202
|
-
|
|
212
|
+
```sh
|
|
203
213
|
$ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./documents
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
**キーワード検索**
|
|
204
217
|
|
|
205
|
-
|
|
218
|
+
```sh
|
|
206
219
|
$ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --keyword 仕様書
|
|
207
220
|
```
|
|
208
221
|
|
|
@@ -245,17 +258,27 @@ documents/
|
|
|
245
258
|
|
|
246
259
|
`all`コマンドを使用すると、課題・Wiki・ドキュメントを一度に取得できます。
|
|
247
260
|
|
|
261
|
+
**基本的な使用方法**
|
|
262
|
+
|
|
248
263
|
```sh
|
|
249
|
-
# 基本的な使用方法
|
|
250
264
|
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
|
|
265
|
+
```
|
|
251
266
|
|
|
252
|
-
|
|
267
|
+
**出力先を指定**
|
|
268
|
+
|
|
269
|
+
```sh
|
|
253
270
|
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./backlog-data
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
**特定のデータタイプのみをエクスポート(onlyフラグ)**
|
|
254
274
|
|
|
255
|
-
|
|
275
|
+
```sh
|
|
256
276
|
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --only issues,wiki
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
**特定のデータタイプを除外してエクスポート(excludeフラグ)**
|
|
257
280
|
|
|
258
|
-
|
|
281
|
+
```sh
|
|
259
282
|
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --exclude documents
|
|
260
283
|
```
|
|
261
284
|
|
|
@@ -269,11 +292,15 @@ $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
|
|
|
269
292
|
|
|
270
293
|
特定のデータタイプのみをエクスポートします。カンマ区切りで複数指定可能です。
|
|
271
294
|
|
|
295
|
+
**課題とWikiのみをエクスポート**
|
|
296
|
+
|
|
272
297
|
```sh
|
|
273
|
-
# 課題とWikiのみをエクスポート
|
|
274
298
|
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --only issues,wiki
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
**ドキュメントのみをエクスポート**
|
|
275
302
|
|
|
276
|
-
|
|
303
|
+
```sh
|
|
277
304
|
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --only documents
|
|
278
305
|
```
|
|
279
306
|
|
|
@@ -281,11 +308,15 @@ $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
|
|
|
281
308
|
|
|
282
309
|
特定のデータタイプを除外してエクスポートします。カンマ区切りで複数指定可能です。
|
|
283
310
|
|
|
311
|
+
**ドキュメント以外(課題とWiki)をエクスポート**
|
|
312
|
+
|
|
284
313
|
```sh
|
|
285
|
-
# ドキュメント以外(課題とWiki)をエクスポート
|
|
286
314
|
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --exclude documents
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
**課題以外(WikiとDocuments)をエクスポート**
|
|
287
318
|
|
|
288
|
-
|
|
319
|
+
```sh
|
|
289
320
|
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --exclude issues
|
|
290
321
|
```
|
|
291
322
|
|
|
@@ -295,133 +326,51 @@ $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
|
|
|
295
326
|
|
|
296
327
|
`update`コマンドを使用すると、既存のエクスポートデータを最新の状態に更新できます。このコマンドは、ディレクトリ内の`backlog-settings.json`ファイルを探索し、見つかったディレクトリでデータを更新します。
|
|
297
328
|
|
|
329
|
+
**カレントディレクトリとそのサブディレクトリのデータを更新**
|
|
330
|
+
|
|
298
331
|
```sh
|
|
299
|
-
# カレントディレクトリとそのサブディレクトリのデータを更新
|
|
300
332
|
$ backlog-exporter update
|
|
301
|
-
|
|
302
|
-
# 指定したディレクトリとそのサブディレクトリのデータを更新
|
|
303
|
-
$ backlog-exporter update ./my-project
|
|
304
|
-
|
|
305
|
-
# 確認プロンプトをスキップして更新
|
|
306
|
-
$ backlog-exporter update --force
|
|
307
|
-
|
|
308
|
-
# 課題のみを更新
|
|
309
|
-
$ backlog-exporter update --issuesOnly
|
|
310
|
-
|
|
311
|
-
# Wikiのみを更新
|
|
312
|
-
$ backlog-exporter update --wikisOnly
|
|
313
|
-
|
|
314
|
-
# ドキュメントのみを更新
|
|
315
|
-
$ backlog-exporter update --documentsOnly
|
|
316
|
-
|
|
317
|
-
# APIキーを指定して更新
|
|
318
|
-
$ backlog-exporter update --apiKey YOUR_API_KEY
|
|
319
333
|
```
|
|
320
334
|
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
# コマンド
|
|
324
|
-
|
|
325
|
-
<!-- commands -->
|
|
326
|
-
* [`backlog-exporter all`](#backlog-exporter-all)
|
|
327
|
-
* [`backlog-exporter document`](#backlog-exporter-document)
|
|
328
|
-
* [`backlog-exporter help [COMMAND]`](#backlog-exporter-help-command)
|
|
329
|
-
* [`backlog-exporter issue`](#backlog-exporter-issue)
|
|
330
|
-
* [`backlog-exporter plugins`](#backlog-exporter-plugins)
|
|
331
|
-
* [`backlog-exporter plugins add PLUGIN`](#backlog-exporter-plugins-add-plugin)
|
|
332
|
-
* [`backlog-exporter plugins:inspect PLUGIN...`](#backlog-exporter-pluginsinspect-plugin)
|
|
333
|
-
* [`backlog-exporter plugins install PLUGIN`](#backlog-exporter-plugins-install-plugin)
|
|
334
|
-
* [`backlog-exporter plugins link PATH`](#backlog-exporter-plugins-link-path)
|
|
335
|
-
* [`backlog-exporter plugins remove [PLUGIN]`](#backlog-exporter-plugins-remove-plugin)
|
|
336
|
-
* [`backlog-exporter plugins reset`](#backlog-exporter-plugins-reset)
|
|
337
|
-
* [`backlog-exporter plugins uninstall [PLUGIN]`](#backlog-exporter-plugins-uninstall-plugin)
|
|
338
|
-
* [`backlog-exporter plugins unlink [PLUGIN]`](#backlog-exporter-plugins-unlink-plugin)
|
|
339
|
-
* [`backlog-exporter plugins update`](#backlog-exporter-plugins-update)
|
|
340
|
-
* [`backlog-exporter update [DIRECTORY]`](#backlog-exporter-update-directory)
|
|
341
|
-
* [`backlog-exporter wiki`](#backlog-exporter-wiki)
|
|
342
|
-
|
|
343
|
-
## `backlog-exporter all`
|
|
344
|
-
|
|
345
|
-
Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイルとして保存する
|
|
335
|
+
**指定したディレクトリとそのサブディレクトリのデータを更新**
|
|
346
336
|
|
|
337
|
+
```sh
|
|
338
|
+
$ backlog-exporter update ./my-project
|
|
347
339
|
```
|
|
348
|
-
USAGE
|
|
349
|
-
$ backlog-exporter all --domain <value> --projectIdOrKey <value> [--apiKey <value>] [--exclude <value>]
|
|
350
|
-
[--issueKeyFileName] [--issueKeyFolder] [-m <value>] [--only <value>] [-o <value>]
|
|
351
|
-
|
|
352
|
-
FLAGS
|
|
353
|
-
-m, --maxCount=<value> [default: 5000] 一度に取得する課題の最大数(デフォルト: 5000)
|
|
354
|
-
-o, --output=<value> 出力ディレクトリパス
|
|
355
|
-
--apiKey=<value> Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)
|
|
356
|
-
--domain=<value> (required) Backlog domain (e.g. example.backlog.jp)
|
|
357
|
-
--exclude=<value> Exclude the specified types, separated by commas (e.g., 'documents,wiki')
|
|
358
|
-
--issueKeyFileName ファイル名を課題キーにする
|
|
359
|
-
--issueKeyFolder 課題キーでフォルダを作成する
|
|
360
|
-
--only=<value> Export only the specified types, separated by commas (e.g., 'issues,wiki')
|
|
361
|
-
--projectIdOrKey=<value> (required) Backlog project ID or key
|
|
362
|
-
|
|
363
|
-
DESCRIPTION
|
|
364
|
-
Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイルとして保存する
|
|
365
|
-
|
|
366
|
-
EXAMPLES
|
|
367
|
-
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
|
|
368
|
-
課題・Wiki・ドキュメントをMarkdownファイルとして保存する
|
|
369
|
-
|
|
370
|
-
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project
|
|
371
|
-
指定したディレクトリに課題・Wiki・ドキュメントを保存する
|
|
372
|
-
|
|
373
|
-
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --only issues,wiki
|
|
374
|
-
課題とWikiのみを取得する
|
|
375
|
-
|
|
376
|
-
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --exclude documents
|
|
377
|
-
ドキュメント以外(課題とWiki)を取得する
|
|
378
340
|
|
|
379
|
-
|
|
380
|
-
最大1000件の課題を取得する(デフォルトは5000件)
|
|
341
|
+
**確認プロンプトをスキップして更新**
|
|
381
342
|
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder
|
|
386
|
-
課題キーでフォルダを作成する
|
|
387
|
-
|
|
388
|
-
$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
|
|
389
|
-
課題キーでフォルダを作成し、ファイル名も課題キーにする
|
|
343
|
+
```sh
|
|
344
|
+
$ backlog-exporter update --force
|
|
390
345
|
```
|
|
391
346
|
|
|
392
|
-
|
|
347
|
+
**課題のみを更新**
|
|
393
348
|
|
|
394
|
-
|
|
349
|
+
```sh
|
|
350
|
+
$ backlog-exporter update --issuesOnly
|
|
351
|
+
```
|
|
395
352
|
|
|
396
|
-
|
|
353
|
+
**Wikiのみを更新**
|
|
397
354
|
|
|
355
|
+
```sh
|
|
356
|
+
$ backlog-exporter update --wikisOnly
|
|
398
357
|
```
|
|
399
|
-
USAGE
|
|
400
|
-
$ backlog-exporter document --domain <value> --projectIdOrKey <value> [--apiKey <value>] [--keyword <value>]
|
|
401
|
-
[-o <value>]
|
|
402
358
|
|
|
403
|
-
|
|
404
|
-
-o, --output=<value> 出力ディレクトリパス
|
|
405
|
-
--apiKey=<value> Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)
|
|
406
|
-
--domain=<value> (required) Backlog domain (e.g. example.backlog.jp)
|
|
407
|
-
--keyword=<value> 検索キーワード
|
|
408
|
-
--projectIdOrKey=<value> (required) Backlog project ID or key
|
|
359
|
+
**ドキュメントのみを更新**
|
|
409
360
|
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
EXAMPLES
|
|
414
|
-
$ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
|
|
415
|
-
ドキュメントをMarkdownファイルとして保存する
|
|
361
|
+
```sh
|
|
362
|
+
$ backlog-exporter update --documentsOnly
|
|
363
|
+
```
|
|
416
364
|
|
|
417
|
-
|
|
418
|
-
指定したディレクトリにドキュメントを保存する
|
|
365
|
+
**APIキーを指定して更新**
|
|
419
366
|
|
|
420
|
-
|
|
421
|
-
|
|
367
|
+
```sh
|
|
368
|
+
$ backlog-exporter update --apiKey YOUR_API_KEY
|
|
422
369
|
```
|
|
423
370
|
|
|
424
|
-
|
|
371
|
+
更新コマンドは、各ディレクトリの設定ファイルに基づいて、課題・Wiki・ドキュメントを自動的に更新します。設定ファイルが見つかったディレクトリでは、そのディレクトリ内のファイルが直接更新されます(サブフォルダは作成されません)。
|
|
372
|
+
|
|
373
|
+
# コマンド
|
|
425
374
|
|
|
426
375
|
## `backlog-exporter help [COMMAND]`
|
|
427
376
|
|
|
@@ -443,53 +392,6 @@ DESCRIPTION
|
|
|
443
392
|
|
|
444
393
|
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.26/src/commands/help.ts)_
|
|
445
394
|
|
|
446
|
-
## `backlog-exporter issue`
|
|
447
|
-
|
|
448
|
-
Backlogから課題を取得してMarkdownファイルとして保存する
|
|
449
|
-
|
|
450
|
-
```
|
|
451
|
-
USAGE
|
|
452
|
-
$ backlog-exporter issue --domain <value> --projectIdOrKey <value> [--apiKey <value>]
|
|
453
|
-
[--issueKeyFileName] [--issueKeyFolder] [-m <value>] [-o <value>] [--statusId <value>]
|
|
454
|
-
|
|
455
|
-
FLAGS
|
|
456
|
-
-m, --maxCount=<value> [default: 5000] 一度に取得する課題の最大数(デフォルト: 5000)
|
|
457
|
-
-o, --output=<value> 出力ディレクトリパス
|
|
458
|
-
--apiKey=<value> Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)
|
|
459
|
-
--domain=<value> (required) Backlog domain (e.g. example.backlog.jp)
|
|
460
|
-
--issueKeyFileName ファイル名を課題キーにする
|
|
461
|
-
--issueKeyFolder 課題キーでフォルダを作成する
|
|
462
|
-
--projectIdOrKey=<value> (required) Backlog project ID or key
|
|
463
|
-
--statusId=<value> ステータスID(カンマ区切りで複数指定可能)
|
|
464
|
-
|
|
465
|
-
DESCRIPTION
|
|
466
|
-
Backlogから課題を取得してMarkdownファイルとして保存する
|
|
467
|
-
|
|
468
|
-
EXAMPLES
|
|
469
|
-
$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
|
|
470
|
-
課題をMarkdownファイルとして保存する
|
|
471
|
-
|
|
472
|
-
$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-issues
|
|
473
|
-
指定したディレクトリに課題を保存する
|
|
474
|
-
|
|
475
|
-
$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --statusId 1,2,3
|
|
476
|
-
指定したステータスIDの課題のみを取得する
|
|
477
|
-
|
|
478
|
-
$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 10000
|
|
479
|
-
最大10000件の課題を取得する(デフォルトは5000件)
|
|
480
|
-
|
|
481
|
-
$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName
|
|
482
|
-
ファイル名を課題キーにする
|
|
483
|
-
|
|
484
|
-
$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder
|
|
485
|
-
課題キーでフォルダを作成する
|
|
486
|
-
|
|
487
|
-
$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
|
|
488
|
-
課題キーでフォルダを作成し、ファイル名も課題キーにする
|
|
489
|
-
```
|
|
490
|
-
|
|
491
|
-
_See code: [src/commands/issue/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.7.1/src/commands/issue/index.ts)_
|
|
492
|
-
|
|
493
395
|
## `backlog-exporter plugins`
|
|
494
396
|
|
|
495
397
|
List installed plugins.
|
|
@@ -780,83 +682,6 @@ DESCRIPTION
|
|
|
780
682
|
|
|
781
683
|
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/update.ts)_
|
|
782
684
|
|
|
783
|
-
## `backlog-exporter update [DIRECTORY]`
|
|
784
|
-
|
|
785
|
-
Backlogから最新データを取得して更新する
|
|
786
|
-
|
|
787
|
-
```
|
|
788
|
-
USAGE
|
|
789
|
-
$ backlog-exporter update [DIRECTORY] [--apiKey <value>] [--documentsOnly] [--domain <value>] [-f]
|
|
790
|
-
[--issueKeyFileName] [--issueKeyFolder] [--issuesOnly] [--projectIdOrKey <value>] [--wikisOnly]
|
|
791
|
-
|
|
792
|
-
ARGUMENTS
|
|
793
|
-
DIRECTORY 更新対象のディレクトリ(設定ファイルが保存されている場所)
|
|
794
|
-
|
|
795
|
-
FLAGS
|
|
796
|
-
-f, --force 確認プロンプトをスキップする
|
|
797
|
-
--apiKey=<value> Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)
|
|
798
|
-
--documentsOnly ドキュメントのみを更新する
|
|
799
|
-
--domain=<value> Backlog domain (e.g. example.backlog.jp)
|
|
800
|
-
--issueKeyFileName ファイル名を課題キーにする
|
|
801
|
-
--issueKeyFolder 課題キーでフォルダを作成する
|
|
802
|
-
--issuesOnly 課題のみを更新する
|
|
803
|
-
--projectIdOrKey=<value> Backlog project ID or key
|
|
804
|
-
--wikisOnly Wikiのみを更新する
|
|
805
|
-
|
|
806
|
-
DESCRIPTION
|
|
807
|
-
Backlogから最新データを取得して更新する
|
|
808
|
-
|
|
809
|
-
EXAMPLES
|
|
810
|
-
$ backlog-exporter update
|
|
811
|
-
カレントディレクトリの設定を使用して更新する
|
|
812
|
-
|
|
813
|
-
$ backlog-exporter update --force
|
|
814
|
-
確認プロンプトをスキップする
|
|
815
|
-
|
|
816
|
-
$ backlog-exporter update --apiKey YOUR_API_KEY --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
|
|
817
|
-
指定したパラメータで更新する(設定ファイルが存在する場合は上書きされます)
|
|
818
|
-
|
|
819
|
-
$ backlog-exporter update ./my-project
|
|
820
|
-
指定したディレクトリの設定を使用して更新する
|
|
821
|
-
|
|
822
|
-
$ backlog-exporter update --issueKeyFileName
|
|
823
|
-
ファイル名を課題キーにする
|
|
824
|
-
|
|
825
|
-
$ backlog-exporter update --issueKeyFolder
|
|
826
|
-
課題キーでフォルダを作成する
|
|
827
|
-
|
|
828
|
-
$ backlog-exporter update --issueKeyFileName --issueKeyFolder
|
|
829
|
-
課題キーでフォルダを作成し、ファイル名も課題キーにする
|
|
830
|
-
```
|
|
831
|
-
|
|
832
|
-
_See code: [src/commands/update/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.7.1/src/commands/update/index.ts)_
|
|
833
|
-
|
|
834
|
-
## `backlog-exporter wiki`
|
|
835
|
-
|
|
836
|
-
Backlogから Wiki を取得してMarkdownファイルとして保存する
|
|
837
|
-
|
|
838
|
-
```
|
|
839
|
-
USAGE
|
|
840
|
-
$ backlog-exporter wiki --domain <value> --projectIdOrKey <value> [--apiKey <value>] [-o <value>]
|
|
841
|
-
|
|
842
|
-
FLAGS
|
|
843
|
-
-o, --output=<value> 出力ディレクトリパス
|
|
844
|
-
--apiKey=<value> Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)
|
|
845
|
-
--domain=<value> (required) Backlog domain (e.g. example.backlog.jp)
|
|
846
|
-
--projectIdOrKey=<value> (required) Backlog project ID or key
|
|
847
|
-
|
|
848
|
-
DESCRIPTION
|
|
849
|
-
Backlogから Wiki を取得してMarkdownファイルとして保存する
|
|
850
|
-
|
|
851
|
-
EXAMPLES
|
|
852
|
-
$ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
|
|
853
|
-
Wikiをダウンロードする
|
|
854
|
-
|
|
855
|
-
$ backlog-exporter wiki --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project
|
|
856
|
-
指定したディレクトリにWikiを保存する
|
|
857
|
-
```
|
|
858
|
-
|
|
859
|
-
_See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.7.1/src/commands/wiki/index.ts)_
|
|
860
685
|
<!-- commandsstop -->
|
|
861
686
|
|
|
862
687
|
# 出力形式
|
package/oclif.manifest.json
CHANGED