docs/cli.md

   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`
  10 * `qmk doctor`
  11
  12 # Setup
  13
  14 Simply add the `qmk_firmware/bin` directory to your `PATH`. You can run the `qmk` commands from any directory.
  15
  16 ```
  17 export PATH=$PATH:$HOME/qmk_firmware/bin
  18 ```
  19
  20 You may want to add this to your `.profile`, `.bash_profile`, `.zsh_profile`, or other shell startup scripts.
  21
  22 # Commands
  23
  24 ## `qmk compile`
  25
  26 This command allows you to compile firmware from any directory. You can compile JSON exports from <https://config.qmk.fm> or compile keymaps in the repo.
  27
  28 **Usage for Configurator Exports**:
  29
  30 ```
  31 qmk compile <configuratorExport.json>
  32 ```
  33
  34 **Usage for Keymaps**:
  35
  36 ```
  37 qmk compile -kb <keyboard_name> -km <keymap_name>
  38 ```