keyboard/qmk-keychron-q3-colemak-dh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
d076234fd1
qmk-keychron-q3-colemak-dh/docs/cli.md
skullydazed f22c5c17b6
Refactor qmk compile-json to qmk compile (#6592)
2019-08-25 11:58:24 -07:00

875 B
Raw Blame History

QMK CLI

This page describes how to setup and use the QMK CLI.

Overview

The QMK CLI makes building and working with QMK keyboards easier. We have provided a number of commands to help you work with QMK:

  • qmk compile
  • qmk doctor

Setup

Simply add the qmk_firmware/bin directory to your PATH. You can run the qmk commands from any directory.

export PATH=$PATH:$HOME/qmk_firmware/bin

You may want to add this to your .profile, .bash_profile, .zsh_profile, or other shell startup scripts.

Commands

qmk compile

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.

Usage for Configurator Exports:

qmk compile <configuratorExport.json>

Usage for Keymaps:

qmk compile -kb <keyboard_name> -km <keymap_name>