summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-03-25 11:38:44 +0000
committerQMK Bot <hello@qmk.fm>2021-03-25 11:38:44 +0000
commita747ef966ba6dc5f52d8e6aa60d7d3e9bcf67758 (patch)
treed1fef064be28adc655a76afff61bc96578ee6239 /docs
parent87f6df0655486bc372b0205f1261ac28026abaac (diff)
parent3e60997edba46544557b3a775bdb1538e07c3edf (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/cli_commands.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index bb5df89968..6498b28b88 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -131,6 +131,16 @@ Check your environment and report problems only:
qmk doctor -n
+## `qmk format-json`
+
+Formats a JSON file in a (mostly) human-friendly way. Will usually correctly detect the format of the JSON (info.json or keymap.json) but you can override this with `--format` if neccesary.
+
+**Usage**:
+
+```
+qmk format-json [-f FORMAT] <json_file>
+```
+
## `qmk info`
Displays information about keyboards and keymaps in QMK. You can use this to get information about a keyboard, show the layouts, display the underlying key matrix, or to pretty-print JSON keymaps.