feat(user): add fuzzy, match, range flags for commands by Mujib-Ahasan · Pull Request #682 · goharbor/harbor-cli

Mujib-Ahasan · 2026-02-06T16:12:29Z

Description

Only harbor-cli project list and harbor-cli label list support fuzzy, match, and range flags. All the other commands does not follow this way to query resource.
This PR has been raised to make fuzzy, match, range flag available to other required commands(eg: user, artifact, instance, registry etc).

Resolves #674

Mujib-Ahasan · 2026-02-06T16:17:08Z

Hello @NucleoFusion, this is yet to be tested, but I am really confused to find the keys to be used in list subcommands. Changes have been made for user list command for now. Could you please help me to get the keys for other commands?!

NucleoFusion · 2026-02-06T16:36:56Z

@Mujib-Ahasan the keys are the fields/keys in the JSON object they return. They are available on the demo.goharbor.io swagger api

Mujib-Ahasan · 2026-02-06T16:38:46Z

Great, Thank you @NucleoFusion!

Mujib-Ahasan · 2026-02-07T06:17:50Z

@NucleoFusion , PTAL at these changes. after that I will do some tests against my local setup.

NucleoFusion · 2026-02-11T09:27:54Z

@Mujib-Ahasan

Repositories
- All Repo's
- Project Repositories
Artifacts
Tags
Accessories
Auditlogs
Preheat
- instances
- policies
- executions
- execution tasks
Immutable Tag Rules
Webhooks
- policies
- execs
- execution tasks
Robots
Replication
- policies
- executions
- execution tasks
Registries
Scanner
Users
Labels
SecurityHub - Vuln List

All these are supported via the q param as per the swagger API. Can you make a checklist and check if they all are implemented as the q param.
And if they are not present in the CLI as of now, please mention the same

Mujib-Ahasan · 2026-02-11T17:21:34Z

NucleoFusion · 2026-02-12T02:58:24Z

Have you done all those? In the checklist that have CLI present?
If so I will have a look ASAP

Mujib-Ahasan · 2026-02-12T11:53:46Z

I did only for those which has --query flag (--query in the bracket in my prev comment) . I have not worked in CLI which do not have --query flag ( ex:- https://github.com/goharbor/harbor-cli/blob/main/cmd/harbor/root/webhook/list.go).

NucleoFusion · 2026-02-22T06:21:21Z

Sorry for the delay.
I can see that even though some of the CLI Commands dont have --query builtin, but their API in Harbor does support it.
For example,

tags/immutable/list.go, artifact/tags.go

The list I have given has all the endpoints that support q param as per the API. not the CLI.
Please check and add to even those that done have the --query currently.
@Mujib-Ahasan

Mujib-Ahasan · 2026-02-23T17:02:07Z

Changes have been made. Ready for the review @NucleoFusion!

NucleoFusion · 2026-02-25T05:19:25Z

 	flags.Int64VarP(&opts.ProjectID, "project-id", "", 0, "Project ID")
 	flags.StringVarP(&opts.Q, "query", "q", "", "Query string to query resources")


No query conversion here

NucleoFusion

lgtm

qcserestipy · 2026-03-25T15:58:56Z

Please fix merge conflicts for this PR to be merged

Mujib-Ahasan · 2026-03-25T17:25:32Z

@qcserestipy PTAL. you can proceed with the merge now.

codecov · 2026-04-07T13:28:43Z

Codecov Report

❌ Patch coverage is 0% with 348 lines in your changes missing coverage. Please review.
✅ Project coverage is 7.62%. Comparing base (60ad0bd) to head (52c9f28).
⚠️ Report is 131 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/harbor/root/artifact/tags.go	0.00%	113 Missing ⚠️
cmd/harbor/root/scanner/list.go	0.00%	20 Missing ⚠️
cmd/harbor/root/project/robot/list.go	0.00%	19 Missing ⚠️
cmd/harbor/root/tag/immutable/list.go	0.00%	19 Missing ⚠️
cmd/harbor/root/webhook/list.go	0.00%	19 Missing ⚠️
cmd/harbor/root/robot/list.go	0.00%	18 Missing ⚠️
cmd/harbor/root/artifact/list.go	0.00%	17 Missing ⚠️
cmd/harbor/root/user/list.go	0.00%	17 Missing ⚠️
cmd/harbor/root/instance/list.go	0.00%	16 Missing ⚠️
cmd/harbor/root/registry/list.go	0.00%	16 Missing ⚠️
... and 8 more

Additional details and impacted files

@@            Coverage Diff            @@
##             main    #682      +/-   ##
=========================================
- Coverage   10.99%   7.62%   -3.38%     
=========================================
  Files         173     271      +98     
  Lines        8671   13477    +4806     
=========================================
+ Hits          953    1027      +74     
- Misses       7612   12337    +4725     
- Partials      106     113       +7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

This PR adds fuzzy, match, and range flags to multiple Harbor CLI commands for more user-friendly query filtering. Instead of using the old --query parameter format, users can now use intuitive flags like --fuzzy name=value, --match key=value, and --range key=min~max. The changes include updates to API handler functions to accept optional ListFlags parameters and corresponding command implementations to build query strings from the new flag inputs.

Changes:

Updated 13 API handler functions to accept optional ListFlags parameters
Added fuzzy, match, and range flags to 14 command implementations
Created new artifact/tags.go command file with full flag support
Reformatted multi-line flag definitions in quota/list.go and robot/list.go

Reviewed changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
pkg/api/webhook_handler.go	Updated ListWebhooks() to accept optional ListFlags
pkg/api/scanner_handler.go	Updated ListScanners() to accept optional ListFlags
pkg/api/immutable_handler.go	Updated ListImmutable() to accept optional ListFlags
pkg/api/artifact_handler.go	Updated ListTags() to accept optional ListFlags
cmd/harbor/root/webhook/list.go	Added fuzzy, match, range flags
cmd/harbor/root/user/list.go	Added fuzzy, match, range flags
cmd/harbor/root/tag/immutable/list.go	Added fuzzy, match, range flags
cmd/harbor/root/scanner/list.go	Added fuzzy, match, range flags
cmd/harbor/root/robot/list.go	Added fuzzy, match, range flags
cmd/harbor/root/repository/list.go	Added fuzzy, match, range flags
cmd/harbor/root/replication/policies/list.go	Added fuzzy, match, range flags
cmd/harbor/root/replication/executions/list.go	Added fuzzy, match, range flags
cmd/harbor/root/registry/list.go	Added fuzzy, match, range flags
cmd/harbor/root/quota/list.go	Reformatted multi-line flag definition
cmd/harbor/root/project/robot/list.go	Added fuzzy, match, range flags
cmd/harbor/root/instance/list.go	Added fuzzy, match, range flags
cmd/harbor/root/artifact/tags.go	New file with tag listing command supporting query flags
cmd/harbor/root/artifact/list.go	Added fuzzy, match, range flags

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

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 7 comments.

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

Copilot

Pull request overview

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

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

Mujib-Ahasan · 2026-04-20T14:36:09Z

Hey @bupd, PTAL, whenever you get time!

bupd

@Mujib-Ahasan Thanks for your contribution, Please fix CI and also rebase your commits and resolve conflicts.

Signed-off-by: Mujib Ahasan <ahasanmujib8@gmail.com>

Copilot

Pull request overview

Copilot reviewed 17 out of 17 changed files in this pull request and generated 9 comments.

Comments suppressed due to low confidence (5)

cmd/harbor/root/webhook/list.go:94

If an output format is requested, the command prints formatted output but then still proceeds to render the interactive table view. This results in double output (and potentially breaks machine-readable output). Consider returning immediately after PrintFormat or moving the table rendering into an else branch.

			FormatFlag := viper.GetString("output-format")
			if FormatFlag != "" {
				err = utils.PrintFormat(resp, FormatFlag)
				if err != nil {
					return fmt.Errorf("failed to print in %s format: %v", FormatFlag, err)
				}
			}
			webhookViews.ListWebhooks(resp.Payload)
			return nil

cmd/harbor/root/tag/immutable/list.go:78

Typo in the error message: "immutablility" should be "immutability".

				return fmt.Errorf("failed to list immutablility rule: %v", err)

cmd/harbor/root/replication/policies/list.go:70

This error message says "failed to get projects list" but this command is listing replication policies, which makes the message misleading. Consider updating it to mention replication policies.

			if err != nil {
				return fmt.Errorf("failed to get projects list: %v", utils.ParseHarborErrorMsg(err))
			}

cmd/harbor/root/replication/executions/list.go:85

This error message says "failed to get projects list" but this command is listing replication executions. Consider updating the message to reference replication executions (and possibly include the policy ID).

			if err != nil {
				return fmt.Errorf("failed to get projects list: %v", utils.ParseHarborErrorMsg(err))
			}

cmd/harbor/root/registry/list.go:68

This error message says "failed to get projects list" but this command is listing registries, which is misleading. Consider updating it to mention registries.

			registry, err := api.ListRegistries(opts)

			if err != nil {
				return fmt.Errorf("failed to get projects list: %v", err)
			}

NucleoFusion suggested changes Feb 25, 2026

View reviewed changes

Mujib-Ahasan requested a review from NucleoFusion February 27, 2026 19:09

NucleoFusion approved these changes Feb 28, 2026

View reviewed changes

NucleoFusion mentioned this pull request Mar 7, 2026

enhancement: Support and / or in query flags and doc gen for query #731

Draft

4 tasks

bupd requested review from bupd and Copilot April 7, 2026 13:25

bupd self-assigned this Apr 7, 2026

bupd added enhancement New feature or request go Pull requests that update go code labels Apr 7, 2026

Copilot started reviewing on behalf of bupd April 7, 2026 13:26 View session

Copilot AI reviewed Apr 7, 2026

View reviewed changes

Comment thread cmd/harbor/root/instance/list.go

Comment thread cmd/harbor/root/replication/executions/list.go Outdated

Mujib-Ahasan requested a review from Copilot April 8, 2026 16:26

Copilot started reviewing on behalf of Mujib-Ahasan April 8, 2026 16:26 View session

Copilot AI reviewed Apr 8, 2026

View reviewed changes

Mujib-Ahasan requested a review from Copilot April 9, 2026 13:21

Copilot started reviewing on behalf of Mujib-Ahasan April 9, 2026 13:22 View session

Copilot AI reviewed Apr 9, 2026

View reviewed changes

Comment thread cmd/harbor/root/robot/list.go

bupd requested changes May 19, 2026

View reviewed changes

bupd added the Changes Requesed feedback that must be addressed before merging. label May 19, 2026

Mujib-Ahasan added 8 commits May 20, 2026 12:56

feat(user): add fuzzy,match,range flag for user list command

2175f66

Signed-off-by: Mujib Ahasan <ahasanmujib8@gmail.com>

refractor: add fuzzy,match,range flags for resource query

13e5204

Signed-off-by: Mujib Ahasan <ahasanmujib8@gmail.com>

New query flags added to few list subcommands

9acc3ce

Signed-off-by: Mujib Ahasan <ahasanmujib8@gmail.com>

New query flags added to list scanners subcommand

7377fec

Signed-off-by: Mujib Ahasan <ahasanmujib8@gmail.com>

new query flags added to robot list

82f30b1

Signed-off-by: Mujib Ahasan <ahasanmujib8@gmail.com>

fix: error handling and small nits

166e882

Signed-off-by: Mujib Ahasan <ahasanmujib8@gmail.com>

fix: error handling

cbc32f9

Signed-off-by: Mujib Ahasan <ahasanmujib8@gmail.com>

proper error handling added

d519831

Signed-off-by: Mujib Ahasan <ahasanmujib8@gmail.com>

Mujib-Ahasan force-pushed the new-query-flags branch from f8d25bb to d519831 Compare May 20, 2026 07:50

Mujib-Ahasan requested a review from Copilot May 20, 2026 08:14

Copilot started reviewing on behalf of Mujib-Ahasan May 20, 2026 08:14 View session

Copilot AI reviewed May 20, 2026

View reviewed changes

		flags.Int64VarP(&opts.ProjectID, "project-id", "", 0, "Project ID")
		flags.StringVarP(&opts.Q, "query", "q", "", "Query string to query resources")

Conversation

Mujib-Ahasan commented Feb 6, 2026

Description

Uh oh!

Mujib-Ahasan commented Feb 6, 2026

Uh oh!

NucleoFusion commented Feb 6, 2026

Uh oh!

Mujib-Ahasan commented Feb 6, 2026

Uh oh!

Mujib-Ahasan commented Feb 7, 2026

Uh oh!

NucleoFusion commented Feb 11, 2026

Uh oh!

Mujib-Ahasan commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NucleoFusion commented Feb 12, 2026

Uh oh!

Mujib-Ahasan commented Feb 12, 2026

Uh oh!

NucleoFusion commented Feb 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Mujib-Ahasan commented Feb 23, 2026

Uh oh!

NucleoFusion Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

NucleoFusion left a comment

Choose a reason for hiding this comment

Uh oh!

qcserestipy commented Mar 25, 2026

Uh oh!

Mujib-Ahasan commented Mar 25, 2026

Uh oh!

codecov Bot commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Mujib-Ahasan commented Apr 20, 2026

Uh oh!

bupd left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Mujib-Ahasan commented Feb 11, 2026 •

edited

Loading

NucleoFusion commented Feb 22, 2026 •

edited

Loading

codecov Bot commented Apr 7, 2026 •

edited

Loading