• General commands
  • Beginner
  • 1 min
  • Serial CLI

Recipe · Beginner · General commands

How to use help and man

Use global help and the firmware guide before running a mode-specific command or wiring an unknown target.

Command reference with lab notes.
The fastest documentation is often the help screen built into the current mode.
Step 1

Commands

These commands are documented as global or quick-start commands.

Result

What it means

If the command returns the expected output, the firmware and terminal session are ready for the next workflow.

Troubleshooting

  • Run help after switching modes.
  • Use man for a higher-level firmware guide.
  • If examples do not match, verify the firmware version.

Next steps

  • Try the same workflow on a known safe pin or target.
  • Save the useful command as a note or alias.
  • Move to the protocol-specific recipe once the basics work.

Firmware help FAQ

Why use help after switching modes?

help reflects the commands available in the current context. That is useful because UART, I2C, SPI, DIO and adapter modes do not expose the same actions.

When is man more useful than help?

man is better for a broader reminder of firmware concepts and workflow. Use help when you need the immediate command list for the active mode.

How should I treat firmware help versus web recipes?

Firmware help reflects the commands available in the build currently running on the board. Web recipes provide guided workflows, but the live CLI remains the final check for that firmware version.

Go deeper