diff options
| author | Erovia <Erovia@users.noreply.github.com> | 2021-11-04 21:21:09 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-05 08:21:09 +1100 |
| commit | c8b09d0d4ab73c88c6ae84718f0c890640dfbece (patch) | |
| tree | bf7d61aec282c9cedbfd97d4ffc67092f2396966 /docs | |
| parent | fefd7fdc5145b677da7b0e1d75bab11eac9db605 (diff) | |
CLI: Add 'cd' subcommand (#12584)
* CLI: Add 'cd' subcommand
Go to your qmk_firmware dir with ease.
* Fix for Windows and do not run if already under QMK Home
* Make flake8 happy
* Fix prompt for Windows
* Make flake8 happy once again
* I'll get it right eventually
* Apply suggestions from code review
Co-authored-by: Ryan <fauxpark@gmail.com>
* Add subcommand to __init__.py and fixup after rebase
* Update Windows code to use milc's run
* Unify the subshell starting with os.execl
* Exit with error msg when output is redirected to non-TTY.
* Revert Windows-specific code
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cli_commands.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index e498f3b22e..8f5117633f 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -118,6 +118,20 @@ This command lets you configure the behavior of QMK. For the full `qmk config` d qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] ``` +## `qmk cd` + +This command opens a new shell in your `qmk_firmware` directory. + +Note that if you are already somewhere within `QMK_HOME` (for example, the `keyboards/` folder), nothing will happen. + +To exit out into the parent shell, simply type `exit`. + +**Usage**: + +``` +qmk cd +``` + ## `qmk console` This command lets you connect to keyboard consoles to get debugging messages. It only works if your keyboard firmware has been compiled with `CONSOLE_ENABLE=yes`. |