Skip to content

Some small fix on CLI monitor command docs #1505

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.

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
merged 1 commit into from
Oct 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,8 @@ Additional board options have to be separated by commas (instead of colon):

## Where is the Serial Monitor?

This being a command line tool, we believe it's up to the user to choose their preferred way of interacting with the
serial connection. If we were to integrate it into the CLI we'd end up putting a tool inside a tool, and this would be
something that we're trying to avoid.
The serial monitor is available through the [monitor command][monitor command]. By the way, the functionality provided
by this command is very limited and you may want to look for other tools if you need more advanced functionality.

There are many excellent serial terminals to chose from. On Linux or macOS, you may already have [screen][screen]
installed. On Windows, a good choice for command line usage is Plink, included with [PuTTY][putty].
Expand All @@ -39,3 +38,4 @@ If your question wasn't answered, feel free to ask on [Arduino CLI's forum board
[screen]: https://www.gnu.org/software/screen/manual/screen.html
[putty]: https://www.chiark.greenend.org.uk/~sgtatham/putty/
[monitor service]: rpc/monitor.md
[monitor command]: commands/arduino-cli_monitor.md
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ nav:
- lib uninstall: commands/arduino-cli_lib_uninstall.md
- lib update-index: commands/arduino-cli_lib_update-index.md
- lib upgrade: commands/arduino-cli_lib_upgrade.md
- monitor: commands/arduino-cli_monitor.md
- outdated: commands/arduino-cli_outdated.md
- sketch: commands/arduino-cli_sketch.md
- sketch archive: commands/arduino-cli_sketch_archive.md
Expand Down