python icon indicating copy to clipboard operation
python copied to clipboard

Document available column names for `--nodes` table

Open dandrzejewski opened this issue 10 months ago • 1 comments

Now that the --nodes table can be configured with --show-fields, and soon sortable (see #740), it would be helpful to document the fields available.

We'd want to automate this as much as possible to minimize manual updates to the docs when the protobufs change.

At the very least, I'd like to add it to the CLI --help screen - perhaps --nodes --help. We can use the protobufs to enumerate everything and display it programmatically.

I'm aware that the protobufs aren't always the 'single source of truth' in this context, so I may need to do some refactoring here.

It's been noted on Discord that we need to keep in mind that downstream users of this library may be impacted by changes related to this.

dandrzejewski avatar Feb 20 '25 17:02 dandrzejewski

This isn't documentation, but I found https://github.com/meshtastic/python/blob/d7d9c7219ad90269ddb6b4f1d28b2795a8395c05/meshtastic/mesh_interface.py#L234-L252 which got me what I needed.

kmarekspartz avatar Aug 02 '25 00:08 kmarekspartz