io7m | single-page | multi-page | epub | Cardant User Manual 1.0.0-beta0001
7.2.20. item-metadata-remove
Previous
7.2. Shell Command Reference
Up
7.2.22. item-search-next
Next

# 7.2.21. item-search-begin

- 7.2.21.1. Name
- 7.2.21.2. Description
- 7.2.21.3. Parameters

## 7.2.21.1. Name

1
item-search-begin - Start searching for items.

## 7.2.21.2. Description

1
The item-search-begin command begins searching for items.
2
Items can be filtered based on matching their names against a given name match expression.
3
Items can be filtered based on matching their descriptions against a given description match expression.
4
Items can be filtered based on matching their types against a given type match expression.

## 7.2.21.3. Parameters

### 7.2.21.3.1. --description-match

Attribute | Value
--- | ---
Name | --description-match
Type | com.io7m.cardant.model.CADescriptionMatch
Default Value | with-any-description
Cardinality | [1, 1]
Description | Only include items that have descriptions matching the given expression.

### 7.2.21.3.2. --limit

Attribute | Value
--- | ---
Name | --limit
Type | java.lang.Integer
Default Value | 100
Cardinality | [1, 1]
Description | The maximum number of results per page.

### 7.2.21.3.3. --location-match

Attribute | Value
--- | ---
Name | --location-match
Type | com.io7m.cardant.model.CALocationMatchType
Default Value | any-location
Cardinality | [1, 1]
Description | Only include items in locations matching the given expression.

### 7.2.21.3.4. --metadata-match

Attribute | Value
--- | ---
Name | --metadata-match
Type | com.io7m.cardant.model.CAMetadataElementMatchType
Default Value | anything
Cardinality | [1, 1]
Description | Only include items with metadata matching the given expression.

### 7.2.21.3.5. --name-match

Attribute | Value
--- | ---
Name | --name-match
Type | com.io7m.cardant.model.CANameMatchFuzzy
Default Value | with-any-name
Cardinality | [1, 1]
Description | Only include items that have names matching the given expression.

### 7.2.21.3.6. --serial-match

Attribute | Value
--- | ---
Name | --serial-match
Type | com.io7m.cardant.model.CAItemSerialMatch
Default Value | with-any-serial
Cardinality | [1, 1]
Description | Only include items with serial numbers matching the given expression.

### 7.2.21.3.7. --type-match

Attribute | Value
--- | ---
Name | --type-match
Type | com.io7m.cardant.model.CATypeMatch
Default Value | with-any-type
Cardinality | [1, 1]
Description | Only include items that have types matching the given expression.

7.2.20. item-metadata-remove
Previous
7.2. Shell Command Reference
Up
7.2.22. item-search-next
Next
io7m | single-page | multi-page | epub | Cardant User Manual 1.0.0-beta0001