You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

121 lines
4.5 KiB

  1. # Configuration de QMK CLI
  2. Ce document explique comment fonctionne la commande `qmk config`.
  3. # Introduction
  4. La configuration pour QMK CLI est un système clé/valeur. Chaque clé est composée d'une sous-commande et d'un argument séparé par une virgule. Cela permet une traduction simple et directe entre les clés de configuration et l'argument qu'elle définit.
  5. ## Exemple simple
  6. Comme exemple, regardons la commande `qmk compile --keyboard clueboard/66/rev4 --keymap default`.
  7. Il y a deux arguments de ligne de commande qui peuvent être lu de la configuration:
  8. * `compile.keyboard`
  9. * `compile.keymap`
  10. Essayons de les définir:
  11. ```shell
  12. $ qmk config compile.keyboard=clueboard/66/rev4 compile.keymap=default
  13. compile.keyboard: None -> clueboard/66/rev4
  14. compile.keymap: None -> default
  15. Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
  16. ```
  17. Maintenant, je peux lancer la commande `qmk compile` sans avoir à spécifier mon clavier et keymap à chaque fois.
  18. ## Définir les options par défaut
  19. Parfois, il est utile de partager une configuration entre plusieurs commandes. Par exemple, plusieurs commandes prennent un argument `--keyboard`. Plutôt que de devoir définir cette valeur pour chaque commande, vous pouvez définir une valeur d'utilisateur qui sera utilisée par toutes les commandes qui prennent cet argument.
  20. Exemple:
  21. ```
  22. $ qmk config user.keyboard=clueboard/66/rev4 user.keymap=default
  23. user.keyboard: None -> clueboard/66/rev4
  24. user.keymap: None -> default
  25. Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
  26. ```
  27. # CLI Documentation (`qmk config`)
  28. La commande `qmk config` est utilisée pour interagir avec la configuration sous-jacente. Lancée sans argument, elle affiche la configuration courante. Lorsque des arguments sont définis, ils sont considérés comme étant des jetons de configuration, qui sont des chaînes de caractère ne contenant aucun espace avec le format suivant:
  29. <subcommand|general|default>[.<key>][=<value>]
  30. ## Définir des valeurs de configuration
  31. Vous pouvez définir des valeurs de configuration en mettant le caractère égal (=) dans votre clé de configuration. La clé doit toujours être dans le format complet `<section>.<key>`.
  32. Exemple:
  33. ```
  34. $ qmk config default.keymap=default
  35. default.keymap: None -> default
  36. Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
  37. ```
  38. ## Lire des valeurs de configuration
  39. Vous pouvez lire les valeurs de configuration pour la totalité de la configuration, une seule clé, ou une section entière. Vous pouvez aussi spécifier plusieurs clés pour afficher plus d'une valeur.
  40. ### Exemple avec la totalité de la configuration
  41. qmk config
  42. ### Exemple avec une section entière
  43. qmk config compile
  44. ### Exemple avec une clé unique
  45. qmk config compile.keyboard
  46. ### Exemple avec plusieurs clés
  47. qmk config user compile.keyboard compile.keymap
  48. ## Supprimer des valeurs de configuration
  49. Vous pouvez supprimer une valeur de configuration en la définissant avec la chaîne spéciale `None`.
  50. Exemple:
  51. ```
  52. $ qmk config default.keymap=None
  53. default.keymap: default -> None
  54. Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
  55. ```
  56. ## Plusieurs opérations
  57. Vous pouvez combiner plusieurs opérations d'écriture et de lecture en une seule commande. Elles seront exécutées et affichées dans l'ordre:
  58. ```
  59. $ qmk config compile default.keymap=default compile.keymap=None
  60. compile.keymap=skully
  61. compile.keyboard=clueboard/66_hotswap/gen1
  62. default.keymap: None -> default
  63. compile.keymap: skully -> None
  64. Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'
  65. ```
  66. # Options de configuration utilisateur
  67. | Clé | Valeur par défaut | Description |
  68. |-----|---------------|-------------|
  69. | user.keyboard | None | Le chemin d'accès vers le clavier (Exemple: `clueboard/66/rev4`) |
  70. | user.keymap | None | Le nom de la keymap (Exemple: `default`) |
  71. | user.name | None | Le nom d'utilisateur GitHub de l'utilisateur. |
  72. # Toutes les options de configuration
  73. | Clé | Valeur par défaut | Description |
  74. |-----|---------------|-------------|
  75. | compile.keyboard | None | Le chemin d'accès vers le clavier (Exemple: `clueboard/66/rev4`) |
  76. | compile.keymap | None | Le nom de la keymap (Exemple: `default`) |
  77. | hello.name | None | Le nom à saluer lorsque démarré. |
  78. | new_keyboard.keyboard | None | Le chemin d'accès vers le clavier (Exemple: `clueboard/66/rev4`) |
  79. | new_keyboard.keymap | None | Le nom de la keymap (Example: `default`) |