aboutsummaryrefslogtreecommitdiff
path: root/docs/ja/cli_commands.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ja/cli_commands.md')
-rw-r--r--docs/ja/cli_commands.md296
1 files changed, 296 insertions, 0 deletions
diff --git a/docs/ja/cli_commands.md b/docs/ja/cli_commands.md
new file mode 100644
index 000000000..35937dbbc
--- /dev/null
+++ b/docs/ja/cli_commands.md
@@ -0,0 +1,296 @@
1# QMK CLI コマンド
2
3<!---
4 original document: 0.9.19:docs/cli_command.md
5 git diff 0.9.19 HEAD -- docs/cli_command.md | cat
6-->
7
8# ユーザー用コマンド
9
10## `qmk compile`
11
12このコマンドにより、任意のディレクトリからファームウェアをコンパイルすることができます。<https://config.qmk.fm> からエクスポートした JSON をコンパイルするか、リポジトリ内でキーマップをコンパイルするか、現在の作業ディレクトリでキーボードをコンパイルすることができます。
13
14このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。
15
16**Configurator Exports での使い方**:
17
18```
19qmk compile <configuratorExport.json>
20```
21
22**キーマップでの使い方**:
23
24```
25qmk compile -kb <keyboard_name> -km <keymap_name>
26```
27
28**キーボードディレクトリでの使い方**:
29
30default キーマップのあるキーボードディレクトリ、キーボードのキーマップディレクトリ、`--keymap <keymap_name>` で与えられるキーマップディレクトリにいなければなりません。
31```
32qmk compile
33```
34
35**指定したキーマップをサポートする全てのキーボードをビルドする場合の使い方**:
36
37```
38qmk compile -kb all -km <keymap_name>
39```
40
41**例**:
42```
43$ qmk config compile.keymap=default
44$ cd ~/qmk_firmware/keyboards/planck/rev6
45$ qmk compile
46Ψ Compiling keymap with make planck/rev6:default
47...
48```
49あるいはオプションのキーマップ引数を指定して
50
51```
52$ cd ~/qmk_firmware/keyboards/clueboard/66/rev4
53$ qmk compile -km 66_iso
54Ψ Compiling keymap with make clueboard/66/rev4:66_iso
55...
56```
57あるいはキーマップディレクトリで
58
59```
60$ cd ~/qmk_firmware/keyboards/gh60/satan/keymaps/colemak
61$ qmk compile
62Ψ Compiling keymap with make make gh60/satan:colemak
63...
64```
65
66**レイアウトディレクトリでの使い方**:
67
68`qmk_firmware/layouts/` 以下のキーマップディレクトリにいなければなりません。
69```
70qmk compile -kb <keyboard_name>
71```
72
73**例**:
74```
75$ cd ~/qmk_firmware/layouts/community/60_ansi/mechmerlin-ansi
76$ qmk compile -kb dz60
77Ψ Compiling keymap with make dz60:mechmerlin-ansi
78...
79```
80
81## `qmk flash`
82
83このコマンドは `qmk compile` に似ていますが、ブートローダを対象にすることもできます。ブートローダはオプションで、デフォルトでは `:flash` に設定されています。
84違うブートローダを指定するには、`-bl <bootloader>` を使ってください。利用可能なブートローダの詳細については、[ファームウェアを書き込む](ja/flashing.md)を見てください。
85
86このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。
87
88**Configurator Exports での使い方**:
89
90```
91qmk flash <configuratorExport.json> -bl <bootloader>
92```
93
94**キーマップでの使い方**:
95
96```
97qmk flash -kb <keyboard_name> -km <keymap_name> -bl <bootloader>
98```
99
100**ブートローダの列挙**
101
102```
103qmk flash -b
104```
105
106## `qmk config`
107
108このコマンドにより QMK の挙動を設定することができます。完全な `qmk config` のドキュメントについては、[CLI 設定](ja/cli_configuration.md)を見てください。
109
110**使用法**:
111
112```
113qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
114```
115
116## `qmk doctor`
117
118このコマンドは環境を調査し、潜在的なビルドあるいは書き込みの問題について警告します。必要に応じてそれらの多くを修正できます。
119
120**使用法**:
121
122```
123qmk doctor [-y] [-n]
124```
125
126**例**:
127
128環境に問題がないか確認し、それらを修正するよう促します:
129
130 qmk doctor
131
132環境を確認し、見つかった問題を自動的に修正します:
133
134 qmk doctor -y
135
136環境を確認し、問題のみをレポートします:
137
138 qmk doctor -n
139
140## `qmk info`
141
142QMK のキーボードやキーマップに関する情報を表示します。キーボードに関する情報を取得したり、レイアウトを表示したり、基礎となるキーマトリックスを表示したり、JSON キーマップをきれいに印刷したりするのに使用できます。
143
144**使用法**:
145
146```
147qmk info [-f FORMAT] [-m] [-l] [-km KEYMAP] [-kb KEYBOARD]
148```
149
150このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。
151
152**例**:
153
154キーボードの基本情報を表示する:
155
156 qmk info -kb planck/rev5
157
158キーボードのマトリクスを表示する:
159
160 qmk info -kb ergodox_ez -m
161
162キーボードの JSON キーマップを表示する:
163
164 qmk info -kb clueboard/california -km default
165
166## `qmk json2c`
167
168QMK Configurator からエクスポートしたものから keymap.c を生成します。
169
170**使用法**:
171
172```
173qmk json2c [-o OUTPUT] filename
174```
175
176## `qmk list-keyboards`
177
178このコマンドは現在 `qmk_firmware` で定義されている全てのキーボードを列挙します。
179
180**使用法**:
181
182```
183qmk list-keyboards
184```
185
186## `qmk list-keymaps`
187
188このコマンドは指定されたキーボード(とリビジョン)の全てのキーマップを列挙します。
189
190このコマンドはディレクトリを認識します。キーボードのディレクトリにいる場合、自動的に KEYBOARD を入力します。
191
192**使用法**:
193
194```
195qmk list-keymaps -kb planck/ez
196```
197
198## `qmk new-keymap`
199
200このコマンドは、キーボードの既存のデフォルトのキーマップに基づいて新しいキーマップを作成します。
201
202このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。
203
204**使用法**:
205
206```
207qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
208```
209
210---
211
212# 開発者用コマンド
213
214## `qmk format-c`
215
216このコマンドは clang-format を使って C コードを整形します。
217
218引数無しで実行すると、変更された全てのコアコードを整形します。デフォルトでは `git diff` で `origin/master` をチェックし、ブランチは `-b <branch_name>` を使って変更できます。
219
220`-a` で全てのコアコードを整形するか、コマンドラインでファイル名を渡して特定のファイルに対して実行します。
221
222**指定したファイルに対する使い方**:
223
224```
225qmk format-c [file1] [file2] [...] [fileN]
226```
227
228**全てのコアファイルに対する使い方**:
229
230```
231qmk format-c -a
232```
233
234**origin/master で変更されたファイルのみに対する使い方**:
235
236```
237qmk format-c
238```
239
240**branch_name で変更されたファイルのみに対する使い方**:
241
242```
243qmk format-c -b branch_name
244```
245
246## `qmk docs`
247
248このコマンドは、ドキュメントを参照または改善するために使うことができるローカル HTTP サーバを起動します。デフォルトのポートは 8936 です。
249
250**使用法**:
251
252```
253qmk docs [-p PORT]
254```
255
256## `qmk kle2json`
257
258このコマンドにより、生の KLE データから QMK Configurator の JSON へ変換することができます。絶対パスあるいは現在のディレクトリ内のファイル名のいずれかを受け取ります。デフォルトでは、`info.json` が既に存在している場合は上書きしません。上書きするには、`-f` あるいは `--force` フラグを使ってください。
259
260**使用法**:
261
262```
263qmk kle2json [-f] <filename>
264```
265
266**例**:
267
268```
269$ qmk kle2json kle.txt
270☒ File info.json already exists, use -f or --force to overwrite.
271```
272
273```
274$ qmk kle2json -f kle.txt -f
275Ψ Wrote out to info.json
276```
277
278## `qmk format-py`
279
280このコマンドは `qmk_firmware` 内の python コードを整形します。
281
282**使用法**:
283
284```
285qmk format-py
286```
287
288## `qmk pytest`
289
290このコマンドは python のテストスィートを実行します。python コードに変更を加えた場合、これの実行が成功することを確認する必要があります。
291
292**使用法**:
293
294```
295qmk pytest
296```