oxidecomputer / oxidecomputer/transceiver-control

`xcvradm` could use parseable output

Open
#105 3 comments 0 reactions 1 assignee View on GitHub

@bnaecker is already working on this.

Since Jun 21, 2023.

Dominant language
Rust
Stars
9
Forks
0
Avg merge
57m
Merged PRs (30d)
3

Description

Many illumos tools support a parseable mode, in which the output is regularly-structured and meant for machine consumption. Rather than nicely-printed tables, output is formatted with a single, often configurable, separator character. xcvradm could benefit from such a mode. Flags to implement include:

  • -p or --parseable: select parseable mode, over human-friendly formatting
  • -s or --separator: select the separator character
  • -o or similar: the list of fields to include in the output. It's also nice to print a list of the available fields, in lieu of a man page.
  • -H or --no-header: do not print headers for the selected columns

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.