aboutsummaryrefslogtreecommitdiff
path: root/docs/fr-fr/cli.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/fr-fr/cli.md')
-rw-r--r--docs/fr-fr/cli.md146
1 files changed, 146 insertions, 0 deletions
diff --git a/docs/fr-fr/cli.md b/docs/fr-fr/cli.md
new file mode 100644
index 000000000..428153645
--- /dev/null
+++ b/docs/fr-fr/cli.md
@@ -0,0 +1,146 @@
1# La CLI de QMK
2
3Cette page décrit comment configurer et utiliser la CLI QMK.
4
5# Vue d'ensemble
6
7La CLI de QMK permet de simplifier la compilation et l'interaction avec les claviers QMK. Nous avons défini plusieurs commandes pour simplifier et rationaliser les tâches telles qu'obtenir et compiler le firmware QMK, créer de nouvelles keymaps, et plus.
8
9* [CLI globale](#global-cli)
10* [CLI locale](#local-cli)
11* [Les commandes CLI](#cli-commands)
12
13# Pré-requis
14
15La CLI nécessite Python 3.5 ou plus récent. Nous essayons de limiter le nombre de pré-requis, mais vous allez aussi devoir installer les paquets listés dans le fichier [`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt).
16
17# CLI globale
18
19QMK met à disposition une CLI installable qui peut être utilisée pour configurer votre environnement de compilation QMK, fonctionne avec QMK, et qui rend l'utilisation de plusieurs copies de `qmk_firmware` plus simple. Nous recommandons d'installer et de mettre à jour ceci régulièrement.
20
21## Installer en utilisant Homebrew (macOS, quelques Linux)
22
23Si vous avez installé [Homebrew](https://brew.sh) vous pouvez entrer ce qui suit et installer QMK:
24
25```
26brew tap qmk/qmk
27brew install qmk
28export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
29qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
30```
31
32## Installer en utilisant easy_install ou pip
33
34Si votre système n'est pas listé ci-dessus, vous pouvez installer QMK manuellement. Premièrement, vérifiez que vous avez bien installé Python 3.5 (ou plus récent) et pip. Ensuite, installez QMK avec cette commande:
35
36```
37pip3 install qmk
38export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
39qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
40```
41
42## Paquets pour d'autres systèmes d'exploitation
43
44Nous recherchons des gens pour créer et maintenir un paquet `qmk` pour plus de systèmes d'exploitation. Si vous voulez créer un paquet pour votre système d'exploitation, suivez ces directives:
45
46* Suivez les bonnes pratiques pour votre système d'exploitation lorsqu'elles entrent en conflit avec ces directives
47 * Documentez pourquoi dans un commentaire lorsque vous ne les suivez pas
48* Installez en utilisant un virtualenv
49* Expliquez à l'utilisateur de définir la variable d'environnement `QMK_Home` pour "check out" les sources du firmware à un autre endroit que `~/qmk_firmware`.
50
51# CLI locale
52
53Si vous ne voulez pas utiliser la CLI globale, il y a une CLI locale empaquetée avec `qmk_firmware`. Vous pouvez le trouver dans `qmk_firmware/bin/qmk`. Vous pouvez lancer la commande `qmk` depuis n'importe quel répertoire et elle fonctionnera toujours sur cette copie de `qmk_firmware`.
54
55**Exemple**:
56
57```
58$ ~/qmk_firmware/bin/qmk hello
59Ψ Hello, World!
60```
61
62## Limitations de la CLI locale
63
64Il y a quelques limitations à la CLI locale comparé à la globale:
65
66* La CLI locale ne supporte pas `qmk setup` ou `qmk clone`
67* La CLI locale n'opère pas sur le même arbre `qmk_firmware`, même si vous avez plusieurs dépôts clonés.
68* La CLI locale ne s'exécute pas dans un virtualenv, donc il y a des risques que des dépendances seront en conflit
69
70# Les commandes CLI
71
72## `qmk compile`
73
74Cette commande permet de compiler le firmware de n'importe quel répertoire. Vous pouvez compiler des exports JSON de <https://config.qmk.fm> ou compiler des keymaps du dépôt.
75
76**Utilisation pour les exports de configuration**:
77
78```
79qmk compile <configuratorExport.json>
80```
81
82**Utilisation pour les Keymaps**:
83
84```
85qmk compile -kb <keyboard_name> -km <keymap_name>
86```
87
88## `qmk cformat`
89
90Cette commande formatte le code C en utilisant clang-format. Lancez-la sans arguments pour formatter tout le code core, ou passez les noms de fichiers à la ligne de commande pour la lancer sur des fichiers spécifiques.
91
92**Utilisation**:
93
94```
95qmk cformat [file1] [file2] [...] [fileN]
96```
97
98## `qmk config`
99
100Cette commande vous permet de configurer le comportement de QMK. Pour la documentation complète de `qmk config`, regardez [Configuration de CLI](cli_configuration.md).
101
102**Utilisation**:
103
104```
105qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
106```
107
108## `qmk doctor`
109
110Cette commande examine votre environnement et vous alertes des potentiels problèmes de compilation ou de flash.
111
112**Utilisation**:
113
114```
115qmk doctor
116```
117
118## `qmk new-keymap`
119
120Cette commande crée une nouvelle keymap basée sur une keymap par défaut d'un clavier existant.
121
122**Utilisation**:
123
124```
125qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
126```
127
128## `qmk pyformat`
129
130Cette commande formate le code python dans `qmk_firmware`.
131
132**Utilisation**:
133
134```
135qmk pyformat
136```
137
138## `qmk pytest`
139
140Cette commande démarre la suite de test python. Si vous faites des changements dans le code Python, assurez-vous que les tests se lancent avec succès.
141
142**Utilisation**:
143
144```
145qmk pytest
146```