Verb reference
All eleven verbs, what each does, and an example of each.
Eleven verbs. Everything else is a filter or a flag.
| Verb | Does |
|---|---|
find | Select a working set. Usually the start of a chain. |
export | Metadata out to CSV, XLSX or your own template. |
download | Files and drawings out as a package. |
compare | BOM-to-BOM or revision-to-revision differences. |
create | New parts, records or projects in batch. |
set | Update field values across a selection. |
checkout / checkin | Lock and release for editing. |
link | Relate parts to suppliers, documents or projects. |
report | Generate a formatted report. |
backup | Snapshot to storage you control. |
sync | Push to or pull from connected systems. |
Worked examples
Find the gaps
find part where lifecycle = 'released' and supplier.price is null
Every released part nobody has priced. This is usually the whole explanation when a rolled cost looks too low.
Export for a specific audience
export part where project = 'HALO6' --template 'erp-daily'
Runs a saved column template rather than re-picking columns each time.
Package files
download file where part.number like 'BLD%' and file.type = 'pdf'
Every drawing for a part family, as one archive.
Create in batch
create part
848484 "Housing, lower"
4948484 "Seal, shaft, 12mm"
Several parts in one action, each as a draft.
Flags
| Flag | Effect |
|---|---|
--dry-run | Stop at the preview permanently. Never executes. |
--atomic | If any row fails, the whole batch rolls back rather than half-applying. |
--format | For exports and reports: xlsx, csv or pdf. |
--template | Use a saved column template. |
--level | For BOM operations: top or all. |
--destination | Where output is written. |
Email [email protected] and a person will pick it up. Include the part number and what you were doing — it saves a round trip.