aboutsummaryrefslogtreecommitdiff
path: root/docs/de/cli.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/de/cli.md')
-rw-r--r--docs/de/cli.md169
1 files changed, 169 insertions, 0 deletions
diff --git a/docs/de/cli.md b/docs/de/cli.md
new file mode 100644
index 000000000..437062ad6
--- /dev/null
+++ b/docs/de/cli.md
@@ -0,0 +1,169 @@
1# QMK CLI (Kommandozeile)
2
3Diese Seite beschreibt die Einrichtung und den Umgang mit dem QMK CLI (Kommandozeile).
4
5# Übersicht
6
7Die QMK CLI vereinfacht das Zusammenbauen und Arbeiten mit QMK Tastaturen. Hier findest Du wichtige Befehle, um beispielsweise das Herunterladen und Kompilieren der QMK Firmware oder das Erstellen von Tastaturbelegungen (und vieles mehr) zu erleichtern.
8
9* [Globale CLI](#globale-cli)
10* [Lokale CLI](#lokale-cli)
11* [CLI-Befehle](#cli-befehle)
12
13# System-Anforderungen
14
15Die CLI benötigt Python 3.5 oder höher. Außerdem ist es nötig, die Packages laut [`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt) zu installieren.
16
17# Globale CLI
18
19QMK bietet ein installierbares CLI, das Du zum Einrichten Deiner QMK Build-Umgebung verwenden kannst. Dieses ermöglicht Dir das Arbeiten mit QMK, und erleichtert das Arbeiten mit mehreren Kopien der `qmk_firmware`. Wir empfehlen, dieses CLI zu installieren und regelmäßig upzudaten.
20
21## Installation mit Homebrew (macOS, manche Linux)
22
23Solltest Du [Homebrew](https://brew.sh) installiert haben, kannst Du QMK per tap installieren:
24
25```
26brew tap qmk/qmk
27brew install qmk
28export QMK_HOME='~/qmk_firmware' # Optional: setzt den Installationsort für `qmk_firmware`
29qmk setup # Dies klont `qmk/qmk_firmware` und richtet optional auch Deine Build-Umgebung ein
30```
31
32## Installation mit easy_install oder pip
33
34Falls Du kein Homebrew hast, kannst Du QMK auch manuell installieren. Zuerst musst Du sicherstellen, dass Python 3.5 (oder höher) und pip installiert ist. Dann installiere QMK mit diesem Befehl:
35
36```
37pip3 install qmk
38export QMK_HOME='~/qmk_firmware' # Optional: setzt den Installationsort für `qmk_firmware`
39qmk setup # Dies klont `qmk/qmk_firmware` und richtet optional auch Deine Build-Umgebung ein
40```
41## Installation mit git Repo
42
43`git clone https://github.com/qmk/qmk_cli.git && cd qmk_cli && python3 setup.py install`
44
45## Packaging für andere Betriebssysteme
46
47Wir suchen nach Freiwilligen, die ein `qmk`-Package für weitere Betriebssysteme erstellen und pflegen. Falls Du ein Package für Dein OS erstellen möchtest, bitte befolge diese Richtlinien:
48
49* Verwende "Best Practices" für Dein OS, sollten sie mit diesen Richtlinien in Konflikt stehen.
50 * Dokumentiere den Grund in einem Kommentar, wenn Du abweichen musstest.
51* Installiere mit einem [virtualenv](https://virtualenv.pypa.io/en/latest/).
52* Weise den User an, die Umgebungs-Variable `QMK_HOME` zu setzen, um die Firmware-Quelle anders einzustellen als `~/qmk_firmware`.
53
54# Lokale CLI
55
56Wenn Du die globale CLI nicht verwenden möchtest, beinhaltet `qmk_firmware` auch eine lokale CLI. Du kannst sie hier finden: `qmk_firmware/bin/qmk`. Du kannst den `qmk`-Befehl aus irgendeinem Datei-Verzeichnis ausführen und es wird immer auf dieser Kopie von `qmk_firmware` arbeiten.
57
58**Beispiel**:
59
60```
61$ ~/qmk_firmware/bin/qmk hello
62Ψ Hello, World!
63```
64
65## Einschränkungen der lokalen CLI
66
67Hier ein Vergleich mit der globalen CLI:
68
69* Die lokale CLI unterstützt kein `qmk setup` oder `qmk clone`.
70* Die lokale CLI arbeitet immer innerhalb der selben `qmk_firmware`-Verzeichnisstruktur, auch wenn Du mehrere Repositories geklont hast.
71* Die lokale CLI läuft nicht in einer virtualenv. Daher ist es möglich, dass Abhängigkeiten (dependencies) miteinander in Konflikt kommen/stehen.
72
73# CLI-Befehle
74
75## `qmk compile`
76
77Dieser Befehl erlaubt es dir, die Firmware - aus egal welchem Datei-Verzeichnis - zu compilen. Du kannst JSON-Exporte von <https://config.qmk.fm> oder Keymaps in der Repo kompilen.
78
79**Anwendung für Konfigurations-Exports**:
80
81```
82qmk compile <configuratorExport.json>
83```
84
85**Anwendung für Keymaps**:
86
87```
88qmk compile -kb <keyboard_name> -km <keymap_name>
89```
90
91## `qmk cformat`
92
93Dieser Befehl formatiert C-Code im clang-Format. Benutze ihn ohne Argumente, um den core-Code zu formatieren, oder benutze Namen von Dateien in der CLI, um den Befehl auf bestimmte Dateien anzuwenden.
94
95**Anwendung**:
96
97```
98qmk cformat [file1] [file2] [...] [fileN]
99```
100
101## `qmk config`
102
103Dieser Befehl konfiguriert das Verhalten von QMK. Für die volle `qmk config`-Dokumentation gehe zu [CLI-Konfiguration](cli_configuration.md).
104
105**Anwendung**:
106
107```
108qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
109```
110
111## `qmk docs`
112
113Dieser Befehl startet einen lokalen HTTP-Server, den Du zum Browsen oder Verbessern der Dokumentation verwenden kannst. Der Default-Port ist 8936.
114
115**Anwendung**:
116
117```
118qmk docs [-p PORT]
119```
120
121## `qmk doctor`
122
123Dieser Befehl untersucht Deine Umgebung und warnt Dich vor potentiellen Build- oder Flash-Problemen.
124
125**Anwendung**:
126
127```
128qmk doctor
129```
130
131## `qmk list-keyboards`
132
133Dieser Befehl listet alle zurzeit in `qmk_firmware` definierten Tastaturen/Keyboards auf.
134
135**Anwendung**:
136
137```
138qmk list-keyboards
139```
140
141## `qmk new-keymap`
142
143Dieser Befehl erstellt eine neue Keymap basierend auf einer existierenden Standard-Keymap eines bestimmten Keyboards.
144
145**Anwendung**:
146
147```
148qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
149```
150
151## `qmk pyformat`
152
153Dieser Befehl formatiert Python-Code in `qmk_firmware`.
154
155**Anwendung**:
156
157```
158qmk pyformat
159```
160
161## `qmk pytest`
162
163Dieser Befehl führt die Python Test Suite aus. Wenn Du Python-Code veränderst, solltest Du sicherstellen, dass der Test erfolgreich ausgeführt wurde.
164
165**Anwendung**:
166
167```
168qmk pytest
169```