diff --git a/guides/cli.rst b/guides/cli.rst index 8537d5a83..ad7aed46d 100644 --- a/guides/cli.rst +++ b/guides/cli.rst @@ -218,4 +218,30 @@ through a graphical user interface. If set, opens the dashboard UI in a browser once the server is up and running. +``logs`` Command +--------------------- + +.. program:: esphome logs + +The ``esphome logs`` command validates the configuration and shows all logs. + +.. option:: --topic TOPIC + + Manually set the topic to subscribe to. + +.. option:: --username USERNAME + + Manually set the username. + +.. option:: --password PASSWORD + + Manually set the password. + +.. option:: --client-id CLIENT_ID + + Manually set the client id. + +.. option:: --serial-port SERIAL_PORT + + Manually specify a serial port to use. For example ``/dev/cu.SLAB_USBtoUART``.