-
Notifications
You must be signed in to change notification settings - Fork 0
Text Query Syntax
The power search box accepts a compact text syntax for precise filtering — ideal if you'd
rather type qty<10 mfr:acme than click through the visual builder.
Pressing Enter runs it (and fills the builder, so you can fine-tune afterwards).
Where to find it: the second box in the Visual search panel (Inventory → More → Visual search).

A query is a list of terms separated by spaces. A bare word matches item names:
esp32
Add a field: prefix to search a specific field:
mfr:acme items whose manufacturer contains "acme"
name:bracket items whose name contains "bracket"
Field names are case-insensitive and accept short aliases.
| Field | Aliases | Matches |
|---|---|---|
| Name | name |
The item name |
| Description |
description, desc
|
The description |
| Notes |
notes, note
|
Free-text notes |
| Manufacturer |
manufacturer, mfr, make
|
The maker |
| Part number | mpn |
Manufacturer part number |
| Barcode |
barcode, gtin, upc, ean
|
A scanned/entered barcode |
| Serial number |
serial, serialnumber, sn
|
The unit's serial number |
| Quantity |
quantity, qty
|
On-hand count (numeric) |
| Weight | weight |
Item weight (numeric) |
| Dimensions |
width, height, depth
|
Bounding size (numeric) |
| Favourite |
favourite, favorite, fav
|
Pinned favourites (yes/no) |
Numeric fields accept >, < and =:
qty<10 fewer than 10 in stock
qty=0 out of stock
weight>500 heavier than 500 g
The favourite flag is a yes/no:
fav:yes only your favourites
Capabilities are weighted attributes you define. Use the
cap: prefix:
cap:waterproof items that have the "waterproof" capability
cap:voltage>3.3 capability "voltage" greater than 3.3
cap:colour=red capability "colour" equal to "red"
Custom category fields work the same way with field: (or cf:):
field:material=steel
-
Spaces mean AND — every term must match:
qty<10 mfr:acme. -
OR— either side:mfr:acme OR mfr:globex. -
Parentheses group logic:
cap:voltage>3.3 (qty<10 OR mfr:acme).
💡 Tip A value containing a bracket or a
|must be quoted so it isn't read as grouping — for examplename:"a|b".
ℹ️ Note If a term can't be understood, Gubbins tells you why rather than silently ignoring it — so a typo'd field name is easy to spot and fix.
- Visual query builder — the same queries, built by clicking.
- Natural-language search — no syntax to learn at all.
- Saved searches & favourites — keep a query for reuse.
Gubbins · a local-first, offline inventory app · Report an issue
Getting started
Inventory
- Items
- Tracking modes
- Locations & stock
- Location photos & regions
- Batches & lots
- Variants & SKUs
- Kits & bundles
- Tags, attachments & related
- Custom fields & capabilities
- Low stock & gauges
- Counting by weight
- Container weights
- Bulk edit & clone
- Inventory views
Asset lifecycle
- Warranty & depreciation
- Current value & revaluation
- Maintenance & servicing
- Test & calibration records
- Condition grading
- Cycle counts & audit day
- Insurance & estate schedule
People, loans & bookings
Users & access
Search
- Search overview
- Visual query builder
- Text query syntax
- Natural-language search
- Saved searches & favourites
Scanning & labels
Purchasing & projects
- Projects & BOM
- Budgets
- Purchase orders
- Reorder & shopping list
- Wishlist
- Supplier parts & price history
- Suppliers
Reports & insights
- Reports overview
- Valuation & spend
- ABC, turnover & aging
- Sales & margin
- Data hygiene
- Parts catalogue
Sales & disposals
Alerts, activity & agenda
Companion extension
Data, sync & resilience
- How your data is stored
- Cloud sync
- Backup & restore
- Export & import
- Migrating from another tool
- Storage triage
- Danger zone: erasing data
Bridge & Home Assistant
- Bridge overview
- Running the bridge
- Bridge API tokens
- Home Assistant
- AI assistant query (MCP)
- Webhooks
- Webhooks, MQTT & iCal
Settings & customisation
- Appearance & theming
- Branding
- Dashboard & widgets
- Modular UI
- Language & region
- Notifications
- Kiosk & tablet mode
Reference