Skip to content

Document object search --filters syntax in CLI help #3990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
roman-khimov merged 5 commits into from
May 15, 2026
+46 −16
Merged

Document object search --filters syntax in CLI help #3990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fc9876f
Initial plan
Copilot May 14, 2026
f352e07
docs: explain object search filter syntax
Copilot May 14, 2026
eeb8db7
chore: drop object search help tests
Copilot May 14, 2026
e50fd01
chore: remove accidental cli binary
Copilot May 14, 2026
37a3d40
style: gofmt object search help
Copilot May 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 26 additions & 14 deletions cmd/neofs-cli/modules/object/search.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,33 @@ var (
var (
searchFilters []string

searchFiltersUsage = "Repeated filter expressions ('key OP value' or 'key NOPRESENT') or files with protobuf JSON"

searchExample = ` neofs-cli object search --cid <cid> --filters 'FilePath EQ cat.jpg'
neofs-cli object search --cid <cid> --filters 'Timestamp GE 1710000000' --filters 'Timestamp LE 1719999999'
neofs-cli object search --cid <cid> --filters 'FileName NOPRESENT'
neofs-cli object search --cid <cid> --filters filters.json`

searchV2Example = ` neofs-cli object searchv2 --cid <cid> --filters 'FilePath EQ cat.jpg'
neofs-cli object searchv2 --cid <cid> --filters 'Timestamp GE 1710000000' --filters 'Timestamp LE 1719999999'
neofs-cli object searchv2 --cid <cid> --filters 'FileName NOPRESENT'
neofs-cli object searchv2 --cid <cid> --filters filters.json`

objectSearchCmd = &cobra.Command{
Use: "search",
Short: "Search object",
Long: "Search object",
Args: cobra.NoArgs,
RunE: searchV2,
Use: "search",
Short: "Search object",
Long: "Search object",
Example: searchExample,
Args: cobra.NoArgs,
RunE: searchV2,
}
searchV2Cmd = &cobra.Command{
Use: objectSearchCmd.Use + "v2",
Short: objectSearchCmd.Short + " (deprecated)", // TODO: drop suffix on old search deprecation
Long: objectSearchCmd.Long + " (compatibility, deprecated)", // TODO: desc in details
Args: objectSearchCmd.Args,
RunE: searchV2,
Use: objectSearchCmd.Use + "v2",
Short: objectSearchCmd.Short + " (deprecated)", // TODO: drop suffix on old search deprecation
Long: objectSearchCmd.Long + " (compatibility, deprecated)", // TODO: desc in details
Example: searchV2Example,
Args: objectSearchCmd.Args,
RunE: searchV2,
}
)

Expand All @@ -61,10 +75,8 @@ func initObjectSearchCmd() {
flags2.String(commonflags.CIDFlag, "", commonflags.CIDFlagUsage)
_ = searchV2Cmd.MarkFlagRequired(commonflags.CIDFlag)

flags.StringSliceVarP(&searchFilters, "filters", "f", nil,
"Repeated filter expressions or files with protobuf JSON")
flags2.StringSliceVarP(&searchFilters, "filters", "f", nil,
"Repeated filter expressions or files with protobuf JSON")
flags.StringSliceVarP(&searchFilters, "filters", "f", nil, searchFiltersUsage)
flags2.StringSliceVarP(&searchFilters, "filters", "f", nil, searchFiltersUsage)

flags.Bool("root", false, "Search for user objects")
flags2.Bool("root", false, "Search for user objects")
Expand Down
11 changes: 10 additions & 1 deletion docs/cli-commands/neofs-cli_object_search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ Search object
neofs-cli object search [flags]
```

### Examples

```
neofs-cli object search --cid <cid> --filters 'FilePath EQ cat.jpg'
neofs-cli object search --cid <cid> --filters 'Timestamp GE 1710000000' --filters 'Timestamp LE 1719999999'
neofs-cli object search --cid <cid> --filters 'FileName NOPRESENT'
neofs-cli object search --cid <cid> --filters filters.json
```

### Options

```
Expand All @@ -19,7 +28,7 @@ neofs-cli object search [flags]
--cid string Container ID.
--count uint16 Max number of resulting items. Must not exceed 1000
--cursor string Cursor to continue previous search
-f, --filters strings Repeated filter expressions or files with protobuf JSON
-f, --filters strings Repeated filter expressions ('key OP value' or 'key NOPRESENT') or files with protobuf JSON
-g, --generate-key Generate new private key
-h, --help help for search
--phy Search physically stored objects
Expand Down
11 changes: 10 additions & 1 deletion docs/cli-commands/neofs-cli_object_searchv2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ Search object (compatibility, deprecated)
neofs-cli object searchv2 [flags]
```

### Examples

```
neofs-cli object searchv2 --cid <cid> --filters 'FilePath EQ cat.jpg'
neofs-cli object searchv2 --cid <cid> --filters 'Timestamp GE 1710000000' --filters 'Timestamp LE 1719999999'
neofs-cli object searchv2 --cid <cid> --filters 'FileName NOPRESENT'
neofs-cli object searchv2 --cid <cid> --filters filters.json
```

### Options

```
Expand All @@ -19,7 +28,7 @@ neofs-cli object searchv2 [flags]
--cid string Container ID.
--count uint16 Max number of resulting items. Must not exceed 1000
--cursor string Cursor to continue previous search
-f, --filters strings Repeated filter expressions or files with protobuf JSON
-f, --filters strings Repeated filter expressions ('key OP value' or 'key NOPRESENT') or files with protobuf JSON
-g, --generate-key Generate new private key
-h, --help help for searchv2
--phy Search physically stored objects
Expand Down
Loading