client: add examples, short flags and better error handling

[fmuyassarov]

Improve user experience.

• add usage examples to export and compat commands
• add -p short flag for --path option
• silence usage output on runtime errors for cleaner error messages

Examples

1. Usage silencing (before)

   $ ./bin/nfd export features --pathd
   Error: unknown flag: --pathd
   Usage:
     nfd export features [flags]
   
   Flags:
     -h, --help          help for features
         --path string   export to this JSON path
   
   unknown flag: --pathd
   

   after

   $ ./bin/nfd export features --pathd
   Error: unknown flag: --pathd
   unknown flag: --pathd
   

   before

   $  ./bin/nfd  compat validate-node --output-jsond true
   Error: unknown flag: --output-jsond
   Usage:
     nfd compat validate-node [flags]
   
   Flags:
     -h, --help                       help for validate-node
         --image string               the URL of the image containing compatibility metadata
         --output-json                print a JSON object
         --plain-http                 use of HTTP protocol for all registry communications
         --platform string            the artifact platform in the format os[/arch][/variant][:os_version]
         --registry-password-stdin    read registry password from stdin
         --registry-token-stdin       read registry access token from stdin
         --registry-username string   registry username
         --tags strings               a list of tags that must match the tags set on the compatibility objects
   
   unknown flag: --output-jsond
   

   after

   $ ./bin/nfd  compat validate-node --output-jsond true
   Error: unknown flag: --output-jsond
   unknown flag: --output-jsond
   

2. Helper examples:

   $ ./bin/nfd export features -h
   Export features for given node
   
   Usage:
     nfd export features [flags]
   
   Examples:
   
   # Export node features to stdout (prints to terminal)
   nfd export features
   
   # Export node features to a file instead
   nfd export features --path /tmp/features.json
   
   Flags:
     -h, --help          help for features
     -p, --path string   export to this JSON path
   

[netlify]

✅ Deploy Preview for kubernetes-sigs-nfd ready!

Name	Link
🔨 Latest commit	f06db58
🔍 Latest deploy log	https://app.netlify.com/projects/kubernetes-sigs-nfd/deploys/69021471c6ad6c00088b4441
😎 Deploy Preview	https://deploy-preview-2349--kubernetes-sigs-nfd.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[marquiz]

Thanks @fmuyassarov for the enhancement, looks good to me

@mfranczy @ChaoyiHuang @vsoch

[fmuyassarov]

/cc @ArangoGutierrez

[Copilot]

Pull Request Overview

This PR enhances CLI usability by adding usage examples to subcommands and improving error handling. The changes include setting SilenceUsage = true on the root command to prevent double output on errors, adding example sections to three commands (features, labels, and validate-node), and adding shorthand -p flags to the --path options for better ergonomics.

• Suppresses usage output on command errors via RootCmd.SilenceUsage = true
• Adds example documentation to export and validation commands
• Adds shorthand -p flag for --path option in export commands

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
cmd/nfd/subcmd/root.go	Sets SilenceUsage to prevent usage output on errors
cmd/nfd/subcmd/export/labels.go	Adds example documentation and shorthand flag for path option
cmd/nfd/subcmd/export/features.go	Adds example documentation and shorthand flag for path option
cmd/nfd/subcmd/compat/validate-node.go	Adds example documentation for validation command

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The example text shows 'nfd export features' but this is the 'labels' command. The examples should use 'nfd export labels' instead to match the command being documented.

Suggested change

	nfd export features
	# Export node labels to a file instead
	nfd export features --path /tmp/labels.json`
	nfd export labels
	# Export node labels to a file instead
	nfd export labels --path /tmp/labels.json`

[ArangoGutierrez]

/lgtm

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: 46937a65abc1648f390ea038cd9cea4b355967f3

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ArangoGutierrez, fmuyassarov, marquiz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [ArangoGutierrez,marquiz]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment