diff options
Diffstat (limited to 'docs/cli.md')
-rw-r--r-- | docs/cli.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/cli.md b/docs/cli.md new file mode 100644 index 000000000..0365f2c9c --- /dev/null +++ b/docs/cli.md | |||
@@ -0,0 +1,31 @@ | |||
1 | # QMK CLI | ||
2 | |||
3 | This page describes how to setup and use the QMK CLI. | ||
4 | |||
5 | # Overview | ||
6 | |||
7 | The QMK CLI makes building and working with QMK keyboards easier. We have provided a number of commands to help you work with QMK: | ||
8 | |||
9 | * `qmk compile-json` | ||
10 | |||
11 | # Setup | ||
12 | |||
13 | Simply add the `qmk_firmware/bin` directory to your `PATH`. You can run the `qmk` commands from any directory. | ||
14 | |||
15 | ``` | ||
16 | export PATH=$PATH:$HOME/qmk_firmware/bin | ||
17 | ``` | ||
18 | |||
19 | You may want to add this to your `.profile`, `.bash_profile`, `.zsh_profile`, or other shell startup scripts. | ||
20 | |||
21 | # Commands | ||
22 | |||
23 | ## `qmk compile-json` | ||
24 | |||
25 | This command allows you to compile JSON files you have downloaded from <https://config.qmk.fm>. | ||
26 | |||
27 | **Usage**: | ||
28 | |||
29 | ``` | ||
30 | qmk compile-json mine.json | ||
31 | ``` | ||