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.md150
1 files changed, 0 insertions, 150 deletions
diff --git a/docs/de/cli.md b/docs/de/cli.md
deleted file mode 100644
index 259aeecf7..000000000
--- a/docs/de/cli.md
+++ /dev/null
@@ -1,150 +0,0 @@
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# CLI-Befehle
55
56## `qmk compile`
57
58Dieser 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.
59
60**Anwendung für Konfigurations-Exports**:
61
62```
63qmk compile <configuratorExport.json>
64```
65
66**Anwendung für Keymaps**:
67
68```
69qmk compile -kb <keyboard_name> -km <keymap_name>
70```
71
72## `qmk format-c`
73
74Dieser 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.
75
76**Anwendung**:
77
78```
79qmk format-c [file1] [file2] [...] [fileN]
80```
81
82## `qmk config`
83
84Dieser Befehl konfiguriert das Verhalten von QMK. Für die volle `qmk config`-Dokumentation gehe zu [CLI-Konfiguration](cli_configuration.md).
85
86**Anwendung**:
87
88```
89qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
90```
91
92## `qmk docs`
93
94Dieser Befehl startet einen lokalen HTTP-Server, den Du zum Browsen oder Verbessern der Dokumentation verwenden kannst. Der Default-Port ist 8936.
95
96**Anwendung**:
97
98```
99qmk docs [-p PORT]
100```
101
102## `qmk doctor`
103
104Dieser Befehl untersucht Deine Umgebung und warnt Dich vor potentiellen Build- oder Flash-Problemen.
105
106**Anwendung**:
107
108```
109qmk doctor
110```
111
112## `qmk list-keyboards`
113
114Dieser Befehl listet alle zurzeit in `qmk_firmware` definierten Tastaturen/Keyboards auf.
115
116**Anwendung**:
117
118```
119qmk list-keyboards
120```
121
122## `qmk new-keymap`
123
124Dieser Befehl erstellt eine neue Keymap basierend auf einer existierenden Standard-Keymap eines bestimmten Keyboards.
125
126**Anwendung**:
127
128```
129qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
130```
131
132## `qmk format-py`
133
134Dieser Befehl formatiert Python-Code in `qmk_firmware`.
135
136**Anwendung**:
137
138```
139qmk format-py
140```
141
142## `qmk pytest`
143
144Dieser Befehl führt die Python Test Suite aus. Wenn Du Python-Code veränderst, solltest Du sicherstellen, dass der Test erfolgreich ausgeführt wurde.
145
146**Anwendung**:
147
148```
149qmk pytest
150```