Skip to content

feat(smd): add list alias to rfe and component get commands - #121

Open
TheSabari07 wants to merge 1 commit into
OpenCHAMI:mainfrom
TheSabari07:feat/add-list-aliases
Open

feat(smd): add list alias to rfe and component get commands#121
TheSabari07 wants to merge 1 commit into
OpenCHAMI:mainfrom
TheSabari07:feat/add-list-aliases

Conversation

@TheSabari07

@TheSabari07 TheSabari07 commented Jul 23, 2026

Copy link
Copy Markdown

Checklist

  • My code follows the style guidelines of this project
  • I have added/updated comments where needed
  • I have added tests that prove my fix is effective or my feature works
  • I have run make test (or equivalent) locally and all tests pass
  • DCO Sign-off: All commits are signed off (git commit -s) with my real name and email
  • REUSE Compliance:
    • Each new/modified source file has SPDX copyright and license headers
    • Any non-commentable files include a <filename>.license sidecar
    • All referenced licenses are present in the LICENSES/ directory

Description

Summary:
This PR introduces list as an alias for the ochami smd rfe get and ochami smd component get commands.

Motivation and Context:
Older CSM-based commands lacked a list alias, causing inconsistencies in user experience when compared to newer commands in the OpenCHAMI CLI. This simple quality-of-life update allows users to type list intuitively while mapping directly to the underlying get logic. The respective man pages (ochami-smd.1.sc) have also been updated to reflect the availability of the alias.

Fixes #(issue)
#116

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

For more info, see Contributing Guidelines.

Signed-off-by: Sabari07 <sabursd18@gmail.com>
@alexlovelltroy
alexlovelltroy requested a review from synackd July 23, 2026 11:31
Comment thread man/ochami-smd.1.sc

*get* [-F _format_] [--nid _nid_] [--xname _xname_]
Get all components or one identified by xname or node ID.
Get all components or one identified by xname or node ID. Note: `list` is an available alias for this command.

@davidallendj davidallendj Jul 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@synackd Is this how you want to specify aliases in the man page documentation or do you have another way?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll want the aliases to be discoverable, so they should be near the top of the command section. I'm thinking we do it like this:

*get* [-F _format_] [--nid _nid_] [--xname _xname_]
	Aliases: *list*

	Get all components or one identified by xname or node ID.

This seems idiomatic with manual pages of some other popular projects I've come across.

@davidallendj

Copy link
Copy Markdown
Contributor

One thing that stood out at a glance is that this only covers ochami smd rfe and ochami smd component as mentioned in #116. Do we want to extend this to include other SMD commands with similar behaviors (e.g. compep, group, and iface? Do we want to also extend this to the similar BSS commands (e.g. params, script, hosts)?

@synackd

synackd commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator

Yes, we'll want to implement this for all commands that have a get subcommand.

@synackd synackd linked an issue Jul 23, 2026 that may be closed by this pull request
1 task
@TheSabari07

Copy link
Copy Markdown
Author

Thanks for the feedback, @synackd and @davidallendj! Just to confirm, can I start implementing the man page formatting as suggested and add the list alias to all get subcommands across the entire CLI?

@synackd

synackd commented Jul 25, 2026

Copy link
Copy Markdown
Collaborator

Yes. All service commands with a get subcommand (smd, bss, pcs, and rcs).

@TheSabari07

TheSabari07 commented Jul 26, 2026

Copy link
Copy Markdown
Author

Yes. All service commands with a get subcommand (smd, bss, pcs, and rcs).

Okay @synackd,
I will start to implement it and will update the changes soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: Add list alias to make CLI consistent

3 participants