docs/ja/cli.md

   1 # QMK CLI
   2
   3 <!---
   4   original document: d598f01cb:cli.md
   5   git diff d598f01cb HEAD cli.md | cat
   6 -->
   7
   8 このページは QMK CLI のセットアップと使用方法について説明します。
   9
  10 # 概要
  11
  12 QMK CLI を使用すると QMK キーボードの構築と作業が簡単になります。QMK ファームウェアの取得とコンパイル、キーマップの作成などのようなタスクを簡素化し合理化するためのコマンドを多く提供します。
  13
  14 * [グローバル CLI](#global-cli)
  15 * [ローカル CLI](#local-cli)
  16 * [CLI コマンド](#cli-commands)
  17
  18 # 必要事項
  19
  20 CLI は Python 3.5 以上を必要とします。我々は必要事項の数を少なくしようとしていますが、[`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt) にリストされているパッケージもインストールする必要があります。
  21
  22 # グローバル CLI :id=global-cli
  23
  24 QMK は、QMK ビルド環境のセットアップ、QMK の操作、および `qmk_firmware` の複数のコピーの操作を容易にできるインストール可能な CLI を提供します。これを定期的にインストールおよび更新することをお勧めします。
  25
  26 ## Homebrew を使ったインストール (macOS、いくつかの Linux)
  27
  28 [Homebrew](https://brew.sh) をインストールしている場合は、タップして QMK をインストールすることができます:
  29
  30 ```
  31 brew tap qmk/qmk
  32 brew install qmk
  33 export QMK_HOME='~/qmk_firmware' # オプション、`qmk_firmware` の場所を設定します
  34 qmk setup  # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします
  35 ```
  36
  37 ## easy_install あるいは pip を使ってインストール
  38
  39 上のリストにあなたのシステムがない場合は、QMK を手動でインストールすることができます。最初に、python 3.5 (以降)をインストールしていて、pip をインストールしていることを確認してください。次に以下のコマンドを使って QMK をインストールします:
  40
  41 ```
  42 pip3 install qmk
  43 export QMK_HOME='~/qmk_firmware' # オプション、`qmk_firmware` の場所を設定します
  44 qmk setup  # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします
  45 ```
  46
  47 ## 他のオペレーティングシステムのためのパッケージ
  48
  49 より多くのオペレーティングシステム用に `qmk` パッケージを作成および保守する人を探しています。OS 用のパッケージを作成する場合は、以下のガイドラインに従ってください:
  50
  51 * これらのガイドラインと矛盾する場合は、OS のベストプラクティスに従ってください
  52    * 逸脱する場合は、理由をコメントに文章化してください。
  53 * virtualenv を使ってインストールしてください
  54 * 環境変数 `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 ```
  84 qmk cformat [file1] [file2] [...] [fileN]
  85 ```
  86
  87 ## `qmk compile`
  88
  89 このコマンドにより、任意のディレクトリからファームウェアをコンパイルすることができます。<https://config.qmk.fm> からエクスポートした JSON をコンパイルするか、リポジトリ内でキーマップをコンパイルすることができます。
  90
  91 **Configurator Exports での使い方**:
  92
  93 ```
  94 qmk compile <configuratorExport.json>
  95 ```
  96
  97 **キーマップでの使い方**:
  98
  99 ```
 100 qmk compile -kb <keyboard_name> -km <keymap_name>
 101 ```
 102
 103 ## `qmk flash`
 104
 105 このコマンドは `qmk compile` に似ていますが、ブートローダを対象にすることもできます。ブートローダはオプションで、デフォルトでは `:flash` に設定されています。
 106 違うブートローダを指定するには、`-bl <bootloader>` を使ってください。利用可能なブートローダの詳細については、<https://docs.qmk.fm/#/ja/flashing>
 107 を見てください。
 108
 109 **Configurator Exports での使い方**:
 110
 111 ```
 112 qmk flash <configuratorExport.json> -bl <bootloader>
 113 ```
 114
 115 **キーマップでの使い方**:
 116
 117 ```
 118 qmk flash -kb <keyboard_name> -km <keymap_name> -bl <bootloader>
 119 ```
 120
 121 **ブートローダのリスト**
 122
 123 ```
 124 qmk flash -b
 125 ```
 126
 127 ## `qmk config`
 128
 129 このコマンドにより QMK の挙動を設定することができます。完全な `qmk config` のドキュメントについては、[CLI 設定](ja/cli_configuration.md)を見てください。
 130
 131 **使用法**:
 132
 133 ```
 134 qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
 135 ```
 136
 137 ## `qmk docs`
 138
 139 このコマンドは、ドキュメントを参照または改善するために使うことができるローカル HTTP サーバを起動します。デフォルトのポートは 8936 です。
 140
 141 **使用法**:
 142
 143 ```
 144 qmk docs [-p PORT]
 145 ```
 146
 147 ## `qmk doctor`
 148
 149 このコマンドは環境を調査し、潜在的なビルドあるいは書き込みの問題について警告します。
 150
 151 **使用法**:
 152
 153 ```
 154 qmk doctor
 155 ```
 156
 157 ## `qmk json-keymap`
 158
 159 QMK Configurator からエクスポートしたものから keymap.c を生成します。
 160
 161 **使用法**:
 162
 163 ```
 164 qmk json-keymap [-o OUTPUT] filename
 165 ```
 166
 167 ## `qmk kle2json`
 168
 169 このコマンドにより、生の KLE データから QMK Configurator の JSON へ変換することができます。絶対パスあるいは現在のディレクトリ内のファイル名のいずれかを受け取ります。デフォルトでは、`info.json` が既に存在している場合は上書きしません。上書きするには、`-f` あるいは `--force` フラグを使ってください。
 170
 171 **使用法**:
 172
 173 ```
 174 qmk kle2json [-f] <filename>
 175 ```
 176
 177 **例**:
 178
 179 ```
 180 $ qmk kle2json kle.txt
 181 ☒ File info.json already exists, use -f or --force to overwrite.
 182 ```
 183
 184 ```
 185 $ qmk kle2json -f kle.txt -f
 186 Ψ Wrote out to info.json
 187 ```
 188
 189 ## `qmk list-keyboards`
 190
 191 このコマンドは現在 `qmk_firmware` で定義されている全てのキーボードをリスト化します。
 192
 193 **使用法**:
 194
 195 ```
 196 qmk list-keyboards
 197 ```
 198
 199 ## `qmk new-keymap`
 200
 201 このコマンドは、キーボードの既存のデフォルトのキーマップに基づいて新しいキーマップを作成します。
 202
 203 **使用法**:
 204
 205 ```
 206 qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
 207 ```
 208
 209 ## `qmk pyformat`
 210
 211 このコマンドは `qmk_firmware` 内の python コードを整形します。
 212
 213 **使用法**:
 214
 215 ```
 216 qmk pyformat
 217 ```
 218
 219 ## `qmk pytest`
 220
 221 このコマンドは python のテストスィートを実行します。python コードに変更を加えた場合、これの実行が成功することを確認する必要があります。
 222
 223 **使用法**:
 224
 225 ```
 226 qmk pytest
 227 ```