docs/ja/cli_configuration.md

   1 # QMK CLI 設定
   2
   3 <!---
   4   original document: d598f01cb:cli_configuration.md
   5   git diff d598f01cb HEAD cli_configuration.md | cat
   6 -->
   7
   8 このドキュメントは `qmk config` がどのように動作するかを説明します。
   9
  10 # はじめに
  11
  12 QMK CLI の設定はキーバリューシステムです。各キーはピリオドで区切られたサブコマンドと引数名で構成されます。これにより、設定キーと設定された引数の間で簡単かつ直接的な変換が可能になります。
  13
  14 ## 簡単な例
  15
  16 例として、`qmk compile --keyboard clueboard/66/rev4 --keymap default` コマンドを見てみましょう。
  17
  18 設定から読み取ることができる2つのコマンドライン引数があります:
  19
  20 * `compile.keyboard`
  21 * `compile.keymap`
  22
  23 これらを設定してみましょう:
  24
  25 ```
  26 $ qmk config compile.keyboard=clueboard/66/rev4 compile.keymap=default
  27 compile.keyboard: None -> clueboard/66/rev4
  28 compile.keymap: None -> default
  29 Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
  30 ```
  31
  32 これで、毎回キーボードとキーマップを設定することなく、`qmk compile` を実行することができます。
  33
  34 ## ユーザデフォルトの設定
  35
  36 複数のコマンド間で設定を共有したい場合があります。例えば、いくつかのコマンドは引数 `--keyboard` を受け取ります。全てのコマンドでこの値を設定する代わりに、その引数を受け取る全てのコマンドで使われるユーザ値を設定することができます。
  37
  38 例:
  39
  40 ```
  41 $ qmk config user.keyboard=clueboard/66/rev4 user.keymap=default
  42 user.keyboard: None -> clueboard/66/rev4
  43 user.keymap: None -> default
  44 Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
  45 ```
  46
  47 # CLI ドキュメント (`qmk config`)
  48
  49 `qmk config` コマンドは基礎となる設定とやり取りするために使われます。引数無しで実行すると、現在の設定を表示します。引数が指定された場合、それらは設定トークンと見なされます。設定トークンは以下の形式の空白を含まない文字列です:
  50
  51     <subcommand|general|default>[.<key>][=<value>]
  52
  53 ## 設定値の設定
  54
  55 設定キーに等号 (=) を入れることで、設定値を設定することができます。キーは常に完全な `<section>.<key>` 形式である必要があります。
  56
  57 例:
  58
  59 ```
  60 $ qmk config default.keymap=default
  61 default.keymap: None -> default
  62 Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
  63 ```
  64
  65 ## 設定値の読み込み
  66
  67 設定全体、単一のキー、あるいはセクション全体の設定値を読み取ることができます。1つ以上の値を表示するために複数のキーを指定することができます。
  68
  69 ### 全体の構成例
  70
  71     qmk config
  72
  73 ### セクション全体の例
  74
  75     qmk config compile
  76
  77 ### 単一キーの例
  78
  79     qmk config compile.keyboard
  80
  81 ### 複数キーの例
  82
  83     qmk config user compile.keyboard compile.keymap
  84
  85 ## 設定値の削除
  86
  87 設定値を特別な文字列 `None` に設定することで、設定値を削除することができます。
  88
  89 例:
  90
  91 ```
  92 $ qmk config default.keymap=None
  93 default.keymap: default -> None
  94 Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
  95 ```
  96
  97 ## 複数の操作
  98
  99 複数の読み込みおよび書き込み操作を1つのコマンドに組み合わせることができます。それらは順番に実行および表示されます:
 100
 101 ```
 102 $ qmk config compile default.keymap=default compile.keymap=None
 103 compile.keymap=skully
 104 compile.keyboard=clueboard/66_hotswap/gen1
 105 default.keymap: None -> default
 106 compile.keymap: skully -> None
 107 Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
 108 ```
 109
 110 # ユーザ設定オプション
 111
 112 | キー | デフォルト値 | 説明 |
 113 |-----|---------------|-------------|
 114 | user.keyboard | None | キーボードのパス (例: `clueboard/66/rev4`) |
 115 | user.keymap | None | キーマップ名 (例: `default`) |
 116 | user.name | None | ユーザの github のユーザ名。 |
 117
 118 # 全ての設定オプション
 119
 120 | キー | デフォルト値 | 説明 |
 121 |-----|---------------|-------------|
 122 | compile.keyboard | None | キーボードのパス (例: `clueboard/66/rev4`) |
 123 | compile.keymap | None | キーマップ名 (例: `default`) |
 124 | hello.name | None | 実行時の挨拶の名前 |
 125 | new_keyboard.keyboard | None | キーボードのパス (例: `clueboard/66/rev4`) |
 126 | new_keyboard.keymap | None | キーマップ名 (例: `default`) |