Wilfie CLI
Wilfie is a command-line client for Wilfie APIs.
Use it to authenticate and run workspace, workflow, and WMS commands from your terminal.
Workspace order, stock and general analytics reads share their API request code
with Wilfie's MCP tools. Start analytics with
wilfie wms analytics config --workspace <workspace_code> to discover available
metrics, supported filters, periods and dimensions, then use summary,
timeseries, dimension-members or leaderboards. Metric availability and
currency readiness come from the workspace; revenue is not assumed to exist.
Install
uv tool install wilfie
Or with pip:
pip install wilfie
Quickstart
Login with device flow:
wilfie auth login --client-id wilfie-cli
Check auth status:
wilfie auth status
List workspaces:
wilfie workspaces list
Run a WMS query:
wilfie wms query \
--workspace <workspace_code> \
--path facility-locations/search \
--param query=A-01 \
--param limit=25
Inspect fulfillment document lineage:
wilfie wms documents lineage \
--workspace <workspace_code> \
--kind fulfillment_order \
--document-id <fulfillment_order_id> \
--line-id <line_id> \
--max-depth 8
Resolve a barcode and inspect tote outbound context:
wilfie wms barcodes resolve \
--workspace <workspace_code> \
--facility-id <facility_id> \
--barcode <scan_value>
wilfie wms containers outbound-context \
--workspace <workspace_code> \
--container-id <container_id>
Run Shopify outbound reconcile (manual trigger):
wilfie wms reconcile outbound \
--workspace <workspace_code> \
--integration-connection-id <integration_connection_id> \
--order-id gid://shopify/Order/123 \
--dry-run
Analyze live-selling performance after ignoring orders less than $8:
wilfie --output json live-selling orders \
--workspace <workspace_code> \
--period this_month \
--order-total-less-than 8
Download order-level live-selling data for local analysis:
wilfie live-selling orders \
--workspace <workspace_code> \
--period this_month \
--order-total-less-than 8 \
--download-file live-selling-orders.csv
List open WMS issues for a facility:
wilfie wms issues list \
--workspace <workspace_code> \
--facility-id <facility_id> \
--status open
Recompute WMS issues for a facility (admin/owner access required):
wilfie wms issues recompute \
--workspace <workspace_code> \
--facility-id <facility_id> \
--dry-run
This package provides workspace functionality in local, dev and production environments. Platform infrastructure administration is distributed separately.
Supplier Offer Recovery
Use these commands in order to restore PIM details from the stored Shopify mirror, fill missing offer catalog fields, and reapply the offer's pricing:
wilfie supplier-offers update-pim --workspace <workspace_code> --offer-id <offer_id>
wilfie supplier-offers hydrate --workspace <workspace_code> --offer-id <offer_id>
wilfie supplier-offers promote-pricing --workspace <workspace_code> --offer-id <offer_id>
Update PIM also copies mirror prices into PIM, so run Pricing Only last. Hydrate
preserves offer pricing and supports --dry-run; its default mode fills blanks.
Pricing Only requests pricing updates without publishing catalog fields or inventory.
The queued commands wait for completion unless --no-wait is supplied. Review
the returned warnings and per-product results for skipped or failed updates.
All three commands require OAuth login. Update PIM and Hydrate require workspace
admin access; Pricing Only requires editor access.
Xero Integration
Every Xero command requires the exact workspace and integration connection. The CLI calls Wilfie's workspace APIs and never stores Xero tokens or chooses a tenant implicitly. These commands use Wilfie OAuth login; API-key-only profiles are not accepted by the current workspace Xero endpoints.
wilfie integrations connections list --workspace <workspace_code> --integration-type xero
wilfie integrations xero settings get --workspace <workspace_code> --connection-id <connection_id>
wilfie integrations xero accounting selectors --workspace <workspace_code> --connection-id <connection_id>
wilfie integrations xero accounting mappings list --workspace <workspace_code> --connection-id <connection_id>
wilfie integrations xero contacts sync --workspace <workspace_code> --connection-id <connection_id> --mode full
wilfie integrations xero contacts list --workspace <workspace_code> --connection-id <connection_id> --unmapped-only
wilfie integrations xero contacts create-supplier --workspace <workspace_code> --connection-id <connection_id> --xero-contact-id <contact_id> --expected-payload-hash <sha256> --confirm
wilfie integrations xero invoices list --workspace <workspace_code> --connection-id <connection_id> --invoice-type ACCPAY
wilfie integrations xero invoices sync --workspace <workspace_code> --connection-id <connection_id> --mode full
wilfie integrations xero invoices attachments --workspace <workspace_code> --connection-id <connection_id> --xero-invoice-id <xero_invoice_id>
wilfie integrations xero invoices import --workspace <workspace_code> --connection-id <connection_id> --xero-invoice-id <xero_invoice_id> [--attachment-id <attachment_id>]
Use accounting mappings set to configure GL and tax selections. Run contacts sync --mode full once for the initial contact mirror; Xero CONTACT webhooks then
maintain it, with no scheduled provider sync. Use contacts list before either
creating a guarded Wilfie supplier from a reviewed Xero contact or deliberately
linking an existing supplier with supplier-mappings link. Supplier ensure can
create or update a Xero contact with approved Wilfie bank details and therefore
requires --confirm.
Run invoices sync --mode full once for the initial invoice mirror. Xero Invoice
webhooks maintain it afterward; use --mode targeted --xero-invoice-id <id> for
one-record repair or rerun full only for a diagnosed wider repair. No Xero CLI
command creates a recurring provider sync. Use invoice-mappings candidates to compare an existing Wilfie AP invoice with
same-number Xero bills, then invoice-mappings link with the selected exact-match
Xero InvoiceID. Local invoice list/detail is the default; invoices live-list is
the explicitly bounded provider read. invoices sync queues the durable mirror
operation and follows it unless --no-wait is supplied.
For a supplier bill created in Xero first, use invoices attachments to inspect
the original files, then invoices import to send the selected PDF through the
same detailed extraction and review workflow as a Wilfie drag-and-drop upload.
The import is idempotent for the Xero InvoiceID, does not retry the POST after a
network error, and follows the extraction operation unless --no-wait is used.
Common Commands
wilfie auth loginwilfie auth refreshwilfie auth logoutwilfie workflows list --workspace <workspace_code>wilfie workflows runs --workspace <workspace_code> --workflow-id <id>wilfie workflows run-detail --workspace <workspace_code> --workflow-id <id> --run-id <id>wilfie workflows execute --workspace <workspace_code> --workflow-id <id>wilfie live-selling orders --workspace <workspace_code> --period this_month --order-total-less-than 8wilfie wms facilities --workspace <workspace_code>wilfie wms skus --workspace <workspace_code>wilfie wms documents list --workspace <workspace_code> --kind sales_order [--search-query <query>]wilfie wms documents list --workspace <workspace_code> --kind fulfillment_orderwilfie wms documents detail --workspace <workspace_code> --kind fulfillment_order --document-id <id>wilfie wms documents lineage --workspace <workspace_code> --kind fulfillment_order --document-id <id> --line-id <id>wilfie wms barcodes resolve --workspace <workspace_code> --facility-id <facility_id> --barcode <scan_value>wilfie wms containers outbound-context --workspace <workspace_code> --container-id <container_id>wilfie wms issues list --workspace <workspace_code> [--facility-id <facility_id>] [--status <open|ignored|resolved>]wilfie wms issues recompute --workspace <workspace_code> [--facility-id <facility_id>] [--scope <scope>] [--dry-run]wilfie wms reconcile outbound --workspace <workspace_code> --integration-connection-id <id> [--order-id <shopify_order_id>] [--fulfillment-order-id <shopify_fo_id>] [--dry-run]wilfie integrations xero settings get --workspace <workspace_code> --connection-id <connection_id>wilfie integrations xero supplier-mappings get --workspace <workspace_code> --connection-id <connection_id> --supplier-company-id <supplier_id>wilfie integrations xero invoice-mappings candidates --workspace <workspace_code> --connection-id <connection_id> --invoice-id <wilfie_invoice_id>wilfie integrations xero invoices list --workspace <workspace_code> --connection-id <connection_id>
Configuration
- Default API host is
https://wilfie.ai. - Use
--base-urlto target another environment. - Output modes:
--output table(default),--output json.
Links
- Homepage: https://wilfie.ai
- Documentation: https://github.com/gavincliffe/wilfie-flask-app/tree/main/docs
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file wilfie-2026.9.12.1.tar.gz.
File metadata
- Download URL: wilfie-2026.9.12.1.tar.gz
- Upload date:
- Size: 72.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e2dbe4c76f25c42f8df1c8cf1dfe1457de868c2ba30d6daad2afe68384a35418
|
|
| MD5 |
a54fa87cfea29023ab97b285dce1e1ec
|
|
| BLAKE2b-256 |
1b6360d18ff49bf28a8122229b96aeee15f3998484ee91000f5e1262622369b7
|
File details
Details for the file wilfie-2026.9.12.1-py3-none-any.whl.
File metadata
- Download URL: wilfie-2026.9.12.1-py3-none-any.whl
- Upload date:
- Size: 72.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
66e2aea7b509f56802dbecd1237874010cfb2ea564db6b6e0f0d87f652440f94
|
|
| MD5 |
48acd950e44ffe17f0446fee8f1c47fe
|
|
| BLAKE2b-256 |
a919c61540a7ca04d09cd346e9db2b469e8c240f50714a39e19815ea0cf2d4b6
|