Skip to content

Updated the neovim docs and fixed broken *:PioTermList tag #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anurag3301 merged 1 commit into from
Sep 9, 2026
Merged

Updated the neovim docs and fixed broken *:PioTermList tag #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 39 additions & 8 deletions doc/platformio.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ USAGE *platformio-usage*

*:Piorun*
:Piorun [arg] This command builds and uploads the code. Optional
arguments: build, upload, clean. If no argument is
provided, it defaults to build and upload.
arguments: build, upload, uploadfs, clean. If no
argument is provided, it defaults to build and
upload.
Examples:
`:Piorun`
`:Piorun build`
`:Piorun upload`
`:Piorun uploadfs`
`:Piorun clean`

*:Piocmd*
Expand All @@ -51,12 +53,14 @@ USAGE *platformio-usage*
`:Piolib keyboard`

*:Piomon*
:Piomon [baud_rate] Open a serial monitor. Specify a baud rate as an
optional argument. If not provided, it uses the default
baud rate (9600) or the one specified in platformio.ini.
:Piomon [baud] [port] Open a serial monitor. Specify a baud rate and,
optionally, a port. If not provided, it uses the
default baud rate (9600) or the one specified in
platformio.ini, and auto-detects the port.
Examples:
`:Piomon`
`:Piomon 115200`
`:Piomon 115200 /dev/ttyUSB0`

*:Piolsserial*
:Piolsserial List out all the serial devices connected with their
Expand All @@ -73,9 +77,11 @@ USAGE *platformio-usage*
*:Piodebug*
:Piodebug Starts the default PlatformIO debugger with gdb

*:PioTermList
:PioTermList You can see a list of pio terminals using :PioTermList
command in normal mode. It is mapped to <leader>pl
*:PioTermList*
:PioTermList Lists open PIO terminals (CLI and monitor) and lets
you pick one to switch to. Not bound to any key by
default; bind it yourself or add it to
`menu_bindings` (see |platformio-configuration|).


==============================================================================
Expand All @@ -84,6 +90,11 @@ CONFIGURATION *platformio-configuration*
The plugin exposes a few configuration options that can be set in your
`setup()` call.

lsp *platformio-lsp*
Which language server the generated project config should target.
Allowed values: `ccls` (default) or `clangd`. See |platformio-clangd_source|
below when using `clangd`.

clangd_source *platformio-clangd_source*
PlatformIO CLI officially only supports generating LSP configuration for
CCLS, since it creates a `.ccls` file when you use the `--ide=vim` flag.
Expand Down Expand Up @@ -142,4 +153,24 @@ picker_backend *platformio-picker*
`vim.ui.select` or any plugin that overrides it (for example,
telescope-ui-select, dressing.nvim, snacks picker adapters, etc.).

menu_key *platformio-menu_key*
Key prefix that opens the PlatformIO which-key menu (requires
folke/which-key.nvim). Unset (`nil`) by default, which disables the menu
entirely. Example: `menu_key = '<leader>\\'`.

menu_name *platformio-menu_name*
Display name for the top-level menu group shown by which-key.
Default: `'PlatformIO'`.

menu_bindings *platformio-menu_bindings*
Table describing the which-key menu tree: nested `menu` nodes (with
`desc`, `shortcut`, `items`) and `item` nodes (with `desc`, `shortcut`,
`command`). See the README for the full default table, which you can
copy and edit. Note that a partial table does not selectively override
individual default entries — provide the whole tree if you customize it.

debug *platformio-debug*
When `true`, echoes extra diagnostic info (terminal name, window/buffer
ids, job id) each time a PIO terminal opens. Default: `false`.

vim:tw=78:sw=4:ts=8:ft=help:norl:noet:
6 changes: 6 additions & 0 deletions doc/tags
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
:PioLSP platformio.txt /*:PioLSP*
:PioTermList platformio.txt /*:PioTermList*
:Piocmd platformio.txt /*:Piocmd*
:Piodebug platformio.txt /*:Piodebug*
:Pioinit platformio.txt /*:Pioinit*
Expand All @@ -9,6 +10,11 @@
PlatformIO platformio.txt /*PlatformIO*
platformio-clangd_source platformio.txt /*platformio-clangd_source*
platformio-configuration platformio.txt /*platformio-configuration*
platformio-debug platformio.txt /*platformio-debug*
platformio-lsp platformio.txt /*platformio-lsp*
platformio-menu_bindings platformio.txt /*platformio-menu_bindings*
platformio-menu_key platformio.txt /*platformio-menu_key*
platformio-menu_name platformio.txt /*platformio-menu_name*
platformio-picker platformio.txt /*platformio-picker*
platformio-usage platformio.txt /*platformio-usage*
platformio.lua platformio.txt /*platformio.lua*
Loading