aboutsummaryrefslogtreecommitdiff
path: root/docs/ja/cli.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ja/cli.md')
-rw-r--r--docs/ja/cli.md71
1 files changed, 66 insertions, 5 deletions
diff --git a/docs/ja/cli.md b/docs/ja/cli.md
index ef3752873..a83ccdf37 100644
--- a/docs/ja/cli.md
+++ b/docs/ja/cli.md
@@ -1,8 +1,8 @@
1# QMK CLI 1# QMK CLI
2 2
3<!--- 3<!---
4 original document: d598f01cb:docs/cli.md 4 original document: 2fe288d01:docs/cli.md
5 git diff d598f01cb HEAD -- docs/cli.md | cat 5 git diff 2fe288d01 HEAD -- docs/cli.md | cat
6--> 6-->
7 7
8このページは QMK CLI のセットアップと使用方法について説明します。 8このページは QMK CLI のセットアップと使用方法について説明します。
@@ -86,7 +86,7 @@ qmk cformat [file1] [file2] [...] [fileN]
86 86
87## `qmk compile` 87## `qmk compile`
88 88
89このコマンドにより、任意のディレクトリからファームウェアをコンパイルすることができます。<https://config.qmk.fm> からエクスポートした JSON をコンパイルするか、リポジトリ内でキーマップをコンパイルすることができます。 89このコマンドにより、任意のディレクトリからファームウェアをコンパイルすることができます。<https://config.qmk.fm> からエクスポートした JSON をコンパイルするか、リポジトリ内でキーマップをコンパイルするか、現在の作業ディレクトリでキーボードをコンパイルすることができます。
90 90
91**Configurator Exports での使い方**: 91**Configurator Exports での使い方**:
92 92
@@ -100,6 +100,53 @@ qmk compile <configuratorExport.json>
100qmk compile -kb <keyboard_name> -km <keymap_name> 100qmk compile -kb <keyboard_name> -km <keymap_name>
101``` 101```
102 102
103**キーボードディレクトリでの使い方**:
104
105default キーマップのあるキーボードディレクトリ、キーボードのキーマップディレクトリ、`--keymap <keymap_name>` で与えられるキーマップディレクトリにいなければなりません。
106```
107qmk compile
108```
109
110**例**:
111```
112$ qmk config compile.keymap=default
113$ cd ~/qmk_firmware/keyboards/planck/rev6
114$ qmk compile
115Ψ Compiling keymap with make planck/rev6:default
116...
117```
118あるいはオプションのキーマップ引数を指定して
119
120```
121$ cd ~/qmk_firmware/keyboards/clueboard/66/rev4
122$ qmk compile -km 66_iso
123Ψ Compiling keymap with make clueboard/66/rev4:66_iso
124...
125```
126あるいはキーマップディレクトリで
127
128```
129$ cd ~/qmk_firmware/keyboards/gh60/satan/keymaps/colemak
130$ qmk compile
131Ψ Compiling keymap with make make gh60/satan:colemak
132...
133```
134
135**レイアウトディレクトリでの使い方**:
136
137`qmk_firmware/layouts/` 以下のキーマップディレクトリにいなければなりません。
138```
139qmk compile -kb <keyboard_name>
140```
141
142**例**:
143```
144$ cd ~/qmk_firmware/layouts/community/60_ansi/mechmerlin-ansi
145$ qmk compile -kb dz60
146Ψ Compiling keymap with make dz60:mechmerlin-ansi
147...
148```
149
103## `qmk flash` 150## `qmk flash`
104 151
105このコマンドは `qmk compile` に似ていますが、ブートローダを対象にすることもできます。ブートローダはオプションで、デフォルトでは `:flash` に設定されています。 152このコマンドは `qmk compile` に似ていますが、ブートローダを対象にすることもできます。ブートローダはオプションで、デフォルトでは `:flash` に設定されています。
@@ -146,14 +193,28 @@ qmk docs [-p PORT]
146 193
147## `qmk doctor` 194## `qmk doctor`
148 195
149このコマンドは環境を調査し、潜在的なビルドあるいは書き込みの問題について警告します。 196このコマンドは環境を調査し、潜在的なビルドあるいは書き込みの問題について警告します。必要に応じてそれらの多くを修正できます。
150 197
151**使用法**: 198**使用法**:
152 199
153``` 200```
154qmk doctor 201qmk doctor [-y] [-n]
155``` 202```
156 203
204**例**:
205
206環境に問題がないか確認し、それらを修正するよう促します:
207
208 qmk doctor
209
210環境を確認し、見つかった問題を自動的に修正します:
211
212 qmk doctor -y
213
214環境を確認し、問題のみをレポートします:
215
216 qmk doctor -n
217
157## `qmk json-keymap` 218## `qmk json-keymap`
158 219
159QMK Configurator からエクスポートしたものから keymap.c を生成します。 220QMK Configurator からエクスポートしたものから keymap.c を生成します。