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