From 19853b03f1a89a8ff3b3a97f35ee8a8e4df6ab12 Mon Sep 17 00:00:00 2001 From: marchersimon <50295997+marchersimon@users.noreply.github.com> Date: Sun, 23 May 2021 02:06:55 +0200 Subject: [PATCH] pio-remote: add page (#5902) * pio-remote: add page * Add second friend * Apply suggestions from code review * remove "usually" from description * Add brackets to command in description --- pages/common/pio-remote.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 pages/common/pio-remote.md diff --git a/pages/common/pio-remote.md b/pages/common/pio-remote.md new file mode 100644 index 0000000000..da8c2cbc98 --- /dev/null +++ b/pages/common/pio-remote.md @@ -0,0 +1,33 @@ +# pio remote + +> Helper command for PlatformIO Remote Development. +> `pio remote [command]` takes the same arguments as its locally executing counterpart `pio [command]`. +> More information: . + +- List all active Remote Agents: + +`pio remote agent list` + +- Start a new Remote Agent with a specific name and share it with friends: + +`pio remote agent start --name {{agent_name}} --share {{example1@example.com}} --share {{example2@example.com}}` + +- List devices from specified Agents (omit `--agent` to specify all Agents): + +`pio remote --agent {{agent_name1}} --agent {{agent_name2}} device list` + +- Connect to the serial port of a remote device: + +`pio remote --agent {{agent_name}} device monitor` + +- Run all targets on a specified Agent: + +`pio remote --agent {{agent_name}} run` + +- Update installed core packages, development platforms and global libraries on a specific Agent: + +`pio remote --agent {{agent_name}} update` + +- Run all tests in all environments on a specific Agent: + +`pio remote --agent {{agent_name}} test`