Command reference

Generated from --help, so it always matches the program. Every command accepts --json and --quiet. Exit codes: 0 ok, 1 failure, 2 usage, 3 authentication or setup, 4 network or service, 5 not found.

• wms access — Permissions: groups, per-user access, 2FA exemptions, sign-in limits and timeouts
• wms access check — Would this user be allowed? And why
• wms access export — Print the whole policy as JSON (a backup, or to edit and import)
• wms access groups — List, show, create, change and delete groups
• wms access groups create — A new, empty group (or a copy with --from)
• wms access groups delete — Delete a group (refused while users are in it)
• wms access groups list — Every group, its members and how many permissions it allows
• wms access groups restricted — Whether 2FA-exempt accounts may be in the group (it then may not hold admin-level permissions)
• wms access groups set — Allow, deny or clear a permission for a group
• wms access groups show — A group's permission grid
• wms access import — Replace the policy with a JSON file (checked before anything is written)
• wms access perms — List every permission
• wms access settings — Global timings: 2FA remember window, idle lock, maximum session, export expiry, download link lifetime
• wms access user — A user's groups, permission overrides, 2FA policy, sign-in limits and timeouts
• wms access user 2fa — The user's 2FA policy; exempt accounts may only be in restricted groups
• wms access user allow — Allow a permission for this user alone
• wms access user badge — Show or issue the user's barcode-badge sign-in token (never the literal username)
• wms access user channels — Which ways in the user may use
• wms access user dashboard — Also sign into the web dashboard with this account (yes/no)
• wms access user deny — Deny a permission for this user alone (beats every group)
• wms access user expires — The day the user's access ends
• wms access user inherit — Clear a user override (the groups decide)
• wms access user list — Every user with a policy entry
• wms access user note — A note on the entry (what the account is for)
• wms access user remove — Delete the user's entry (they go back to their ModernWMS role's access)
• wms access user rename — Rename a numeric Picker/Checker login ID (the MC9090's keypad-only login means the ID is the permanent username)
• wms access user set-groups — Put a user in these groups (this also brings them under the policy)
• wms access user set-name — Set a display name shown alongside a numeric-login account's user ID (e.g. "7354 - Kieran Collins")
• wms access user set-password — Set a local sign-in password for solo mode (see docs/guides/solo-mode.md) — ignored by ModernWMS/Part-DB logins
• wms access user show — A user's entry and effective permissions (with the reason for each)
• wms access user timeouts — Per-user 2FA remember window, idle lock and maximum session ("global" clears one)
• wms attendance — Clock in/out and the rota — see docs/guides/assigned-work.md
• wms attendance break-end — End a paid break
• wms attendance break-start — Start a paid break (stays clocked in; pauses pick/check work while it's on)
• wms attendance card — Delay / No Work Available cards — admin-applied, suppress the idle-ticket nudge while active
• wms attendance card clear — Clear someone's active card, if any
• wms attendance card list — Everyone with a card on right now
• wms attendance card set — Put a card on someone, closing any card they already have
• wms attendance card-scan — Scan a status card (today: the break card) to toggle it for yourself
• wms attendance clock-in — Start a shift
• wms attendance clock-out — End a shift
• wms attendance gate — Turn the clock-in requirement on or off (default: show current state)
• wms attendance rota — Who's scheduled when
• wms attendance rota clear — Remove someone's schedule for a day
• wms attendance rota override — Quick NS override: let someone work a day they're not on the rota for (default: today)
• wms attendance rota set — Schedule someone to work a day (updates any existing entry for that day)
• wms attendance rota show — Who's scheduled on a day (default: today)
• wms attendance status — Clocked in? Scheduled today?
• wms audit — Check the tamper-evident audit log
• wms audit head — Print the chain's newest hash, to keep a copy off this machine
• wms audit verify — Recompute the audit log's hash chain; exits non-zero at the first broken line
• wms backup — Back up ModernWMS's database via SQLite's online backup API (--encrypt to seal it with a passphrase)
• wms backup decrypt — Open an encrypted backup (never overwrites an existing file)
• wms bricklink — Live BrickLink lookups by number, prices and where-used (needs your API credentials)
• wms bricklink colors — BrickLink colour numbers
• wms bricklink colors sync — Map Rebrickable colours to BrickLink's (one call; needed for prices by colour)
• wms bricklink configure — Enter the four BrickLink API values (hidden as you type) and test them
• wms bricklink item — Look an item up by its BrickLink number
• wms bricklink price — BrickLink price guide: what it sold for (default) or is listed for (--stock)
• wms bricklink status — Show what is configured and today's call count (never the secrets)
• wms bricklink test — Check the credentials and the IP binding with one cheap call
• wms bricklink where-used — Which sets contain a part (BrickLink 'supersets')
• wms bricklink whoami — Show this server's public IP address — the one to register with BrickLink
• wms doctor — Check the install: services, tokens, keys, clock, file permissions, audit chain and backups
• wms gateway — Telnet + web-terminal gateway (secondary to the CLI)
• wms gateway serve — Start the Telnet daemon and the ttyd-fronted web terminal together
• wms lego — Manage the local LEGO collection (sets, parts, Rebrickable lookups)
• wms lego achievements — Collection milestones and how close you are to each
• wms lego add-part — Add or update an owned LEGO part: details from the catalog/Rebrickable, you give colour and quantity
• wms lego attach — Attach a scanned/photographed proof of the finished paper checklist
• wms lego backup — Back up your LEGO collection (sets, owned parts, history), without the re-downloadable catalog
• wms lego bag-add — Register and print another instance of a bag kind, once a set's default limit has been raised
• wms lego bag-find — What a bag code belongs to — a lost bag found without its checker, or double-checking a label
• wms lego bag-kind — The registered bag kinds (small, main, extra, and any added beyond those)
• wms lego bag-kind add — Register a new bag kind beyond small/main/extra
• wms lego bag-kind list — List every registered bag kind
• wms lego bag-labels — Print (or reprint) every bag label a set currently has — small, main, and extra once one exists
• wms lego bag-pool — Reusable physical bags with their own stable code, assigned to whichever set currently needs one
• wms lego bag-pool add — Register a reusable bag under its own stable code
• wms lego bag-pool assign — Hand a reusable bag to a set's current check instead of printing a fresh code
• wms lego bag-pool list — List every reusable bag and what it's currently doing
• wms lego bag-pool release — Free a reusable bag back to available by hand (normally happens automatically when its check finishes)
• wms lego bag-size — Which bag a part goes in while picking/checking: easy-to-lose small parts, or the main bag (default)
• wms lego build — Which sets your loose parts could (nearly) build — from the offline catalog, no internet needed
• wms lego catalog — The offline copy of Rebrickable's catalog (parts, sets, minifigs, set contents)
• wms lego catalog refresh — Download the catalog (free, no key needed; at most once a day), or load it from --from-dir
• wms lego catalog status — Show what the offline catalog holds and how old it is
• wms lego check — Check a set's parts: everything is 'have' except what you list as missing or extra
• wms lego checks — Set check sessions across the collection
• wms lego checks pending — Sets whose paper checklist is done but the CLI entry still isn't
• wms lego detail — Export a part's or set's page with its picture (a set includes its whole parts list)
• wms lego element-id — A part+colour's LEGO element id — show it, or set/correct it yourself
• wms lego export — Write your collection (or one set's missing parts) for another tool
• wms lego help-sheet — Printable cheat sheet of the TUI/telnet key bindings
• wms lego history — What changed in your collection, who changed it, and from what to what
• wms lego import — One-time import of legacy KC-LEGO-CLI JSON data into the local LEGO store
• wms lego import-parts — Import a parts list: a Rebrickable CSV or a BrickLink inventory XML (--dry-run shows the plan first)
• wms lego labels — Printable set labels (thermal 4x6/100x150/62mm/50x30/40x30, or A4/Letter sheets)
• wms lego low — List the parts that are below the minimum you set
• wms lego missing — What a set still needs, compared with the loose parts you hold (part + colour)
• wms lego missing-sheet — Combined label sheet of everything missing, across several checked sets
• wms lego optional — Mark a part optional, so it never counts as missing (default: on for stickers)
• wms lego orders — Orders for missing parts: supplier, prices, shipping, invoice, tracking, received
• wms lego orders add-line — Add a part to an order
• wms lego orders list — All orders (--status wanted|ordered|shipped|received|cancelled|open)
• wms lego orders new — Start an order (--from-set adds everything that set is short)
• wms lego orders show — An order and its lines
• wms lego orders status — Move an order along (received fills the sets it was for)
• wms lego paper-done — Mark a set's paper checklist as finished — the CLI entry is still to come
• wms lego parts-sheet — Printable barcode sheet of a set's parts, for the stock-check scanner mode
• wms lego report — Printable reports: stock-take, parts lists, missing/extra parts, sets, orders, check history
• wms lego report archive — Browse and re-fetch previously generated reports
• wms lego report archive get — Mint a fresh share link (and QR) for an archived report
• wms lego report archive list — List archived reports (yours, unless --all)
• wms lego report extra — Extra Parts: spares left over from completed set checks
• wms lego report history — Past stock checks, newest first — for one set, or across the collection
• wms lego report missing — Missing Parts: what's still missing, for the given sets or every incomplete set
• wms lego report orders — Order List: every parts order, most recent first
• wms lego report setlist — List of Sets on Collection: every set you own, no loose parts
• wms lego report setparts — Set (ID) Parts Lists: one or more sets' full parts lists, side by side
• wms lego report stocktake — Parts Stock-take: a blank printable checklist for counting a set by hand
• wms lego reset — Clear every set, owned part and check/order/ticket history to start fresh
• wms lego restore — Put your owned parts and sets back as they were at a snapshot (the present is saved first, so it can be undone)
• wms lego retirement — LEGO set retirement dates (from a community-maintained sheet — not Rebrickable, which has no such field)
• wms lego retirement import — Import retirement dates from a local CSV (the sheet's own column headers, or close to them)
• wms lego retirement list — Sets retiring soon, flagged with whether you own or are watching them
• wms lego retirement refresh — Fetch retirement dates from the configured (or --url) sheet
• wms lego search — Search parts, sets and minifigures — offline catalog first, live Rebrickable only if it has nothing
• wms lego search minifigs — Search minifigs
• wms lego search parts — Search parts
• wms lego search sets — Search sets
• wms lego set-info — Where a set is kept and its condition (sealed, built, in pieces, displayed)
• wms lego set-min — Set the stock level below which a part counts as low (0 stops tracking it)
• wms lego set-photo — Attach a photo to a set — the box, the built model, anything worth keeping a picture of
• wms lego set-photo-remove — Remove one attached set photo — the wrong one attached by mistake, say
• wms lego set-photos — List a set's attached photos
• wms lego share — A read-only page for someone without the CLI (a wishlist or your collection), viewable until it expires
• wms lego share collection — Share your full collection as a read-only page
• wms lego share wishlist — Share your BrickLink watch list (wms lego watch) as a plain page — for family before a birthday
• wms lego shopping — What a checked set is still missing, with BrickLink/BrickOwl prices, spares you hold and where to buy
• wms lego small-bag-label — A label for the set's small-parts bag — the set number, name, and (if given) the bag's own barcode
• wms lego snapshots — List restore points (one is taken before the first change of each day)
• wms lego snapshots take — Take a snapshot now
• wms lego spend — What missing parts have cost (parts + shipping) by set, supplier or month
• wms lego stats — The collection at a glance: sets, pieces, colours, categories, low stock
• wms lego sync-parts — Push owned LEGO parts into Part-DB through its API (one-way; sets are never synced)
• wms lego today — Set of the Day: a set your loose parts nearly cover (90%+), the same for everyone today
• wms lego value — What your collection is worth by BrickLink's average sold prices (always 'N of M priced')
• wms lego wanted — Write a BrickLink wanted list (XML) for a set's missing parts or your low-stock parts
• wms lego watch — Be told (ntfy/webhook) when a part or set's BrickLink price falls to your limit
• wms lego watch add — Watch an item
• wms lego watch check — Check every watch now (uses BrickLink calls) and show the ones at your limit
• wms lego watch list — Show your watches and what they last saw
• wms lego watch rm — Stop watching
• wms menu — Quick launcher: pick a tool from a short list and run it (alias: q)
• wms menu list — List every tool with its id (for scripts and tools.json)
• wms menu run — Run one tool by id, without the list
• wms motd — Show or set the message of the day on the sign-on screen
• wms notify — Alerts to Discord, Slack, Telegram, Teams, email, Pushover, Gotify, WhatsApp (webhook) or ntfy
• wms notify channels — List the channels and where each event goes
• wms notify route — Send an event only to these channels (all = every channel)
• wms notify test — Send a test alert to every channel (or --channel id) and report each result
• wms plugin — Your own programs: wms foo runs wms-foo, and enabled plugins can react to events
• wms plugin disable — Turn a plugin off
• wms plugin enable — Review a plugin's checksum and turn it on
• wms plugin list — Show the plugins in the folder and their state
• wms plugin new — Create an example plugin (not enabled) to start from
• wms plugin run — Run an enabled plugin (same as wms <name> [args...])
• wms preflight — Audit the code, the files to be published and the live machine, and say GO or NO-GO
• wms publish — Push the committed code to GitHub as one new commit (after the preflight says GO)
• wms receive — Receive stock instantly via an ASN ticket, no login/menu needed
• wms sync — PartDB -> ModernWMS sync engine: status, trigger, or serve the REST API
• wms sync serve — Run the REST API + /metrics and the background sync loop (blocks)
• wms sync set-password — Set the sync dashboard's REST API credentials
• wms sync status — Print the last sync run's stats
• wms sync trigger — Run one sync cycle now and print the result
• wms sys — Small system helpers used by the launcher and the login banner
• wms sys audit — Show the newest audit log entries (-f to follow)
• wms sys banner — The one-line status shown at login
• wms sys connect — How to connect from another machine (telnet or a browser)
• wms sys guide — A short card of the commands worth remembering
• wms sys mobile-setup-qr — QR code for a new phone's first-time KC-Parts Pick setup
• wms sys pdf-editor — QR code / link for your Stirling-PDF instance, to touch up a generated PDF before printing
• wms sys status — System health: memory, disk, containers, gateway, backups
• wms tui — Launch the interactive 5250-style terminal (default when no subcommand is given)
• wms update — Check GitHub for a newer release, and install it (after verifying its SHA-256)
• wms users — Create/list/reset/delete users across both ModernWMS and Part-DB
• wms users 2fa — Manage TOTP two-factor authentication for TUI logins
• wms users 2fa disable — Remove TOTP 2FA from a user
• wms users 2fa enable — Enroll a user in TOTP 2FA (opt-in, off by default)
• wms users 2fa status — Show whether a user has TOTP 2FA enabled
• wms users 2fa unlock — Clear a 2FA lockout (5 wrong codes in a row lock the account for 5 minutes, doubling each time)
• wms users create — Create a user with a random temp password (default role: Picker)
• wms users delete — Delete a user from one system (asks first; --yes to skip the question)
• wms users list — List all users across both systems
• wms users reset — Reset a user's password to a new random temp password
• wms users set-password — Set a specific password (no forced change)
• wms users toggle — Enable or disable a user account
• wms version — Print the version