summaryrefslogtreecommitdiffstats
path: root/docs/cli_commands.md
Commit message (Collapse)AuthorAgeFilesLines
* New command: qmk console (#12828)Zach White2021-05-081-0/+48
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * stash poc * stash * tidy up implementation * Tidy up slightly for review * Tidy up slightly for review * Bodge environment to make tests pass * Refactor away from asyncio due to windows issues * Filter devices * align vid/pid printing * Add hidapi to the installers * start preparing for multiple hid_listeners * udev rules for hid_listen * refactor to move closer to end state * very basic implementation of the threaded model * refactor how vid/pid/index are supplied and parsed * windows improvements * read the report directly when usage page isn't available * add per-device colors, the choice to show names or numbers, and refactor * add timestamps * Add support for showing bootloaders * tweak the color for bootloaders * Align bootloader disconnect with connect color * add support for showing all bootloaders * fix the pyusb check * tweaks * fix exception * hide a stack trace behind -v * add --no-bootloaders option * add documentation for qmk console * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * pyformat * clean up and flesh out KNOWN_BOOTLOADERS Co-authored-by: zvecr <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* Shim cli to new keyboard script (#12780)Joel Challis2021-05-021-0/+12
| | | | | | | * Shim cli to new keyboard script * Shim cli to new keyboard script * Add docs
* Add a `qmk format-json` command that will format JSON files (#12372)Zach White2021-03-251-0/+10
| | | | | | | | | | | * Add a command to format json files * change to work after rebase * add test for qmk format-json * add documentation for qmk format-json * Update lib/python/qmk/cli/format/json.py
* Fix a small typo in cli_commands.md (#12379)Ryan Roden-Corrent2021-03-251-1/+1
|
* Improve the compile and flash subcommands (#11334)Zach White2021-01-161-4/+4
| | | | | | | | | | | | | | | | | | | * add support for --clean to compile and flash * compile standalone JSON keymaps without polluting the tree * Add support for passing environment vars to make * make flake8 happy * document changes to qmk compile and flash * add -e support to json export compiling * Fix python 3.6 * honor $MAKE * add support for parallel builds
* Updated usage of qmk c2json (#11148)precondition2020-12-181-1/+1
|
* CLI-ify rgblight_breathing_table_calc.c (#11174)Ryan2020-12-161-0/+10
| | | | Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Zach White <skullydazed@drpepper.org>
* CI: Add docs build and deploy workflow (#7448)Joel Challis2020-11-101-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add docs build and deploy workflow * Remove old travis docs workflow * update to cli command * Tidy up for review * formatting * Update to pass style checks * Update lib/python/qmk/cli/docs.py Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Review comments - build->generate, use of verbose * Add docs * Update to match recent actions * Run within base_container * Convert cli to generate-docs * Convert cli to generate-docs - restore old file * Convert cli to generate-docs * Update docs Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
* New command: qmk lint (#10761)Zach White2020-11-071-1/+18
| | | | | | | | | | | | | | | | | | | | | | | | | * Basic qmk lint command * check for keymap readme * change the workflow from qmk info to qmk lint * add a strict mode * parsing -> parse * document qmk lint * small info logging cleanup * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * honor --strict in more places * change the job name to lint Co-authored-by: Ryan <fauxpark@gmail.com>
* CLI: Add `qmk clean` (#10785)Ryan2020-11-041-0/+10
|
* [CLI] Add c2json (#8817)Erovia2020-10-061-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Basic keymap parsing finally works * Add 'keymap.json' creation to the qmk.keymap module * Add tests and fix formatting * Fix/exclude flake8 errors * Convert keymap.c to valid keymap.json * Fix some errors * Add tests * Finalize keymap.json creation, add json template * Add docs * Move pygments to the standard requirements * Add support for nameless layers, fix tests * Fix things after rebase * Add missing 'keymap' value. * Fix missing layer numbers from advanced keycodes Buckwich noticed that if the advanced keycode / layer toggling key contains a number, it goes missing. Now we properly handle them. Thx for noticing! * Apply suggestions from code review * fixup tests Co-authored-by: Zach White <skullydazed@drpepper.org> Co-authored-by: skullY <skullydazed@gmail.com>
* [CLI] Add a subcommand for getting information about a keyboard (#8666)Zach White2020-05-261-2/+35
| | | | | You can now use `qmk info` to get information about keyboards and keymaps. Co-authored-by: Erovia <Erovia@users.noreply.github.com>
* Make dedicated sections for user/dev commands in docsErovia2020-04-081-70/+65
|
* Rebase on master, hide some other subcommandsErovia2020-04-081-0/+10
| | | | | | | | | | | The list of hidden subcommands were approved by @skullydazed ;) Currently hidden if 'user.developer' is not True: - cformat - docs - kle2json - pyformat - pytest
* Document 'make all:<name>' (#8439)Joel Challis2020-03-161-0/+6
| | | | | | | | | | | * Document 'make all:<name>' * add cli docs * Apply suggestions from code review Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
* Fix some broken links in the docs (#8394)skullydazed2020-03-151-0/+247
* fix some broken links * remove duplicate and confusing material from cli.md * Switch brazil to the 2 letter country code * Update docs/_langs.md Co-Authored-By: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>