xref: /aosp_15_r20/external/pigweed/pw_system/cli.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985) 
1.. _module-pw_system-cli:
2
3===============================
4pw_system console CLI reference
5===============================
6These are the standard pw_system console command line arguments.
7
8.. argparse::
9   :module: pw_system.console
10   :func: get_parser
11   :prog: pw system console
12   :nodefaultconst:
13   :nodescription:
14   :noepilog:
15
16===================
17Python Console APIs
18===================
19Functions for establishing a connection to pw_system powered devices using Python.
20
21-------------------
22Console startup API
23-------------------
24.. autofunction:: pw_system.console.main
25
26---------------------
27Device connection API
28---------------------
29Device connections can be established in the same way as the pw_system console
30but through the Python function :py:func:`create_device_serial_or_socket_connection`.
31
32.. autofunction:: pw_system.device_connection.create_device_serial_or_socket_connection
33