-
Notifications
You must be signed in to change notification settings - Fork 0
First Run and Quick Start
This page takes you from a blank slate to your first tracked item. It should take just a couple of minutes.
ℹ️ Note If you haven't opened Gubbins yet, see Installing Gubbins first.
The very first time you open Gubbins, it offers a short, skippable setup:
- Choose the modules you want. Gubbins can hide whole areas it thinks you may not need (Projects, Purchase orders, Bookings, and more) so the app starts lean. Pick a preset, or just Skip to keep the standard set on — you can change any of this later on the Modular UI screen. (A couple of modules, such as Users, start switched off and are never turned on by a preset.)
- Your currency and region are guessed from your device, so prices and dates look right straight away. You can adjust them under Language & region.
💡 Tip Not sure what you'll use? Skip the chooser. Nothing is switched off, and you lose nothing by turning modules off later — hidden features keep all their data.
Open Inventory from the menu and select Add item. Give it a name — that's the only required field — and select Create item.

A few fields are worth knowing about even now:
- Tracking decides how Gubbins counts this item. Leave it as the default for a simple count; the full list is on Tracking modes.
- Initial quantity is how many you have right now.
- Everything else — photo, category, price, location, notes — is optional and can be added later by editing the item.
💡 Tip You don't have to create items one at a time. If you already have a list in a spreadsheet or another app, you can paste or import it in one go — see Export & import and Migrating from another tool.
Locations are where things live — a room, a shelf, a drawer, a bin. In Inventory, select Add location, name it, and (optionally) give it a colour and a parent location to build a hierarchy like Garage → Shelf A.
Once you have locations, you can assign items to them and move stock between them. The full picture is on Locations & stock.
- The menu (top of every screen) jumps to any area.
- The dashboard shows totals and anything needing attention.
- Search (and the command palette) finds items instantly — see Search overview.
- Learn the model: Core concepts.
- Flesh out an item: Items.
- Organise where things live: Locations & stock.
- Make it yours: Appearance & theming and Modular UI.
- Sharing this device with other people? Users & accounts.
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