aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/ja/cli.md272
1 files changed, 9 insertions, 263 deletions
diff --git a/docs/ja/cli.md b/docs/ja/cli.md
index e0bee35a6..dc6dddc41 100644
--- a/docs/ja/cli.md
+++ b/docs/ja/cli.md
@@ -1,29 +1,19 @@
1# QMK CLI 1# QMK CLI :id=qmk-cli
2 2
3<!--- 3<!---
4 original document: 79e6b7866:docs/cli.md 4 original document: 0.8.58:docs/cli.md
5 git diff 79e6b7866 HEAD -- docs/cli.md | cat 5 git diff 0.8.58 HEAD -- docs/cli.md | cat
6--> 6-->
7 7
8このページは QMK CLI のセットアップと使用方法について説明します。 8## 概要 :id=overview
9
10# 概要
11 9
12QMK CLI を使用すると QMK キーボードの構築と作業が簡単になります。QMK ファームウェアの取得とコンパイル、キーマップの作成などのようなタスクを簡素化し合理化するためのコマンドを多く提供します。 10QMK CLI を使用すると QMK キーボードの構築と作業が簡単になります。QMK ファームウェアの取得とコンパイル、キーマップの作成などのようなタスクを簡素化し合理化するためのコマンドを多く提供します。
13 11
14* [グローバル CLI](#global-cli) 12### 必要事項 :id=requirements
15* [ローカル CLI](#local-cli)
16* [CLI コマンド](#cli-commands)
17
18# 必要事項
19
20CLI は Python 3.5 以上を必要とします。我々は必要事項の数を少なくしようとしていますが、[`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt) にリストされているパッケージもインストールする必要があります。
21 13
22# グローバル CLI :id=global-cli 14CLI は Python 3.5 以上を必要とします。我々は必要事項の数を少なくしようとしていますが、[`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt) に列挙されているパッケージもインストールする必要があります。これらは QMK CLI をインストールするときに自動的にインストールされます。
23 15
24QMK は、QMK ビルド環境のセットアップ、QMK の操作、および `qmk_firmware` の複数のコピーの操作を容易にできるインストール可能な CLI を提供します。これを定期的にインストールおよび更新することをお勧めします。 16### Homebrew を使ったインストール (macOS、いくつかの Linux) :id=install-using-homebrew
25
26## Homebrew を使ったインストール (macOS、いくつかの Linux)
27 17
28[Homebrew](https://brew.sh) をインストールしている場合は、タップして QMK をインストールすることができます: 18[Homebrew](https://brew.sh) をインストールしている場合は、タップして QMK をインストールすることができます:
29 19
@@ -34,7 +24,7 @@ export QMK_HOME='~/qmk_firmware' # オプション、`qmk_firmware` の場所を
34qmk setup # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします 24qmk setup # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします
35``` 25```
36 26
37## easy_install あるいは pip を使ってインストール 27### easy_install あるいは pip を使ってインストール :id=install-using-easy_install-or-pip
38 28
39上のリストにあなたのシステムがない場合は、QMK を手動でインストールすることができます。最初に、python 3.5 (以降)をインストールしていて、pip をインストールしていることを確認してください。次に以下のコマンドを使って QMK をインストールします: 29上のリストにあなたのシステムがない場合は、QMK を手動でインストールすることができます。最初に、python 3.5 (以降)をインストールしていて、pip をインストールしていることを確認してください。次に以下のコマンドを使って QMK をインストールします:
40 30
@@ -44,7 +34,7 @@ export QMK_HOME='~/qmk_firmware' # オプション、`qmk_firmware` の場所を
44qmk setup # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします 34qmk setup # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします
45``` 35```
46 36
47## 他のオペレーティングシステムのためのパッケージ 37### 他のオペレーティングシステムのためのパッケージ :id=packaging-for-other-operating-systems
48 38
49より多くのオペレーティングシステム用に `qmk` パッケージを作成および保守する人を探しています。OS 用のパッケージを作成する場合は、以下のガイドラインに従ってください: 39より多くのオペレーティングシステム用に `qmk` パッケージを作成および保守する人を探しています。OS 用のパッケージを作成する場合は、以下のガイドラインに従ってください:
50 40
@@ -52,247 +42,3 @@ qmk setup # これは `qmk/qmk_firmware` をクローンし、オプション
52 * 逸脱する場合は、理由をコメントに文章化してください。 42 * 逸脱する場合は、理由をコメントに文章化してください。
53* virtualenv を使ってインストールしてください 43* virtualenv を使ってインストールしてください
54* 環境変数 `QMK_HOME` を設定して、ファームウェアソースを `~/qmk_firmware` 以外のどこかにチェックアウトするようにユーザに指示してください。 44* 環境変数 `QMK_HOME` を設定して、ファームウェアソースを `~/qmk_firmware` 以外のどこかにチェックアウトするようにユーザに指示してください。
55
56# ローカル CLI :id=local-cli
57
58グローバル CLI を使いたくない場合は、`qmk_firmware` に付属のローカル CLI があります。`qmk_firmware/bin/qmk` で見つけることができます。任意のディレクトリから `qmk` コマンドを実行でき、常に `qmk_firmware` のコピー上で動作します。
59
60**例**:
61
62```
63$ ~/qmk_firmware/bin/qmk hello
64Ψ Hello, World!
65```
66
67## ローカル CLI の制限
68
69グローバル CLI と比較して、ローカル CLI には幾つかの制限があります:
70
71* ローカル CLI は `qmk setup` あるいは `qmk clone` をサポートしません。
72* 複数のリポジトリがクローンされている場合でも、ローカル CLI は常に `qmk_firmware` ツリー上で動作します。
73* ローカル CLI は virtualenv で動作しません。そのため依存関係が競合する可能性があります
74
75# CLI コマンド :id=cli-commands
76
77## `qmk cformat`
78
79このコマンドは clang-format を使って C コードを整形します。引数無しで実行して全てのコアコードを整形するか、コマンドラインでファイル名を渡して特定のファイルに対して実行します。
80
81**使用法**:
82
83```
84qmk cformat [file1] [file2] [...] [fileN]
85```
86
87## `qmk compile`
88
89このコマンドにより、任意のディレクトリからファームウェアをコンパイルすることができます。<https://config.qmk.fm> からエクスポートした JSON をコンパイルするか、リポジトリ内でキーマップをコンパイルするか、現在の作業ディレクトリでキーボードをコンパイルすることができます。
90
91**Configurator Exports での使い方**:
92
93```
94qmk compile <configuratorExport.json>
95```
96
97**キーマップでの使い方**:
98
99```
100qmk compile -kb <keyboard_name> -km <keymap_name>
101```
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
150## `qmk flash`
151
152このコマンドは `qmk compile` に似ていますが、ブートローダを対象にすることもできます。ブートローダはオプションで、デフォルトでは `:flash` に設定されています。
153違うブートローダを指定するには、`-bl <bootloader>` を使ってください。利用可能なブートローダの詳細については、<https://docs.qmk.fm/#/ja/flashing>
154を見てください。
155
156**Configurator Exports での使い方**:
157
158```
159qmk flash <configuratorExport.json> -bl <bootloader>
160```
161
162**キーマップでの使い方**:
163
164```
165qmk flash -kb <keyboard_name> -km <keymap_name> -bl <bootloader>
166```
167
168**ブートローダのリスト**
169
170```
171qmk flash -b
172```
173
174## `qmk config`
175
176このコマンドにより QMK の挙動を設定することができます。完全な `qmk config` のドキュメントについては、[CLI 設定](ja/cli_configuration.md)を見てください。
177
178**使用法**:
179
180```
181qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
182```
183
184## `qmk docs`
185
186このコマンドは、ドキュメントを参照または改善するために使うことができるローカル HTTP サーバを起動します。デフォルトのポートは 8936 です。
187
188**使用法**:
189
190```
191qmk docs [-p PORT]
192```
193
194## `qmk doctor`
195
196このコマンドは環境を調査し、潜在的なビルドあるいは書き込みの問題について警告します。必要に応じてそれらの多くを修正できます。
197
198**使用法**:
199
200```
201qmk doctor [-y] [-n]
202```
203
204**例**:
205
206環境に問題がないか確認し、それらを修正するよう促します:
207
208 qmk doctor
209
210環境を確認し、見つかった問題を自動的に修正します:
211
212 qmk doctor -y
213
214環境を確認し、問題のみをレポートします:
215
216 qmk doctor -n
217
218## `qmk json2c`
219
220QMK Configurator からエクスポートしたものから keymap.c を生成します。
221
222**使用法**:
223
224```
225qmk json2c [-o OUTPUT] filename
226```
227
228## `qmk kle2json`
229
230このコマンドにより、生の KLE データから QMK Configurator の JSON へ変換することができます。絶対パスあるいは現在のディレクトリ内のファイル名のいずれかを受け取ります。デフォルトでは、`info.json` が既に存在している場合は上書きしません。上書きするには、`-f` あるいは `--force` フラグを使ってください。
231
232**使用法**:
233
234```
235qmk kle2json [-f] <filename>
236```
237
238**例**:
239
240```
241$ qmk kle2json kle.txt
242☒ File info.json already exists, use -f or --force to overwrite.
243```
244
245```
246$ qmk kle2json -f kle.txt -f
247Ψ Wrote out to info.json
248```
249
250## `qmk list-keyboards`
251
252このコマンドは現在 `qmk_firmware` で定義されている全てのキーボードをリスト化します。
253
254**使用法**:
255
256```
257qmk list-keyboards
258```
259
260## `qmk list-keymaps`
261
262このコマンドは指定されたキーボード(とリビジョン)の全てのキーマップをリスト化します。
263
264**使用法**:
265
266```
267qmk list-keymaps -kb planck/ez
268```
269
270## `qmk new-keymap`
271
272このコマンドは、キーボードの既存のデフォルトのキーマップに基づいて新しいキーマップを作成します。
273
274**使用法**:
275
276```
277qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
278```
279
280## `qmk pyformat`
281
282このコマンドは `qmk_firmware` 内の python コードを整形します。
283
284**使用法**:
285
286```
287qmk pyformat
288```
289
290## `qmk pytest`
291
292このコマンドは python のテストスィートを実行します。python コードに変更を加えた場合、これの実行が成功することを確認する必要があります。
293
294**使用法**:
295
296```
297qmk pytest
298```