Command line reference¶
Every faxbot command, its options and arguments, generated from the command definitions. For installation, profiles, scripting and owner recovery, see Command line.
Send and receive faxes and look after your Faxbot installation from the command line. Commands work with a running Faxbot server and use your key. The admin status, migrate, recover-owner, backup and restore commands work on this computer while Faxbot is stopped.
Usage:
$ faxbot [OPTIONS] COMMAND [ARGS]...
Options:
--url ADDRESS: Faxbot server address, for example https://fax.example.com. Defaults to your saved profile, then http://localhost:8080. [env var: FAXBOT_URL]--key API_KEY: The key to use. Defaults to the key in your saved profile. A profile or FAXBOT_API_KEY keeps the key out of your command history. [env var: FAXBOT_API_KEY]--profile NAME: Saved profile to use (see faxbot admin profiles). [env var: FAXBOT_PROFILE]--json: Print results as JSON, for scripts.-q, --quiet: Print nothing when a command works, except keys and passwords shown only once.--version: Show the version and exit.--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.
Commands:
send: Send a fax.status: Show what is sending now, what waits and...overview: Show the Overview: what Faxbot is doing...savings: What Faxbot can do to save money here and...faxes: Faxes received, sent and expected, forms...delivery: How faxes come in, go out and reach your...recipients: Fax numbers you send to: routing, batching...admin: Look after the installation: people and...
faxbot send¶
Send a fax. Faxbot accepts it and sends it in the background.
Usage:
$ faxbot send [OPTIONS] {to} {file}
Arguments:
to: Fax number to send to, for example +15551234567. [required]file: PDF or plain text file to fax. [required]
Options:
--queue: Accept the fax without sending it. Faxbot allows this only while sending is turned off (test mode).--idempotency-key KEY: Your own reference for this fax. Sending again with the same reference returns the first fax instead of sending twice.--now: Send immediately, even when this number batches faxes; faxes already waiting for it go in the same call.--urgent: Send before other faxes waiting for the same line, without waiting to go together with other faxes.--by-call: Place a real call through your carrier even when the number is one of your own, for example to test your fax line.--mailbox <str>: Send from this mailbox, so its sending rules apply.--workflow KEY: The workflow this fax is part of, such as referrals.--label <str>: A label for this fax, such as legal (repeat it).--by TIME: The time the fax must be sent by, such as 17:00 or '2026-10-08 17:00', in your installation's time zone. Faxbot never holds the fax past it for the recipient's hours or a busy hour.--recipient NAME: The provider or person the fax is for. Before a first fax to a number, Faxbot warns when the NPI registry lists that number for someone else; it still sends.--patient-record-number NUMBER: Only for a recipient that takes documents into its health records (FHIR): the patient's medical record number there. Faxbot keeps it with the fax's document and never prints it.--patient-record-system SYSTEM: The system that medical record number belongs to, such as urn:oid:2.16.840.1.113883.19.5. Leave it out to use the FHIR client's own.--patient-family-name NAME: The patient's family name, for a recipient that confirms the patient.--patient-given-name NAME: The patient's given name, for a recipient that confirms the patient.--patient-birth-date DAY: The patient's birth date, such as 1980-04-30, for a recipient that confirms the patient.--cover-in-header: The first page is a cover sheet: print its notice in the header of every page instead and leave that page out. Needs a header notice ('faxbot delivery identity notice set'); a recipient that needs a cover sheet still gets it.--court DETAILS.json: Send under the California court profile, with the case details in this JSON file: purpose file or serve, county, case_number, plaintiff, defendant, documents (title and pages) and sender. Filing adds the MC-005 cover sheet; the pages otherwise go exactly as given.--engine ENGINE: For a call over your SIP trunk, the fax engine that places it: auto (Faxbot chooses), builtin (the built-in engine), or hylafax (the SSL Fax engine when it is running, else the built-in engine). [default: auto]--help: Show this message and exit.
faxbot status¶
Show what is sending now, what waits and why, what needs you, and how today went; or where one sent fax is.
Usage:
$ faxbot status [OPTIONS] [FAX_ID]
Arguments:
[FAX_ID]: A sent fax: show where that fax is now. Leave it out to see every fax that is sending or waiting.
Options:
--watch: Show the board again every 5 seconds until you press Ctrl-C.--help: Show this message and exit.
faxbot overview¶
Show the Overview: what Faxbot is doing for you, the next improvements, everyday faxes and what needs attention, as on the console.
Usage:
$ faxbot overview [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings¶
What Faxbot can do to save money here and what it has saved, and what faxing costs you: spending, charges, invoices, and the prices and plans Faxbot uses.
Usage:
$ faxbot savings [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
mechanisms: List every way Faxbot saves money, grouped...facts: Show what one missing fact cost you per...results: Show how much money Faxbot saved by...spending: Show what faxing cost per route: carrier...reconcile: Ask your SIP trunk carrier now what each...fax: Show what one fax cost (the carrier's...received: Show what the call that brought in a...portfolio: Compare setup bundles under an explicit...rate-cards: Show the prices Faxbot uses to estimate...rate-rows: Replace the prices by where calls start...state-prices: Import a carrier's US prices for calls...predict: Show what a fax to a number would take and...analysis: Read the saved analysis, its freshness and...opportunities: Ways to pay less, from what your faxes and...capabilities: Everything Faxbot can do to make your...charges: What each provider charged: how Faxbot...invoices: Your providers' monthly invoices, and the...plans: Your plans: each plan's budget or...
faxbot savings mechanisms¶
List every way Faxbot saves money, grouped by where it acts on a fax: whether each is on, whether it works on this installation, and how far it is tested. What each one saved is in faxbot savings results.
Usage:
$ faxbot savings mechanisms [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings facts¶
Show what one missing fact cost you per recipient: a partner, a recipient's approval, a price or a plan's allowance, priced against the best route you may use, less what establishing it costs. Advice only.
Usage:
$ faxbot savings facts [OPTIONS]
Options:
--days <int range>: How many days of sent faxes to price again. [default: 90; 7<=x<=183]--help: Show this message and exit.
faxbot savings results¶
Show how much money Faxbot saved by batching faxes to the same number, delivering directly to partners, leaving out documents a recipient already has, and sending pages faster. All figures are estimates.
Usage:
$ faxbot savings results [OPTIONS]
Options:
--days <int range>: How many days back to count. [default: 30; 1<=x<=366]--help: Show this message and exit.
faxbot savings spending¶
Show what faxing cost per route: carrier charges, estimates for faxes not billed yet, and what is waiting.
Usage:
$ faxbot savings spending [OPTIONS]
Options:
--since <str>: Start date, for example 2026-09-01. Default: the last 30 days.--help: Show this message and exit.
faxbot savings reconcile¶
Ask your SIP trunk carrier now what each recent call cost. This never changes a fax's delivery result.
Usage:
$ faxbot savings reconcile [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings fax¶
Show what one fax cost (the carrier's charge, or why it is not known yet), or with --to what one would cost.
Usage:
$ faxbot savings fax [OPTIONS] [fax_id]
Arguments:
fax_id: Fax ID from 'faxbot faxes sent list --ids' or, with --received, from 'faxbot faxes received list --ids'.
Options:
--received: The fax is a received fax.--to NUMBER: Instead of a sent fax: what a fax to this number would cost by each account your rules allow.--pages <int range>: With --to: pages in the fax. [default: 1; 1<=x<=1000]--from-site SITE: With --to: price calls from this site's accounts first.--help: Show this message and exit.
faxbot savings received¶
Show what the call that brought in a received fax cost, or the cost of every received fax.
Usage:
$ faxbot savings received [OPTIONS] [fax_id]
Arguments:
fax_id: Received fax ID, from 'faxbot faxes received list --ids'.
Options:
--all: Every received fax you can see, newest 100 first.--help: Show this message and exit.
faxbot savings portfolio¶
Compare setup bundles under an explicit budget and expected/cautious assumptions. Costs, currency, period and whose amounts count come from the file. Inputs are not saved and no partner is enrolled or route changed.
The JSON object needs currency (for example USD), horizon (the period), perspective (whose amounts count), budget, nodes, groups and relationships. A node has id, label, cost, installed (true/false) and group_id (or null). A shared group has id, label and cost. A relationship has a and b (the two node IDs), expected and cautious benefits. Use empty lists for no groups or relationships, and stable lowercase IDs.
Write every amount as quoted decimal text with up to six decimal places, or null for unknown. Costs and budget are nonnegative; benefits are running-cost reductions over the period, excluding setup, and can be negative for higher running costs. Use one currency throughout, at most ten nodes and ten groups, and one relationship per pair. Amount magnitudes cannot exceed 1,000,000,000,000.
Usage:
$ faxbot savings portfolio [OPTIONS]
Options:
--file <str>: UTF-8 JSON scenario file, or - for standard input; at most 64 KiB. [required]--help: Show this message and exit.
faxbot savings rate-cards¶
Show the prices Faxbot uses to estimate costs, or replace them from a file.
Usage:
$ faxbot savings rate-cards [OPTIONS]
Options:
--replace FILE: Replace all rate cards with the cards in this JSON file ({"cards": [...]}, or '-' for standard input).--help: Show this message and exit.
faxbot savings rate-rows¶
Replace the prices by where calls start that you entered for one sending card, or import a rate deck priced by caller ID for it. Earlier rows and decks are kept as history.
Usage:
$ faxbot savings rate-rows [OPTIONS] {ROUTE}
Arguments:
ROUTE: The sending card's route, as 'faxbot savings rate-cards' lists it, such as sip-gamma or sinch-uk. [required]
Options:
--replace FILE: Your prices by where calls start for that card, from this JSON file ({"rows": [...]}, or '-' for standard input).--caller-id-deck FILE: A carrier's rate deck priced by the caller ID a call shows (CSV): Twilio's voice price file, or Faxbot's own layout.--deck-format twilio|faxbot: The deck layout; Faxbot recognises Twilio's file by its first line.--source URL: Where the deck came from.--published DATE: The date the deck was published or read, such as 2026-10-09.--help: Show this message and exit.
faxbot savings state-prices¶
Import a carrier's US prices for calls within one state and between states. Faxbot prices each call from the state of its trunk's site, and never changes caller ID to lower a charge.
Usage:
$ faxbot savings state-prices [OPTIONS] {carrier} {file}
Arguments:
carrier: The carrier, such as anveo. [required]file: The carrier's price file (CSV) with a price for calls between states and within one state. [required]
Options:
--source <str>: Where you got the file, such as its web address.--read-on DATE: The date you downloaded it, such as 2026-10-08.--help: Show this message and exit.
faxbot savings predict¶
Show what a fax to a number would take and cost on each of your sending routes, before sending it. All figures are estimates; nothing is sent.
Usage:
$ faxbot savings predict [OPTIONS]
Options:
--to <str>: Fax number to price, for example +12025550123. [required]--pages <int range>: Pages in the fax. [default: 1; 1<=x<=1000]--layout <str>: normal, or dense for pages packed with more text. [default: normal]--resolution <str>: standard, fine, superfine, 300 or 400. [default: fine]--file <file>: Price this document (PDF or plain text) instead: Faxbot measures each fax coding on its own pages. --pages, --layout and --resolution then come from the document.--engine ENGINE: With --file: the fax engine you would choose for the fax (as faxbot send --engine): auto, builtin or hylafax. A call over your SIP trunk is then measured as that engine sends it. [default: auto]--help: Show this message and exit.
faxbot savings analysis¶
Read the saved analysis, its freshness and the next refresh time.
Usage:
$ faxbot savings analysis [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities¶
Ways to pay less, from what your faxes and calls actually cost. Run it alone for every section.
Usage:
$ faxbot savings opportunities [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
sending: Show numbers where another route cost less...receiving: Show which numbers could share incoming...plans: Show whether each monthly plan is worth...fax-marker: Compare calls marked as fax with calls not...billing-steps: Show numbers whose calls end just past a...partners: Show the numbers whose faxes cost the most...service-numbers: Show quiet numbers at your carrier and at...toll-free: Show recipients with a toll-free fax...carriers: Show what your last 30 days of faxing...shading: Show how much time the fax-friendly...trunks: Compare your trunks' monthly fees, busiest...numbers: Show where each of your fax numbers costs...sites: Show whether your carriers price US calls...channels: Show how many calls your fax systems...import-calls: Import another fax server's or phone system's call records for one system.renewal: One page for a fax server's renewal; record it with --system.import-routing: Import a fax server's number-to-user routing (number, user, email, cover sheet).pots: Take the fax lines out of a POTS-replacement order: the counter-quote.
faxbot savings opportunities sending¶
Show numbers where another route cost less per delivered fax in the last 30 days.
Usage:
$ faxbot savings opportunities sending [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities receiving¶
Show which numbers could share incoming lines, numbers with few calls, and your fax services' monthly fees.
Usage:
$ faxbot savings opportunities receiving [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities plans¶
Show whether each monthly plan is worth its fee at your traffic.
Usage:
$ faxbot savings opportunities plans [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities fax-marker¶
Compare calls marked as fax with calls not marked: delivery, fax over IP (T.38), time and cost. Changes no setting.
Usage:
$ faxbot savings opportunities fax-marker [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities billing-steps¶
Show numbers whose calls end just past a billed minute, where one page less or a faster mode would have cost less.
Usage:
$ faxbot savings opportunities billing-steps [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities partners¶
Show the numbers whose faxes cost the most again and again: candidates to enroll as direct partners.
Usage:
$ faxbot savings opportunities partners [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities service-numbers¶
Show quiet numbers at your carrier and at HumbleFax and eFax, with what each costs to keep.
Usage:
$ faxbot savings opportunities service-numbers [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities toll-free¶
Show recipients with a toll-free fax number on file and whether their approval is recorded.
Usage:
$ faxbot savings opportunities toll-free [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities carriers¶
Show what your last 30 days of faxing would have cost at each carrier's published prices. Advice only: switching carriers means moving your numbers, and Faxbot never switches anything.
Usage:
$ faxbot savings opportunities carriers [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities shading¶
Show how much time the fax-friendly shading pattern would save on your recent faxes, while the setting is Never.
Usage:
$ faxbot savings opportunities shading [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities trunks¶
Compare your trunks' monthly fees, busiest times and cost per fax, and show when one trunk's faxes fit on another and what that would save. Advice only.
Usage:
$ faxbot savings opportunities trunks [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities numbers¶
Show where each of your fax numbers costs least to receive on, and the steps to move one. Advice only: Faxbot never moves a number.
Usage:
$ faxbot savings opportunities numbers [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities sites¶
Show whether your carriers price US calls by state, and when another site's trunk would send faxes to a state for less. Advice only.
Usage:
$ faxbot savings opportunities sites [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings opportunities channels¶
Show how many calls your fax systems carried at once: at their peak, in 99 hours out of 100, and by hour of the day, with the licensed channels never needed.
Usage:
$ faxbot savings opportunities channels [OPTIONS]
Options:
--remove IMPORT: Leave one imported file out of the report, by the import code shown beside it; its calls stay as history.--help: Show this message and exit.
faxbot savings opportunities import-calls¶
Import call records for one system. Formats: Asterisk's Master.csv, Cisco Unified CM CDR files, RightFax's DocTransport audit log (level 3 or 4), GFI FaxMaker's activity export, or a CSV with the columns start, end or duration, direction, channel and number.
Usage:
$ faxbot savings opportunities import-calls [OPTIONS] {FILE}
Arguments:
FILE: The call records file. [required]
Options:
--system NAME: The system they come from, such as "RightFax at HQ". [required]--format asterisk|cucm|rightfax|faxmaker|csv: The file's format; Faxbot recognises it when left out.--licensed CHANNELS: The channels the system is licensed for. [1<=x<=10000]--time-zone ZONE: The time zone of the times in the file, such as America/Denver; the installation's when left out.--numbers NUMBERS: Only calls to or from these numbers (comma-separated), for a phone system's records that include voice calls.--help: Show this message and exit.
faxbot savings opportunities renewal¶
Show one page per fax server renewal: the amount and date, the channels it really needed, what Faxbot handled beside it, and the numbers still to move. With --system, --renews and --amount, record the renewal.
Usage:
$ faxbot savings opportunities renewal [OPTIONS]
Options:
--system NAME: The fax server, such as "RightFax at HQ".--renews DATE: The renewal date, such as 2027-05-31.--amount AMOUNT: The renewal amount, such as 26756.71.--currency CODE: The amount's currency. [default: USD]--product NAME: The product, such as RightFax 22.2.--channels CHANNELS: The channels the renewal licenses. [1<=x<=10000]--source-url URL: Where the amount comes from, such as the quote.--parallel NUMBERS: The numbers Faxbot runs beside it (comma-separated).--parallel-since DATE: When the parallel run began.--remove: Withdraw the system's renewal.--per-channel AMOUNT: The price of one channel on the quote, such as 387.48: the channels the peak never needed are valued at it instead of the renewal's average. Used for this page only.--help: Show this message and exit.
faxbot savings opportunities import-routing¶
Import a fax server's number-to-user routing, so the renewal page lists the numbers and users still to move. It replaces the system's earlier routing, which is kept as history.
Usage:
$ faxbot savings opportunities import-routing [OPTIONS] {FILE}
Arguments:
FILE: A CSV with the columns number, user, email and cover sheet. [required]
Options:
--system NAME: The fax server it comes from. [required]--help: Show this message and exit.
faxbot savings opportunities pots¶
Show, for each POTS-replacement quote you entered, what taking the fax lines out of the order removes from it, what one shared trunk costs for them instead, and which lines must stay. With --name and --per-line (or --published), record a quote.
Usage:
$ faxbot savings opportunities pots [OPTIONS]
Options:
--name PRODUCT: The product quoted, such as Ooma AirDial.--per-line AMOUNT: Its price per line a month, such as 39.95.--currency CODE: The price's currency. [default: USD]--term MONTHS: The term in months. [1<=x<=120]--lines LINES: The lines the quote covers; your whole inventory when left out. [1<=x<=100000]--ports PORTS: The analog ports on one device. [1<=x<=64]--device-price AMOUNT: The one-time price of one device, if the quote has one.--source-url URL: Where the price comes from.--source-date DATE: The quote's date.--published ID: Start from a published price Faxbot ships, such as ooma-airdial.--remove: Withdraw the product's quote.--help: Show this message and exit.
faxbot savings capabilities¶
Everything Faxbot can do to make your faxes cost less and take less time, grouped by what it helps with: whether each is on, works here and is proven, and what it still needs. Run it alone to list them.
Usage:
$ faxbot savings capabilities [OPTIONS] COMMAND [ARGS]...
Options:
--filter on|off|ready|needs|experimental: Only the capabilities that are on, off, ready to turn on, need something, or are experimental.--help: Show this message and exit.
Commands:
show: Show one capability: what it does, an...
faxbot savings capabilities show¶
Show one capability: what it does, an example, whether it works here, what it needs and where to change it.
Usage:
$ faxbot savings capabilities show [OPTIONS] {KEY}
Arguments:
KEY: The capability, as listed in brackets by faxbot savings capabilities. [required]
Options:
--help: Show this message and exit.
faxbot savings charges¶
What each provider charged: how Faxbot reads it, received fax charges, and faxes a provider billed that Faxbot has no record of. Run it alone to show them.
Usage:
$ faxbot savings charges [OPTIONS] COMMAND [ARGS]...
Options:
--days <int range>: How many days back to show. [default: 30; 1<=x<=366]--help: Show this message and exit.
Commands:
sweep: List each account's faxes at its provider...
faxbot savings charges sweep¶
List each account's faxes at its provider now and show any Faxbot has no record of. This never sends, fetches or changes a fax.
Usage:
$ faxbot savings charges sweep [OPTIONS]
Options:
--account KEY: One account's key, from 'faxbot delivery providers accounts list'. Default: every account whose provider lists its faxes.--days <int range>: How many days back to list. [default: 7; 1<=x<=31]--help: Show this message and exit.
faxbot savings invoices¶
Your providers' monthly invoices, and the part your faxes don't explain.
Usage:
$ faxbot savings invoices [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the invoices you entered, each with...show: Show one invoice: what your faxes explain,...add: Enter an invoice total for one account and...
faxbot savings invoices list¶
List the invoices you entered, each with the part your faxes don't explain, and what to do when that recurs.
Usage:
$ faxbot savings invoices list [OPTIONS]
Options:
--account KEY: Only this account.--help: Show this message and exit.
faxbot savings invoices show¶
Show one invoice: what your faxes explain, what they don't, and each version entered.
Usage:
$ faxbot savings invoices show [OPTIONS] {invoice_id}
Arguments:
invoice_id: Invoice ID, from 'faxbot savings invoices list'. [required]
Options:
--save-file PATH: Save the invoice file entered with it to this path.--help: Show this message and exit.
faxbot savings invoices add¶
Enter an invoice total for one account and month. Entering the same month again adds a corrected version and keeps the earlier one.
Usage:
$ faxbot savings invoices add [OPTIONS]
Options:
--account KEY: The account the invoice is for, from 'faxbot delivery providers accounts list', such as humblefax. [required]--total AMOUNT: The invoice total, such as 13.20. [required]--month YYYY-MM: The month the invoice covers, such as 2026-09. Faxbot starts it on the plan's billing day.--from YYYY-MM-DD: Instead of --month: the first day the invoice covers.--to YYYY-MM-DD: With --from: the last day the invoice covers.--currency CODE: The three-letter currency code. [default: USD]--note TEXT: A short note, such as the invoice number.--file PATH: The invoice itself: a PDF, PNG, JPEG or CSV file.--help: Show this message and exit.
faxbot savings plans¶
Your plans: each plan's budget or allowance this month and what is committed (show), which waiting faxes get its last pages (allocation), setting a budget (budget), and the plans a fax service publishes (published, or name the service: faxbot savings plans efax).
Usage:
$ faxbot savings plans [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
published: Show the price plans a fax service...show: Show each plan's normal-use budget or...allocation: Show who gets each limited plan's last...budget: Set a plan's monthly normal-use budget,...
faxbot savings plans published¶
Show the price plans a fax service advertises, with where Faxbot found them and when.
Usage:
$ faxbot savings plans published [OPTIONS] [provider]
Arguments:
provider: The fax service, for example efax.
Options:
--in-use: Plans for every sending provider that has no rate card yet.--help: Show this message and exit.
faxbot savings plans show¶
Show each plan's normal-use budget or allowance this billing period, what is committed, and faxes between your own accounts. Every figure is an estimate.
Usage:
$ faxbot savings plans show [OPTIONS]
Options:
--by-day: Also show the pages and faxes carried each day of this billing period.--help: Show this message and exit.
faxbot savings plans allocation¶
Show who gets each limited plan's last pages or minutes: the waiting faxes they save the most on, and what Faxbot keeps for faxes not sent yet. Every amount is an estimate.
Usage:
$ faxbot savings plans allocation [OPTIONS]
Options:
--help: Show this message and exit.
faxbot savings plans budget¶
Set a plan's monthly normal-use budget, allowance or commitment, and the day its counts start again. Faxbot never changes the plan itself.
Usage:
$ faxbot savings plans budget [OPTIONS] {plan}
Arguments:
plan: The plan, for example humblefax or efax; the carrier trunk is sip. [required]
Options:
--pages COUNT: Normal-use pages a month, or none for no limit.--faxes COUNT: Normal-use faxes a month, or none for no limit.--billing-day <int range>: The day of the month the plan's counts start again. [1<=x<=31]--included-pages COUNT: Pages the plan includes each month, or none.--page-overage PRICE: The price of each page past them, such as 0.10.--included-minutes COUNT: Minutes the plan includes each month, or none.--commitment AMOUNT: A monthly amount you have committed to spend, such as 50.--default: Go back to Faxbot's starting budget for this plan.--help: Show this message and exit.
faxbot faxes¶
Faxes received, sent and expected, forms to fill in and send, and case packets.
Usage:
$ faxbot faxes [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
received: Received faxes: list and open them, give...sent: Sent faxes: list them, open one, download...expected: Expected faxes: record a fax before it...forms: Registered forms: import a fillable PDF or...cases: Case packets: when you fax documents for a...
faxbot faxes received¶
Received faxes: list and open them, give each one an owner, and see where they were delivered.
Usage:
$ faxbot faxes received [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List received faxes you can see.show: Show one received fax.pdf: Download the document of a received fax.decoded: Download the original document a received...fetch: Ask Faxbot to fetch a received fax's...recover: Bring in received faxes that reached the...import: Import a PDF from another system as if it...owners: List received faxes with their owner and...history: Show who has owned a received fax and...counts: Count the received faxes you can see in...assign: Give a received fax to an owner.acknowledge: Acknowledge a received fax you own.done: Mark a received fax done, with a short note.reopen: Reopen a received fax marked done.export: Download a received fax's record as a zip...block: Mark a received fax's sender as junk:...who-called: Show what the network asserted about who...deliveries: Delivery of received faxes to email and...
faxbot faxes received list¶
List received faxes you can see.
Usage:
$ faxbot faxes received list [OPTIONS]
Options:
--to <str>: Only faxes sent to this number.--status <str>: Only faxes with this status: waiting, received or failed.--mailbox <str>: Only faxes in this mailbox.--ids: Also show each received fax's ID, to use with faxbot faxes received show and pdf.--help: Show this message and exit.
faxbot faxes received show¶
Show one received fax.
Usage:
$ faxbot faxes received show [OPTIONS] {inbound_id}
Arguments:
inbound_id: A received fax's ID, from 'faxbot faxes received list --ids' or 'faxbot faxes received owners --ids'. [required]
Options:
--help: Show this message and exit.
faxbot faxes received pdf¶
Download the document of a received fax.
Usage:
$ faxbot faxes received pdf [OPTIONS] {inbound_id}
Arguments:
inbound_id: A received fax's ID, from 'faxbot faxes received list --ids' or 'faxbot faxes received owners --ids'. [required]
Options:
-o, --output <str>: File to write. Use '-' for standard output.--force: Replace the file if it exists.--help: Show this message and exit.
faxbot faxes received decoded¶
Download the original document a received fax carried as encoded pages (experimental).
Usage:
$ faxbot faxes received decoded [OPTIONS] {inbound_id}
Arguments:
inbound_id: A received fax's ID, from 'faxbot faxes received list --ids'. [required]
Options:
-o, --output <str>: File to write. Use '-' for standard output.--force: Replace the file if it exists.--help: Show this message and exit.
faxbot faxes received fetch¶
Ask Faxbot to fetch a received fax's document again now.
Usage:
$ faxbot faxes received fetch [OPTIONS] {inbound_id}
Arguments:
inbound_id: A received fax's ID, from 'faxbot faxes received list --ids' or 'faxbot faxes received owners --ids'. [required]
Options:
--help: Show this message and exit.
faxbot faxes received recover¶
Bring in received faxes that reached the phone line but were not handed to Faxbot. Faxbot also does this every minute.
Usage:
$ faxbot faxes received recover [OPTIONS]
Options:
--help: Show this message and exit.
faxbot faxes received import¶
Import a PDF from another system as if it were a received fax.
Usage:
$ faxbot faxes received import [OPTIONS] {file}
Arguments:
file: The PDF to import. [required]
Options:
--source <str>: Name of the source system, for example case-system. [required]--id <str>: The document's ID in that system. Importing the same ID again does not create a second document. [required]--revision <str>: A new version of a document already imported under this ID.--received-at <str>: When that system received it, for example 2026-10-03T14:05:00Z.--to <str>: The fax number it was sent to; decides the mailbox.--from <str>: The fax number it came from.--pages <int range>: Page count, as the source system reported it. [x>=1]--help: Show this message and exit.
faxbot faxes received owners¶
List received faxes with their owner and state: open ones first, soonest target first.
Usage:
$ faxbot faxes received owners [OPTIONS]
Options:
--mine: Only items you own that are not done.--unassigned: Only open items without an owner.--overdue: Only open items past their target.--mailbox <str>: Only items in this mailbox.--limit <int range>: How many items to show. [default: 100; 1<=x<=200]--ids: Also show item IDs, for assign, acknowledge, done, reopen, history and export.--help: Show this message and exit.
faxbot faxes received history¶
Show who has owned a received fax and everything that happened to it.
Usage:
$ faxbot faxes received history [OPTIONS] {item_id}
Arguments:
item_id: A received fax's ID, from 'faxbot faxes received list --ids' or 'faxbot faxes received owners --ids'. [required]
Options:
--help: Show this message and exit.
faxbot faxes received counts¶
Count the received faxes you can see in each state, such as waiting for an owner or overdue.
Usage:
$ faxbot faxes received counts [OPTIONS]
Options:
--help: Show this message and exit.
faxbot faxes received assign¶
Give a received fax to an owner. They must already be able to see it.
Usage:
$ faxbot faxes received assign [OPTIONS] {item_id} {user}
Arguments:
item_id: A received fax's ID, from 'faxbot faxes received list --ids' or 'faxbot faxes received owners --ids'. [required]user: The new owner: their login or name. [required]
Options:
--help: Show this message and exit.
faxbot faxes received acknowledge¶
Acknowledge a received fax you own.
Usage:
$ faxbot faxes received acknowledge [OPTIONS] {item_id}
Arguments:
item_id: A received fax's ID, from 'faxbot faxes received list --ids' or 'faxbot faxes received owners --ids'. [required]
Options:
--help: Show this message and exit.
faxbot faxes received done¶
Mark a received fax done, with a short note.
Usage:
$ faxbot faxes received done [OPTIONS] {item_id}
Arguments:
item_id: A received fax's ID, from 'faxbot faxes received list --ids' or 'faxbot faxes received owners --ids'. [required]
Options:
--note <str>: What was done, up to 200 characters. [required]--help: Show this message and exit.
faxbot faxes received reopen¶
Reopen a received fax marked done. Its owner acknowledges it again.
Usage:
$ faxbot faxes received reopen [OPTIONS] {item_id}
Arguments:
item_id: A received fax's ID, from 'faxbot faxes received list --ids' or 'faxbot faxes received owners --ids'. [required]
Options:
--help: Show this message and exit.
faxbot faxes received export¶
Download a received fax's record as a zip file: its history and, if you may read documents, the fax itself.
Usage:
$ faxbot faxes received export [OPTIONS] {item_id}
Arguments:
item_id: A received fax's ID, from 'faxbot faxes received list --ids' or 'faxbot faxes received owners --ids'. [required]
Options:
-o, --output <str>: Zip file to write. Use '-' for standard output.--force: Replace the file if it exists.--help: Show this message and exit.
faxbot faxes received block¶
Mark a received fax's sender as junk: their calls are turned away before Faxbot answers.
Usage:
$ faxbot faxes received block [OPTIONS] {inbound_id}
Arguments:
inbound_id: The received fax, by its ID. [required]
Options:
--reason <str>: Why this sender is junk, in a few words. [required]--days <int range>: How many days to block the sender (90 unless you say). [default: 90; 1<=x<=365]--help: Show this message and exit.
faxbot faxes received who-called¶
Show what the network asserted about who called for one received fax.
Usage:
$ faxbot faxes received who-called [OPTIONS] {fax_id}
Arguments:
fax_id: Received fax ID. [required]
Options:
--help: Show this message and exit.
faxbot faxes received deliveries¶
Delivery of received faxes to email and other places, and any that failed.
Usage:
$ faxbot faxes received deliveries [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List received documents and their...retry: Try delivering a received document again.
faxbot faxes received deliveries list¶
List received documents and their delivery, newest first.
Usage:
$ faxbot faxes received deliveries list [OPTIONS]
Options:
--state <str>: received, sending, delivered or failed.--limit <int range>: How many to show. [default: 100; 1<=x<=500]--ids: Also show each delivery's ID, to use with faxbot faxes received deliveries retry.--help: Show this message and exit.
faxbot faxes received deliveries retry¶
Try delivering a received document again.
Usage:
$ faxbot faxes received deliveries retry [OPTIONS] {item_id}
Arguments:
item_id: Item ID from 'faxbot faxes received deliveries list --ids'. [required]
Options:
--help: Show this message and exit.
faxbot faxes sent¶
Sent faxes: list them, open one, download what was sent and follow its delivery.
Usage:
$ faxbot faxes sent [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List sent faxes, newest first, with what...show: Show one sent fax.pdf: Download the document of a sent fax.refresh: Ask the provider for the latest status of...evidence: Show the evidence of a sent fax's...confirm-receipt: Confirm receipt of a fax whose delivery is...send-now: Send a waiting fax now; the faxes waiting...route: Why a sent fax took its route: the rule...approve: Approve a fax your rules held for...refuse: Refuse a held fax.check-again: Look again for a route your rules allow...uncertain: List sent faxes whose outcome Faxbot could...probe: Show what Faxbot found out about a sent...settle: Settle what happened to a sent fax Faxbot...assign: Give a sent fax Faxbot is unsure of to the...uncertain-settings: Show or change how soon uncertain sent...continue: Show which pages of a broken fax are left...sender-evidence: The sender's evidence for a fax to a...
faxbot faxes sent list¶
List sent faxes, newest first, with what each cost. Fax numbers are partly hidden.
Usage:
$ faxbot faxes sent list [OPTIONS]
Options:
--status <str>: Only faxes with this status, such as queued, SUCCESS or FAILED.--provider <str>: Only faxes sent through this provider.--limit <int range>: How many faxes to show. [default: 50; 1<=x<=100]--offset <int range>: Skip this many of the newest faxes. [default: 0; x>=0]--ids: Also show each fax's ID, to use with faxbot faxes sent show, pdf and refresh.--held: Only faxes your rules are holding: waiting for approval, for a time window or for a route the rules allow.--hours <int range>: Show only faxes whose state changed within this many hours, such as 24. [1<=x<=8784]--help: Show this message and exit.
faxbot faxes sent show¶
Show one sent fax.
Usage:
$ faxbot faxes sent show [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID. [required]
Options:
--help: Show this message and exit.
faxbot faxes sent pdf¶
Download the document of a sent fax.
Usage:
$ faxbot faxes sent pdf [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID. [required]
Options:
-o, --output <str>: File to write. Use '-' for standard output.--force: Replace the file if it exists.--help: Show this message and exit.
faxbot faxes sent refresh¶
Ask the provider for the latest status of a sent fax. This never sends it again.
Usage:
$ faxbot faxes sent refresh [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID. [required]
Options:
--help: Show this message and exit.
faxbot faxes sent evidence¶
Show the evidence of a sent fax's delivery: each step and what the fax service reported.
Usage:
$ faxbot faxes sent evidence [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID, from 'faxbot faxes sent list --ids'. [required]
Options:
--help: Show this message and exit.
faxbot faxes sent confirm-receipt¶
Confirm receipt of a fax whose delivery is uncertain, by recording the ID the fax service gave it. This never sends it again.
Usage:
$ faxbot faxes sent confirm-receipt [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID, from 'faxbot faxes sent list --ids'. [required]
Options:
--provider-fax-id <str>: The fax's ID in the provider account that accepted it. [required]--confirm-original-account: Confirm you found this ID in the same provider account that accepted the fax.--help: Show this message and exit.
faxbot faxes sent send-now¶
Send a waiting fax now; the faxes waiting with it go in the same call.
Usage:
$ faxbot faxes sent send-now [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID of a fax waiting to go with others. [required]
Options:
--help: Show this message and exit.
faxbot faxes sent route¶
Why a sent fax took its route: the rule that chose it, and what happened on each attempt.
Usage:
$ faxbot faxes sent route [OPTIONS] {FAX_ID}
Arguments:
FAX_ID: The fax id, from faxbot faxes sent list. [required]
Options:
--help: Show this message and exit.
faxbot faxes sent approve¶
Approve a fax your rules held for approval, or send a fax with no allowed route by an account anyway.
Usage:
$ faxbot faxes sent approve [OPTIONS] {FAX_ID}
Arguments:
FAX_ID: The held fax, from faxbot faxes sent list --held. [required]
Options:
--account KEY: For a fax no route your rules allow: send it by this account anyway. Faxbot offers only accounts left out by a cost cap or by being down or busy.--help: Show this message and exit.
faxbot faxes sent refuse¶
Refuse a held fax. Nothing is sent, and the fax is marked failed with your reason.
Usage:
$ faxbot faxes sent refuse [OPTIONS] {FAX_ID}
Arguments:
FAX_ID: The held fax, from faxbot faxes sent list --held. [required]
Options:
--reason <str>: Why, for the sender and the history, such as "wrong recipient". [required]--help: Show this message and exit.
faxbot faxes sent check-again¶
Look again for a route your rules allow for a held fax, for when an account may be back.
Usage:
$ faxbot faxes sent check-again [OPTIONS] {FAX_ID}
Arguments:
FAX_ID: The held fax, from faxbot faxes sent list --held. [required]
Options:
--help: Show this message and exit.
faxbot faxes sent uncertain¶
List sent faxes whose outcome Faxbot could not confirm, with their owner and the time to settle each.
Usage:
$ faxbot faxes sent uncertain [OPTIONS]
Options:
--mine: Only faxes you own.--unassigned: Only faxes nobody owns yet.--overdue: Only faxes past the time to settle them.--settled: Faxes already settled, instead of open ones.--limit <int range>: How many faxes to show. [default: 100; 1<=x<=200]--ids: Also show each fax ID, for probe, settle and assign.--help: Show this message and exit.
faxbot faxes sent probe¶
Show what Faxbot found out about a sent fax it is unsure of: the checks, cheapest first, and what each means.
Usage:
$ faxbot faxes sent probe [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID of the sent fax, from 'faxbot faxes sent uncertain --ids' or 'faxbot faxes sent list --ids'. [required]
Options:
--history: Also show everything that happened.--query-pdf FILE: Save the one-page receipt query to check it before sending. Use '-' for standard output.--send-query: Fax the one-page receipt query to the recipient now.--force: With --query-pdf: replace the file.--help: Show this message and exit.
faxbot faxes sent settle¶
Settle what happened to a sent fax Faxbot was unsure of. Faxbot records who decided and why.
Usage:
$ faxbot faxes sent settle [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID of the sent fax, from 'faxbot faxes sent uncertain --ids' or 'faxbot faxes sent list --ids'. [required]
Options:
--delivered: It arrived.--not-delivered: It did not arrive.--cant-tell: You cannot find out.--reason <str>: How you know, for example who you spoke to (up to 400 characters). [required]--send-again: With --not-delivered: send the same document again now, as a new fax linked to this one.--help: Show this message and exit.
faxbot faxes sent assign¶
Give a sent fax Faxbot is unsure of to the person who will settle it. They must already be able to see it.
Usage:
$ faxbot faxes sent assign [OPTIONS] {fax_id} {user}
Arguments:
fax_id: Fax ID of the sent fax, from 'faxbot faxes sent uncertain --ids' or 'faxbot faxes sent list --ids'. [required]user: The new owner: their login or name. [required]
Options:
--help: Show this message and exit.
faxbot faxes sent uncertain-settings¶
Show or change how soon uncertain sent faxes should be settled, and who settles them when the sender cannot.
Usage:
$ faxbot faxes sent uncertain-settings [OPTIONS]
Options:
--hours <int range>: Hours to settle an uncertain fax, from when Faxbot finds it (0 for no deadline). [0<=x<=720]--fallback <str>: The person who settles uncertain faxes when the sender cannot: their login or name.--no-fallback: Remove the fallback person.--help: Show this message and exit.
faxbot faxes sent continue¶
Show which pages of a broken fax are left to send and what they cost; send only those with --send.
Usage:
$ faxbot faxes sent continue [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID of the sent fax whose call broke part way, from 'faxbot faxes sent list --ids'. [required]
Options:
--send: Send the remaining pages now, as a new fax linked to this one.--reason <str>: How you know the rest did not arrive (up to 400 characters). Needed when the fax is waiting to be settled.--help: Show this message and exit.
faxbot faxes sent sender-evidence¶
The sender's evidence for a fax to a registered-sender recipient: the identity registered then, the kept pages, each call with the station that answered, and any request for the original.
Usage:
$ faxbot faxes sent sender-evidence [OPTIONS] {FAX_ID}
Arguments:
FAX_ID: The sent fax. [required]
Options:
--original requested|sent|cancelled: Record that the recipient asked for the original, that you sent it, or that the request was withdrawn.--note TEXT: What happened, for the history.--help: Show this message and exit.
faxbot faxes expected¶
Expected faxes: record a fax before it arrives, see what is missing or overdue, confirm proposed matches, import open work from another system, and reconcile after that system was down.
Usage:
$ faxbot faxes expected [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List expected faxes, the ones waiting...show: Show one expected fax, any received faxes...add: Expect a fax: record what should arrive,...confirm: Confirm that a proposed received fax is...reject: Say a proposed received fax is not the one...match: Link a received fax to an expected fax by...cancel: Cancel an expected fax that is no longer...done-elsewhere: Record that an expected fax was completed...conflict: Decide about an expected fax the import...report: What is still missing, what is overdue,...export: Download an expected fax's evidence as a...import: Import open work from another system as...imports: List recent imports of expected faxes,...sources: Saved import sources: the file format and...outage: Outage mode: mark a source system down,...
faxbot faxes expected list¶
List expected faxes, the ones waiting first, with their state and due time.
Usage:
$ faxbot faxes expected list [OPTIONS]
Options:
--show WHICH: overdue, proposed (waiting for you to confirm), missing (no longer in the latest export), conflicts, closed or all. Default: waiting.--mailbox <str>: Only this mailbox, by name.--search <str>: Only references containing this text.--limit <int range>: How many to show. [default: 100; 1<=x<=500]--help: Show this message and exit.
faxbot faxes expected show¶
Show one expected fax, any received faxes proposed as its answer, and optionally its history.
Usage:
$ faxbot faxes expected show [OPTIONS] {code}
Arguments:
code: The expected fax's code, from 'faxbot faxes expected list'. [required]
Options:
--history: Also show everything that happened.--help: Show this message and exit.
faxbot faxes expected add¶
Expect a fax: record what should arrive, from whom and by when, before it arrives.
Usage:
$ faxbot faxes expected add [OPTIONS] {reference}
Arguments:
reference: The business reference, such as "PO 483". [required]
Options:
--expecting <str>: What should arrive, such as "Signed acknowledgement". [required]--mailbox <str>: The mailbox that owns it, by name. [required]--from-name <str>: Who will send it, such as "Acme Supply".--fax-number <str>: A fax number it may come from. Repeat for more.--due <str>: When it is due, such as 2026-10-12 17:00 (local time).--due-hours <int range>: Due this many hours from now, instead of --due. [1<=x<=8760]--revision <str>: The revision it must be, such as B.--must-include <str>: A part it must include, such as "Signature page". Repeat for more.--subaddress <str>: The subaddress the sender's fax machine sends (a SUB or subaddress field). Default: the reference, when it is digits.--email-subject <str>: Text the email subject will contain, such as "PO 483".--message-id <str>: The Direct or email message ID it will carry, when you know it.--direct-address <str>: The Direct address it may come from.--note <str>: A short description.--help: Show this message and exit.
faxbot faxes expected confirm¶
Confirm that a proposed received fax is the one expected. This closes it.
Usage:
$ faxbot faxes expected confirm [OPTIONS] {code}
Arguments:
code: The expected fax's code, from 'faxbot faxes expected list'. [required]
Options:
--proposal <int range>: Which proposed fax, as numbered in 'faxbot faxes expected show'. [x>=1]--help: Show this message and exit.
faxbot faxes expected reject¶
Say a proposed received fax is not the one expected. The expected fax keeps waiting.
Usage:
$ faxbot faxes expected reject [OPTIONS] {code}
Arguments:
code: The expected fax's code, from 'faxbot faxes expected list'. [required]
Options:
--proposal <int range>: Which proposed fax, as numbered in 'faxbot faxes expected show'. [x>=1]--reason <str>: Why it is not the one (up to 300 characters).--help: Show this message and exit.
faxbot faxes expected match¶
Link a received fax to an expected fax by hand. This closes it.
Usage:
$ faxbot faxes expected match [OPTIONS] {code}
Arguments:
code: The expected fax's code, from 'faxbot faxes expected list'. [required]
Options:
--received-fax <str>: The received fax's ID, from 'faxbot faxes received list --ids'. [required]--note <str>: Why it is the one (up to 300 characters).--help: Show this message and exit.
faxbot faxes expected cancel¶
Cancel an expected fax that is no longer needed.
Usage:
$ faxbot faxes expected cancel [OPTIONS] {code}
Arguments:
code: The expected fax's code, from 'faxbot faxes expected list'. [required]
Options:
--reason <str>: Why it is no longer expected (up to 300 characters). [required]--help: Show this message and exit.
faxbot faxes expected done-elsewhere¶
Record that an expected fax was completed another way, such as by phone or on a portal.
Usage:
$ faxbot faxes expected done-elsewhere [OPTIONS] {code}
Arguments:
code: The expected fax's code, from 'faxbot faxes expected list'. [required]
Options:
--how <str>: How it was completed, such as "Confirmed on the supplier portal" (up to 300 characters). [required]--help: Show this message and exit.
faxbot faxes expected conflict¶
Decide about an expected fax the import changed without marking it as a new version.
Usage:
$ faxbot faxes expected conflict [OPTIONS] {code}
Arguments:
code: The expected fax's code, from 'faxbot faxes expected list'. [required]
Options:
--keep: Keep the first version and set the change aside.--apply: Use the import's changed version.--help: Show this message and exit.
faxbot faxes expected report¶
What is still missing, what is overdue, and which received faxes answered no expected fax.
Usage:
$ faxbot faxes expected report [OPTIONS]
Options:
--days <int range>: How many days back. [default: 30; 1<=x<=365]--help: Show this message and exit.
faxbot faxes expected export¶
Download an expected fax's evidence as a zip file: its history, its match and what is missing.
Usage:
$ faxbot faxes expected export [OPTIONS] {code}
Arguments:
code: The expected fax's code, from 'faxbot faxes expected list'. [required]
Options:
-o, --output <str>: Zip file to write. Use '-' for standard output.--force: Replace the file if it exists.--help: Show this message and exit.
faxbot faxes expected import¶
Import open work from another system as expected faxes. Importing the same file again adds nothing.
Usage:
$ faxbot faxes expected import [OPTIONS] {file}
Arguments:
file: The export file (CSV or JSON, as the source says). [required]
Options:
--source <str>: The saved import source's name, from 'faxbot faxes expected sources list'. [required]--full: The file lists all open work, so anything missing from it is reported.--help: Show this message and exit.
faxbot faxes expected imports¶
List recent imports of expected faxes, newest first, with what each one changed.
Usage:
$ faxbot faxes expected imports [OPTIONS]
Options:
--limit <int range>: How many imports to show. [default: 20; 1<=x<=100]--help: Show this message and exit.
faxbot faxes expected sources¶
Saved import sources: the file format and which column holds each field.
Usage:
$ faxbot faxes expected sources [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List saved import sources and their column...save: Save an import source once: its format and...
faxbot faxes expected sources list¶
List saved import sources and their column mappings.
Usage:
$ faxbot faxes expected sources list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot faxes expected sources save¶
Save an import source once: its format and which column holds each field. Saving again changes it.
Usage:
$ faxbot faxes expected sources save [OPTIONS] {name}
Arguments:
name: A name for the source, such as "Open purchase orders". [required]
Options:
--format <str>: csv or json. [required]--column FIELD=COLUMN: Which column holds a field, such as reference="PO Number". Fields: reference (required), operation_id, revision, kind, description, counterparty, fax_numbers, direct_address, due, mailbox, subaddress, email_subject, message_id, required_parts, required_revision, window_start. [required]--mailbox <str>: The mailbox for rows that name none.--due-hours <int range>: Hours each row has when it gives no due time. [0<=x<=8760]--subject-pattern <str>: How the reference appears in an email subject, such as "PO {reference}".--subaddress-pattern <str>: How the reference appears in the subaddress the sender's fax machine sends, such as "{digits}".--form-field <str>: The partner form field that holds the reference.--revision-field <str>: The partner form field that holds the revision.--help: Show this message and exit.
faxbot faxes expected outage¶
Outage mode: mark a source system down, record what was done by fax or email meanwhile, and sort the next export into done, new and held lists.
Usage:
$ faxbot faxes expected outage [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List declared outages, the newest first.show: Show an outage: what was done during it...start: Mark a source system down.end: Mark a source system back.record: Record one action done during an outage...reconcile: Sort the export imported after the outage...
faxbot faxes expected outage list¶
List declared outages, the newest first.
Usage:
$ faxbot faxes expected outage list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot faxes expected outage show¶
Show an outage: what was done during it and the reconciliation lists.
Usage:
$ faxbot faxes expected outage show [OPTIONS] {code}
Arguments:
code: The outage's code, from 'faxbot faxes expected outage list'. [required]
Options:
--help: Show this message and exit.
faxbot faxes expected outage start¶
Mark a source system down. Record what you do by fax or email meanwhile with 'outage record'.
Usage:
$ faxbot faxes expected outage start [OPTIONS] {source}
Arguments:
source: The import source's name: the system that is down. [required]
Options:
--since <str>: When it went down (local time). Default: now.--note <str>: A short note, such as "ERP maintenance".--help: Show this message and exit.
faxbot faxes expected outage end¶
Mark a source system back. Then import its next export to sort the work into three lists.
Usage:
$ faxbot faxes expected outage end [OPTIONS] {code}
Arguments:
code: The outage's code, from 'faxbot faxes expected outage list'. [required]
Options:
--at <str>: When it came back (local time). Default: now.--help: Show this message and exit.
faxbot faxes expected outage record¶
Record one action done during an outage against the item's original ID. Faxbot never submits it anywhere.
Usage:
$ faxbot faxes expected outage record [OPTIONS] {code}
Arguments:
code: The outage's code, from 'faxbot faxes expected outage list'. [required]
Options:
--id <str>: The item's original ID in the source system. [required]--did <str>: What was done, such as "Order faxed to Acme". [required]--by <str>: fax, email, phone or other. [required]--revision <str>: The item's revision, when it has one.--reference <str>: The business reference, such as "PO 483".--uncertain: It may not have gone through.--sent-fax <str>: The sent fax's ID, from 'faxbot faxes sent list --ids'.--evidence <str>: Where the evidence is, such as "Fax log page 3".--at <str>: When it was done (local time). Default: now.--help: Show this message and exit.
faxbot faxes expected outage reconcile¶
Sort the export imported after the outage into done, new and held lists again. Nothing is sent or submitted.
Usage:
$ faxbot faxes expected outage reconcile [OPTIONS] {code}
Arguments:
code: The outage's code, from 'faxbot faxes expected outage list'. [required]
Options:
--help: Show this message and exit.
faxbot faxes forms¶
Registered forms: import a fillable PDF or a template, fill it in, preview it and send it. A partner running Faxbot gets only the filled-in values and draws identical pages itself.
Usage:
$ faxbot faxes forms [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List your registered forms and their...import: Import a form from a fillable PDF, or from...show: Show a form version's fields: their names,...render: Fill in a form and save the pages exactly...send: Fill in a form and send it: to a partner...sent: List forms you sent, with what happened to...preview: Save a page of the blank form, as it is...original: Download the file a form version was...fax: Send the pages of a form that did not...received: List forms partners sent whose pages...partner: Ask a partner which forms it holds.
faxbot faxes forms list¶
List your registered forms and their versions.
Usage:
$ faxbot faxes forms list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot faxes forms import¶
Import a form from a fillable PDF, or from a template and a field-position file.
Usage:
$ faxbot faxes forms import [OPTIONS] {file}
Arguments:
file: A fillable PDF, or a PDF or SVG template. [required]
Options:
--name <str>: The name for a new form.--form <str>: Add this as the next version of an existing form (name). Earlier versions never change.--positions <file>: A field-position file (JSON) placing each field on a template that has no fillable fields.--help: Show this message and exit.
faxbot faxes forms show¶
Show a form version's fields: their names, types and choices.
Usage:
$ faxbot faxes forms show [OPTIONS] {form}
Arguments:
form: Form name. [required]
Options:
--version <int range>: The version to use. Default: the newest. [x>=1]--help: Show this message and exit.
faxbot faxes forms render¶
Fill in a form and save the pages exactly as they would be faxed, without sending anything.
Usage:
$ faxbot faxes forms render [OPTIONS] {form}
Arguments:
form: Form name. [required]
Options:
--version <int range>: The version to use. Default: the newest. [x>=1]-v, --value NAME=VALUE: A field value, for example --value patient="Ann Example". Dates are year-month-day, checkboxes yes or no. Repeat for each field.--values <file>: A JSON file of field names and values.--signature NAME=PICTURE: A signature field and its picture (PNG, JPEG or GIF), for example --signature signed=signature.png.-o, --output <str>: File to write. Use '-' for standard output.--png: Save the first page as a PNG picture instead of a PDF.--force: Replace the file if it exists.--help: Show this message and exit.
faxbot faxes forms send¶
Fill in a form and send it: to a partner as the filled-in values, to anyone else as a fax.
Usage:
$ faxbot faxes forms send [OPTIONS] {form} {to}
Arguments:
form: Form name. [required]to: Fax number. [required]
Options:
--version <int range>: The version to use. Default: the newest. [x>=1]-v, --value NAME=VALUE: A field value, for example --value patient="Ann Example". Dates are year-month-day, checkboxes yes or no. Repeat for each field.--values <file>: A JSON file of field names and values.--signature NAME=PICTURE: A signature field and its picture (PNG, JPEG or GIF), for example --signature signed=signature.png.--as-fax: Send the pages as a fax even when the number belongs to a partner.--help: Show this message and exit.
faxbot faxes forms sent¶
List forms you sent, with what happened to each; with an ID, show one with its values.
Usage:
$ faxbot faxes forms sent [OPTIONS] [delivery]
Arguments:
delivery: One ID from the list, to show the values that were sent.
Options:
--help: Show this message and exit.
faxbot faxes forms preview¶
Save a page of the blank form, as it is faxed, as a PNG picture.
Usage:
$ faxbot faxes forms preview [OPTIONS] {form}
Arguments:
form: Form name. [required]
Options:
--version <int range>: The version to use. Default: the newest. [x>=1]--page <int range>: Which page. [default: 1; x>=1]--fields: Outline each field's box.-o, --output <str>: File to write. Use '-' for standard output.--force: Replace the file if it exists.--help: Show this message and exit.
faxbot faxes forms original¶
Download the file a form version was imported from.
Usage:
$ faxbot faxes forms original [OPTIONS] {form}
Arguments:
form: Form name. [required]
Options:
--version <int range>: The version to use. Default: the newest. [x>=1]-o, --output <str>: File to write. Use '-' for standard output.--force: Replace the file if it exists.--help: Show this message and exit.
faxbot faxes forms fax¶
Send the pages of a form that did not reach the partner as an ordinary fax. Faxbot never does this by itself.
Usage:
$ faxbot faxes forms fax [OPTIONS] {delivery}
Arguments:
delivery: The ID from 'faxbot faxes forms sent'. [required]
Options:
--help: Show this message and exit.
faxbot faxes forms received¶
List forms partners sent whose pages matched, with the values filled in.
Usage:
$ faxbot faxes forms received [OPTIONS]
Options:
--help: Show this message and exit.
faxbot faxes forms partner¶
Ask a partner which forms it holds. A form it lacks is fetched from you the first time you send it.
Usage:
$ faxbot faxes forms partner [OPTIONS] {partner}
Arguments:
partner: Partner organization, fax number or id. [required]
Options:
--help: Show this message and exit.
faxbot faxes cases¶
Case packets: when you fax documents for a case, leave out the ones the recipient already has.
Usage:
$ faxbot faxes cases [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the newest cases you sent packets...documents: List the documents of a case sent to a...send: Send a case packet, listing documents the...accept: Record that the recipient confirmed it has...invalidate: The recipient could not find these...repair: Send every document of the case to this...reuse: Show or set how long this recipient's...originals: List the case's original documents, kept...add: Keep documents in a case without sending...suggestions: Turn on or off suggestions of documents...build: Build a packet from a checklist with the...checklist: A recipient's checklist of documents:...
faxbot faxes cases list¶
List the newest cases you sent packets for: who received them, what was delivered and acknowledged, and when.
Usage:
$ faxbot faxes cases list [OPTIONS]
Options:
--limit <int range>: How many cases to show. [default: 50; 1<=x<=200]--help: Show this message and exit.
faxbot faxes cases documents¶
List the documents of a case sent to a recipient: delivered, acknowledged, too old, or not found by them.
Usage:
$ faxbot faxes cases documents [OPTIONS] {case_id}
Arguments:
case_id: Your case reference. [required]
Options:
--to <str>: Recipient fax number. [required]--ids: Also show the fax ID each document was last sent in.--help: Show this message and exit.
faxbot faxes cases send¶
Send a case packet, listing documents the recipient acknowledged instead of sending them again.
Usage:
$ faxbot faxes cases send [OPTIONS] {case_id} {to} {files}...
Arguments:
case_id: Your case reference. [required]to: Recipient fax number. [required]files...: PDF documents for the packet, in order. [required]
Options:
--title <str>: Title for each document, in the same order. Default: the file name.--purpose <str>: What the packet is for. The same document sent for another purpose is sent in full.--source <str>: Where each document came from, in order.--version <str>: Version of each document, in order.--type <str>: Document type of each document, in order.--date <str>: The date on each document, in order, as year-month-day.--preview: Show what would be sent without sending.--help: Show this message and exit.
faxbot faxes cases accept¶
Record that the recipient confirmed it has these documents, so later packets can list them instead of resending.
Usage:
$ faxbot faxes cases accept [OPTIONS] {case_id}
Arguments:
case_id: Your case reference. [required]
Options:
--to <str>: Recipient fax number. [required]--document <str>: A document, by title or reference. Repeat for more. Default: every delivered document.--purpose <str>: Only documents sent for this purpose.--note <str>: Who confirmed it and how, for example "Their intake desk confirmed by phone".--received-fax <str>: The ID of the fax in which the recipient acknowledged them, from Received.--help: Show this message and exit.
faxbot faxes cases invalidate¶
The recipient could not find these documents: stop listing them, and send them in full in the next packet.
Usage:
$ faxbot faxes cases invalidate [OPTIONS] {case_id}
Arguments:
case_id: Your case reference. [required]
Options:
--to <str>: Recipient fax number. [required]--document <str>: A document the recipient could not find, by title or reference. Repeat for more. [required]--purpose <str>: Only documents sent for this purpose.--note <str>: What the recipient said.--help: Show this message and exit.
faxbot faxes cases repair¶
Send every document of the case to this recipient again, as a new fax. Faxbot never does this by itself.
Usage:
$ faxbot faxes cases repair [OPTIONS] {case_id}
Arguments:
case_id: Your case reference. [required]
Options:
--to <str>: Recipient fax number. [required]--reason <str>: Why the recipient needs every document again. Required to send.--preview: Show what would be sent without sending.--help: Show this message and exit.
faxbot faxes cases reuse¶
Show or set how long this recipient's acknowledgements are trusted before documents are sent in full again.
Usage:
$ faxbot faxes cases reuse [OPTIONS] {to}
Arguments:
to: Recipient fax number. [required]
Options:
--days <int range>: Trust its acknowledgements for this many days, then send those documents in full again. [1<=x<=3650]--no-limit: Trust its acknowledgements with no time limit.--default: Use Faxbot's default period.--help: Show this message and exit.
faxbot faxes cases originals¶
List the case's original documents, kept unchanged, with their type, date, version and source.
Usage:
$ faxbot faxes cases originals [OPTIONS] {case_id}
Arguments:
case_id: Your case reference. [required]
Options:
--help: Show this message and exit.
faxbot faxes cases add¶
Keep documents in a case without sending them, for checklist packets and repairs.
Usage:
$ faxbot faxes cases add [OPTIONS] {case_id} {files}...
Arguments:
case_id: Your case reference. [required]files...: PDF documents to keep in the case. [required]
Options:
--title <str>: Title for each file, in order. Default: the file name.--type <str>: Document type for each file, in order, as checklists name them, for example "Discharge summary".--date <str>: The date on each document, in order, as year-month-day.--version <str>: Version of each file, in order, for example "final".--source <str>: Where each file came from, in order.--help: Show this message and exit.
faxbot faxes cases suggestions¶
Turn on or off suggestions of documents that may match a missing checklist item. Off unless you turn it on.
Usage:
$ faxbot faxes cases suggestions [OPTIONS] {setting}
Arguments:
setting: on or off. [required]
Options:
--help: Show this message and exit.
faxbot faxes cases build¶
Build a packet from a checklist with the case's kept documents: picks with reasons, then missing items.
Usage:
$ faxbot faxes cases build [OPTIONS] {case_id}
Arguments:
case_id: Your case reference. [required]
Options:
--to <str>: Recipient fax number. [required]--checklist <str>: The checklist to follow. [required]--version <int range>: The checklist version; default: newest. [x>=1]--as-of <str>: Count date limits back from this day, as year-month-day. Default: today.--purpose <str>: What the packet is for.--preview: Show Faxbot's picks without sending.--allow-missing: Send even though required items are missing, when the recipient agreed.--help: Show this message and exit.
faxbot faxes cases checklist¶
A recipient's checklist of documents: types, dates, versions, and which are required.
Usage:
$ faxbot faxes cases checklist [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List checklists, newest version of each.show: Show a checklist's items, and its versions.add: Save a checklist.
faxbot faxes cases checklist list¶
List checklists, newest version of each.
Usage:
$ faxbot faxes cases checklist list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot faxes cases checklist show¶
Show a checklist's items, and its versions.
Usage:
$ faxbot faxes cases checklist show [OPTIONS] {name}
Arguments:
name: The checklist name. [required]
Options:
--version <int range>: A version; default: the newest. [x>=1]--help: Show this message and exit.
faxbot faxes cases checklist add¶
Save a checklist. Using a name again saves a new version; earlier versions never change.
Usage:
$ faxbot faxes cases checklist add [OPTIONS] {name} [items]
Arguments:
name: The checklist name, for example the recipient and request. [required]items: A JSON file: a list of items, each with "type", and optionally "required", "within_days" and "version".
Options:
--example: Start from the synthetic example checklist.--to <str>: The recipient fax number it is for.--help: Show this message and exit.
faxbot delivery¶
How faxes come in, go out and reach your staff: numbers, mailboxes, sending identity, email delivery, the email and folders that bring documents in, providers and routing rules.
Usage:
$ faxbot delivery [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
numbers: Your fax numbers: which mailbox each...mailboxes: Mailboxes that hold received faxes, and...blocked: Junk senders whose calls are turned away...identity: The number printed on the faxes you send,...email: Email delivery of received faxes to your...connectors: Email mailboxes and folders that bring...providers: The fax services Faxbot sends and receives...rules: Sending rules: which provider account...
faxbot delivery numbers¶
Your fax numbers: which mailbox each number's faxes go to, advice on keeping or moving them, and moving one between your accounts.
Usage:
$ faxbot delivery numbers [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List your fax numbers: who provides each...add: Send faxes that arrive on a number to a...update: Change a fax number's mailbox, the number...explain: Which mailbox, email and urgency a...advice: Read line advice with its history and...dependencies: Record a dependency: broadband,...closures: When copper, and the phone lines on it,...import-closures: Import the commune-level copper-closure...line-notice: Record a carrier's notice that a line...move: A checked plan for moving a number between...forwarded-trust: Certificate authorities you trust to...
faxbot delivery numbers list¶
List your fax numbers: who provides each one, the mailbox its faxes go to, and whether they are emailed.
Usage:
$ faxbot delivery numbers list [OPTIONS]
Options:
--ids: Also show internal ids.--help: Show this message and exit.
faxbot delivery numbers add¶
Send faxes that arrive on a number to a mailbox, optionally only some of them and with their own email and urgency.
Usage:
$ faxbot delivery numbers add [OPTIONS] {number}
Arguments:
number: Your fax number, as faxes arrive on it. [required]
Options:
--mailbox <str>: Mailbox that receives faxes sent to this number. [required]--account KEY: Only faxes received on this account.--from NUMBER: Only faxes from this number; end it with * for every number that starts with it (repeat it).--days DAYS: Only faxes received on these days, such as mon-fri.--between HH:MM-HH:MM: Only faxes received between these times, in this installation's time zone.--email CONNECTOR: Email these faxes through this connector.--no-email: Send no email for these faxes.--urgent / --not-urgent: Mark these faxes urgent.--keep-days DAYS: Remove these faxes from Faxbot after this many days. This is when cleanup removes the fax from Faxbot. It is not a legal hold, and it does not promise to keep the fax that long. [x>=1]--position N: Its place among your number rules; the first that matches a fax places it. [x>=1]--any-number / --this-number-only: Use the rule for faxes to any of your numbers.--subaddress DIGITS: Only faxes whose sender's machine gives this subaddress, such as a department's 2001. It chooses the mailbox and never gives anyone access.--site SITE: Only faxes received on an account of this site.--forwarded-from NUMBER: Only calls forwarded to this number from NUMBER, when the forwarding is verified (add --forwarded-unsigned to take one that is not). "" removes the condition.--forwarded-unsigned / --forwarded-signed-only: Also take a forwarding that is not verified: signed with a certificate from no certificate authority you trust, not checked, or unsigned (never one whose signature failed).--help: Show this message and exit.
faxbot delivery numbers update¶
Change a fax number's mailbox, the number itself, or which of its faxes the rule takes and how.
Usage:
$ faxbot delivery numbers update [OPTIONS] {number}
Arguments:
number: Fax number of the rule to change. [required]
Options:
--number <str>: New fax number.--mailbox <str>: New mailbox.--account KEY: Only faxes received on this account.--from NUMBER: Only faxes from this number; end it with * for every number that starts with it (repeat it).--days DAYS: Only faxes received on these days, such as mon-fri.--between HH:MM-HH:MM: Only faxes received between these times, in this installation's time zone.--email CONNECTOR: Email these faxes through this connector.--no-email: Send no email for these faxes.--urgent / --not-urgent: Mark these faxes urgent.--keep-days DAYS: Remove these faxes from Faxbot after this many days. This is when cleanup removes the fax from Faxbot. It is not a legal hold, and it does not promise to keep the fax that long. [x>=1]--position N: Its place among your number rules; the first that matches a fax places it. [x>=1]--any-number / --this-number-only: Use the rule for faxes to any of your numbers.--subaddress DIGITS: Only faxes whose sender's machine gives this subaddress, such as a department's 2001. It chooses the mailbox and never gives anyone access.--site SITE: Only faxes received on an account of this site.--forwarded-from NUMBER: Only calls forwarded to this number from NUMBER, when the forwarding is verified (add --forwarded-unsigned to take one that is not). "" removes the condition.--forwarded-unsigned / --forwarded-signed-only: Also take a forwarding that is not verified: signed with a certificate from no certificate authority you trust, not checked, or unsigned (never one whose signature failed).--help: Show this message and exit.
faxbot delivery numbers explain¶
Which mailbox, email and urgency a received fax would get, and why. Nothing is saved.
Usage:
$ faxbot delivery numbers explain [OPTIONS]
Options:
--to NUMBER: Your number the fax is sent to. [required]--from NUMBER: The number it comes from.--account KEY: The account it arrives on.--at TIME: When it arrives, in this installation's time zone, such as 2026-10-07 18:30.--subaddress DIGITS: The subaddress the sender's machine gives, if any.--help: Show this message and exit.
faxbot delivery numbers advice¶
Read line advice with its history and unanswered dependency questions.
Usage:
$ faxbot delivery numbers advice [OPTIONS]
Options:
--days <int range>: [default: 90; 30<=x<=183]--help: Show this message and exit.
faxbot delivery numbers dependencies¶
Record a dependency: broadband, other_lines, emergency or printed; answer yes, no or unknown.
Usage:
$ faxbot delivery numbers dependencies [OPTIONS] {number} {question} {answer}
Arguments:
number: [required]question: [required]answer: [required]
Options:
--note <str>--help: Show this message and exit.
faxbot delivery numbers closures¶
When copper, and the phone lines on it, close: your French sites by commune, and lines with a carrier's notice.
Usage:
$ faxbot delivery numbers closures [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery numbers import-closures¶
Import the commune-level copper-closure dates. The source's earlier file is kept as history. The government copy with only the columns Faxbot reads: https://data.economie.gouv.fr/api/explore/v2.1/catalog/datasets/ fermeture-reseau-cuivre/exports/csv?select=code_insee,nom_commune,fermeture_technique,fermeture_commerciale,lot
Usage:
$ faxbot delivery numbers import-closures [OPTIONS] {FILE}
Arguments:
FILE: Orange's commune trajectory file, or the government copy, as CSV. [required]
Options:
--source orange|gouv: Where the file comes from: Orange's own file or the copy on data.gouv.fr. [default: gouv]--file-date DATE: The file's own date, such as 2025-12-19.--source-url URL: Where you downloaded it.--help: Show this message and exit.
faxbot delivery numbers line-notice¶
Record a carrier's notice that a line closes (from its letter), so Faxbot warns before the date.
Usage:
$ faxbot delivery numbers line-notice [OPTIONS] {NUMBER}
Arguments:
NUMBER: The line's number. [required]
Options:
--closes DATE: The date the carrier says the line closes, such as 2026-11-04.--carrier NAME: The carrier that sent the notice.--received DATE: When the notice arrived.--note TEXT: What the letter says, for the history.--remove: Withdraw this line's notice.--help: Show this message and exit.
faxbot delivery numbers move¶
A checked plan for moving a number between your accounts. Faxbot places no port order.
Usage:
$ faxbot delivery numbers move [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
show: Read the plan, account choices, evidence...start: Start a checked move plan to another...record: Record a step as done or not_done.test: Start watching for a receipt test from...forget: Forget learned call properties from the...inventory: Your fax lines with their carrier, wire...import-inventory: Import your line inventory (CSV or Excel); it replaces the current one.import-carrier-list: Import a carrier's list of discontinued or grandfathered service areas.
faxbot delivery numbers move show¶
Read the plan, account choices, evidence and steps still to do.
Usage:
$ faxbot delivery numbers move show [OPTIONS] {number}
Arguments:
number: [required]
Options:
--help: Show this message and exit.
faxbot delivery numbers move start¶
Start a checked move plan to another receiving account; this places no port order.
Usage:
$ faxbot delivery numbers move start [OPTIONS] {number}
Arguments:
number: [required]
Options:
--to-account <str>: [required]--help: Show this message and exit.
faxbot delivery numbers move record¶
Record a step as done or not_done. Use step move with finished or abandoned to end the plan.
Usage:
$ faxbot delivery numbers move record [OPTIONS] {number} {step} {status}
Arguments:
number: [required]step: [required]status: [required]
Options:
--note <str>--help: Show this message and exit.
faxbot delivery numbers move test¶
Start watching for a receipt test from this route; send the test fax separately.
Usage:
$ faxbot delivery numbers move test [OPTIONS] {number}
Arguments:
number: [required]
Options:
--origin <str>: [required]--help: Show this message and exit.
faxbot delivery numbers move forget¶
Forget learned call properties from the old carrier and record this step in the plan.
Usage:
$ faxbot delivery numbers move forget [OPTIONS] {number}
Arguments:
number: [required]
Options:
--help: Show this message and exit.
faxbot delivery numbers move inventory¶
Your fax lines with their carrier, wire center and contract, each matched to the carrier lists you imported, lines with a date first.
Usage:
$ faxbot delivery numbers move inventory [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery numbers move import-inventory¶
Import your line inventory. It replaces the current one, which is kept as history; contract end dates become each line's contract-end date. Columns: number, service address, city, state, postal code, country, carrier, product (or USOC), wire center, distribution area, contract end, use (fax, alarm, elevator, emergency or other), monthly price, currency, note. Only the number is required.
Usage:
$ faxbot delivery numbers move import-inventory [OPTIONS] {FILE}
Arguments:
FILE: Your line inventory, as CSV or Excel (.xlsx). [required]
Options:
--date-order mdy|dmy: How the file writes dates: mdy (11/4/2026 is 4 November) or dmy (4/11/2026 is 4 November). [default: mdy]--help: Show this message and exit.
faxbot delivery numbers move import-carrier-list¶
Import a carrier's list of discontinued or grandfathered service areas. The same carrier's earlier list of that kind is kept as history. AT&T's workbook: https://clec.att.com/clec_documents/unrestr/clec/common/ PrimeAccess_Model-Discontinued_Service_Areas.xlsx. Another carrier's list is a CSV with the columns wire center and effective date, and optionally carrier, kind, state, city, wire center name, distribution area and place.
Usage:
$ faxbot delivery numbers move import-carrier-list [OPTIONS] {FILE}
Arguments:
FILE: AT&T's Discontinued TDM Service Areas workbook as downloaded, or another carrier's list as CSV. [required]
Options:
--carrier NAME: The carrier whose list this is, when the file has no carrier column (not needed for AT&T's workbook).--kind discontinued|grandfathered: What the list says about its areas, when the file has no kind column. Discontinued unless you say otherwise.--source-url URL: Where you downloaded it.--file-date DATE: The list's own date, such as 2026-08-17.--date-order mdy|dmy: How the file writes dates. [default: mdy]--help: Show this message and exit.
faxbot delivery numbers forwarded-trust¶
Certificate authorities you trust to verify that a carrier forwarded a call (STIR/SHAKEN STI-CAs). A forwarding is verified only when it chains to one.
Usage:
$ faxbot delivery numbers forwarded-trust [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the certificate authorities you trust...add: Trust certificate authorities for...remove: Stop trusting one certificate authority...
faxbot delivery numbers forwarded-trust list¶
List the certificate authorities you trust for forwarded calls.
Usage:
$ faxbot delivery numbers forwarded-trust list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery numbers forwarded-trust add¶
Trust certificate authorities for forwarded calls: from a file of PEM certificates, or from a list at an address. Only certificate authorities are kept, each once.
Usage:
$ faxbot delivery numbers forwarded-trust add [OPTIONS] [FILE]
Arguments:
[FILE]: PEM certificates of the certificate authorities, or '-' for standard input.
Options:
--url ADDRESS: Read the list from this https:// address instead, once, now (a list you can reach, such as one your carrier gives you).--help: Show this message and exit.
faxbot delivery numbers forwarded-trust remove¶
Stop trusting one certificate authority for forwarded calls.
Usage:
$ faxbot delivery numbers forwarded-trust remove [OPTIONS] {fingerprint}
Arguments:
fingerprint: The start of its fingerprint, as the list shows it (at least 8 characters). [required]
Options:
--help: Show this message and exit.
faxbot delivery mailboxes¶
Mailboxes that hold received faxes, and how soon someone should acknowledge them.
Usage:
$ faxbot delivery mailboxes [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List mailboxes.add: Add a mailbox.update: Rename a mailbox or switch it on or off.target: Show or change how soon received faxes...
faxbot delivery mailboxes list¶
List mailboxes.
Usage:
$ faxbot delivery mailboxes list [OPTIONS]
Options:
--ids: Also show internal ids.--help: Show this message and exit.
faxbot delivery mailboxes add¶
Add a mailbox.
Usage:
$ faxbot delivery mailboxes add [OPTIONS] {label}
Arguments:
label: Mailbox name, for example "Front desk". [required]
Options:
--disabled: Create the group disabled, so its roles do not apply yet.--help: Show this message and exit.
faxbot delivery mailboxes update¶
Rename a mailbox or switch it on or off.
Usage:
$ faxbot delivery mailboxes update [OPTIONS] {mailbox}
Arguments:
mailbox: Mailbox name or id. [required]
Options:
--name <str>: New name.--enable: Switch on.--disable: Switch off.--help: Show this message and exit.
faxbot delivery mailboxes target¶
Show or change how soon received faxes should be acknowledged, and who covers missed ones. New faxes use the targets in place when they arrive.
Usage:
$ faxbot delivery mailboxes target [OPTIONS]
Options:
--acknowledge-hours <int range>: The installation's acknowledgement target in hours (0 for none). An operational target, not a legal deadline. [0<=x<=8760]--mailbox <str>: Change this mailbox, by name.--hours <int range>: With --mailbox: this mailbox's acknowledgement target in hours (0 for none). [0<=x<=8760]--use-installation-target: With --mailbox: use the installation-wide acknowledgement target for this mailbox.--backup <str>: With --mailbox: the backup person who takes over faxes not acknowledged in time.--no-backup: With --mailbox: remove the backup.--help: Show this message and exit.
faxbot delivery blocked¶
Junk senders whose calls are turned away before Faxbot answers, and the calls turned away.
Usage:
$ faxbot delivery blocked [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List blocked senders and the calls turned...add: Block a sender: their calls are turned...remove: Unblock a sender.
faxbot delivery blocked list¶
List blocked senders and the calls turned away.
Usage:
$ faxbot delivery blocked list [OPTIONS]
Options:
--all: Also list senders no longer blocked.--help: Show this message and exit.
faxbot delivery blocked add¶
Block a sender: their calls are turned away before Faxbot answers.
Usage:
$ faxbot delivery blocked add [OPTIONS] {number}
Arguments:
number: The sender's fax number. [required]
Options:
--reason <str>: Why this sender is junk, in a few words. [required]--days <int range>: How many days to block the sender (90 unless you say). [default: 90; 1<=x<=365]--help: Show this message and exit.
faxbot delivery blocked remove¶
Unblock a sender. The entry stays in the history, marked as removed by you.
Usage:
$ faxbot delivery blocked remove [OPTIONS] {number}
Arguments:
number: The blocked number (or its entry ID, from --json). [required]
Options:
--help: Show this message and exit.
faxbot delivery identity¶
The number printed on the faxes you send, so replies reach you on your cheapest number.
Usage:
$ faxbot delivery identity [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
show: Show the number your faxes show, why, what...numbers: List your numbers with the mailbox each...set: Print this number on every fax (or on...clear: Let Faxbot choose the number again (or...station-check: See or choose what a mailbox's faxes do...notice: A notice line, such as a confidentiality...
faxbot delivery identity show¶
Show the number your faxes show, why, what caller ID each provider shows, and which number is cheapest.
Usage:
$ faxbot delivery identity show [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery identity numbers¶
List your numbers with the mailbox each reaches and what receiving on it costs.
Usage:
$ faxbot delivery identity numbers [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery identity set¶
Print this number on every fax (or on faxes from one mailbox) and send it as the station ID.
Usage:
$ faxbot delivery identity set [OPTIONS] {number}
Arguments:
number: Your fax number that replies should reach. [required]
Options:
--mailbox <str>: A mailbox, for faxes sent from it; leave out for every fax.--help: Show this message and exit.
faxbot delivery identity clear¶
Let Faxbot choose the number again (or give a mailbox's faxes the organization's number).
Usage:
$ faxbot delivery identity clear [OPTIONS]
Options:
--mailbox <str>: A mailbox, for faxes sent from it; leave out for every fax.--help: Show this message and exit.
faxbot delivery identity station-check¶
See or choose what a mailbox's faxes do when a number answers as another fax machine.
Usage:
$ faxbot delivery identity station-check [OPTIONS] [WARN|REFUSE]
Arguments:
[WARN|REFUSE]: warn: the fax goes on and Sent says so. refuse: Faxbot hangs up before any page. Leave it out to see the current choice.
Options:
--mailbox <str>: The mailbox whose faxes this is for. Leave it out to see every mailbox's choice.--help: Show this message and exit.
faxbot delivery identity notice¶
A notice line, such as a confidentiality notice, printed at the top of every page you send, so a cover sheet carrying it can stay unsent.
Usage:
$ faxbot delivery identity notice [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
show: Show the notice your faxes carry, and each...set: Print this notice at the top of every page...clear: Stop printing the notice (a mailbox's...
faxbot delivery identity notice show¶
Show the notice your faxes carry, and each mailbox's own.
Usage:
$ faxbot delivery identity notice show [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery identity notice set¶
Print this notice at the top of every page (or of every page sent from one mailbox).
Usage:
$ faxbot delivery identity notice set [OPTIONS] {NOTICE}
Arguments:
NOTICE: One line of up to 120 characters, such as "Confidential: for the addressee only. If you received this in error, call us." [required]
Options:
--mailbox <str>: A mailbox, for faxes sent from it; leave out for every fax.--help: Show this message and exit.
faxbot delivery identity notice clear¶
Stop printing the notice (a mailbox's faxes then carry the organization's notice, if any).
Usage:
$ faxbot delivery identity notice clear [OPTIONS]
Options:
--mailbox <str>: A mailbox, for faxes sent from it; leave out for every fax.--help: Show this message and exit.
faxbot delivery email¶
Email delivery of received faxes to your staff.
Usage:
$ faxbot delivery email [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
connectors: The email inboxes and other places...
faxbot delivery email connectors¶
The email inboxes and other places received faxes are delivered to.
Usage:
$ faxbot delivery email connectors [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the email inboxes and other places...add: Add an email inbox that received faxes are...update: Change an email delivery.test: Send a test email to check a delivery...remove: Stop delivering to an email inbox and...
faxbot delivery email connectors list¶
List the email inboxes and other places received faxes are delivered to.
Usage:
$ faxbot delivery email connectors list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery email connectors add¶
Add an email inbox that received faxes are delivered to.
Usage:
$ faxbot delivery email connectors add [OPTIONS] {name}
Arguments:
name: A name for this delivery, for example "Front desk email". [required]
Options:
--host <str>: Your mail server's address. [required]--to <str>: Email address to deliver to. Repeat for more. [required]--from <str>: Sender email address. [required]--port <int>: Mail server port. [default: 587]--security <str>: How the connection to the mail server is protected: starttls, tls or none. [default: starttls]--username <str>: Mail server sign-in name.--ask-password: Prompt for the mail server password without echoing it (or set FAXBOT_SMTP_PASSWORD).--subject <str>: Email subject. [default: Fax from {from_number}]--fax-number <str>: Only documents sent to this fax number. Default: all.--disabled: Create the group disabled, so its roles do not apply yet.--help: Show this message and exit.
faxbot delivery email connectors update¶
Change an email delivery. Settings you leave out stay as they are.
Usage:
$ faxbot delivery email connectors update [OPTIONS] {name}
Arguments:
name: A name for this delivery, for example "Front desk email". [required]
Options:
--name <str>: New name.--host <str>: Mail server address.--port <int>: Mail server port.--security <str>: How the connection to the mail server is protected: starttls, tls or none.--username <str>: Mail server sign-in name.--ask-password: Ask for a new mail server password without showing it.--to <str>: Replace the recipients. Repeat for more.--from <str>: Sender email address.--subject <str>: Email subject.--fax-number <str>: Only this fax number; 'all' for every number.--enable: Switch on.--disable: Switch off.--help: Show this message and exit.
faxbot delivery email connectors test¶
Send a test email to check a delivery address.
Usage:
$ faxbot delivery email connectors test [OPTIONS] {name}
Arguments:
name: A name for this delivery, for example "Front desk email". [required]
Options:
--help: Show this message and exit.
faxbot delivery email connectors remove¶
Stop delivering to an email inbox and remove it.
Usage:
$ faxbot delivery email connectors remove [OPTIONS] {name}
Arguments:
name: A name for this delivery, for example "Front desk email". [required]
Options:
--help: Show this message and exit.
faxbot delivery connectors¶
Email mailboxes and folders that bring documents into Faxbot or send faxes, each document only once.
Usage:
$ faxbot delivery connectors [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List connectors with what each does, its...add: Add a connector.update: Change a connector.test: Sign in to the mailbox or open the folder...pause: Stop checking a connector.resume: Check a connector again.remove: Remove a connector.items: List what connectors brought in or sent,...fax: Show who asked for a fax that came in by...choices: Show the mailboxes, people and mail...
faxbot delivery connectors list¶
List connectors with what each does, its status and its counts.
Usage:
$ faxbot delivery connectors list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery connectors add¶
Add a connector. Secrets are asked for without showing them, never taken from the command line.
Usage:
$ faxbot delivery connectors add [OPTIONS] {name}
Arguments:
name: A name for the connector, such as "Scanner share" or "Email to fax". [required]
Options:
--kind <str>: email (a mailbox) or folder (a folder inside the Faxbot container). [required]--direction <str>: receive brings documents in; send faxes them. [default: receive]--mailbox <str>: Mailbox that receives documents with no sidecar file.--path <str>: Folder inside the Faxbot container, such as /scans.--settle-seconds <int>: Seconds a file must stay unchanged before Faxbot reads it.--sidecar-minutes <int>: Minutes to wait for the file with the fax number before giving up.--service <str>: microsoft365, google or other. [default: other]--address <str>: The mailbox address, such as fax@example.com.--username <str>: Sign-in name, if not the mailbox address.--mail-server <str>: Incoming mail server, unless the service sets it.--mail-port <int>: Incoming mail server port (993 unless you change it).--folder <str>: Mail folder Faxbot checks (INBOX unless you change it).--processed-folder <str>: Mail folder Faxbot moves handled messages to.--sign-in <str>: password, microsoft_app, google_service_account or oauth_refresh.--tenant-id <str>: Microsoft 365 directory (tenant) ID.--client-id <str>: Application (client) ID.--token-url <str>: Token address, for oauth_refresh.--service-account-file <str>: Google service account key file (JSON).--outgoing-server <str>: Outgoing mail server for replies, unless the service sets it.--outgoing-port <int>: Outgoing mail server port.--outgoing-security <str>: tls or starttls.--checked-by <str>: Name your mail server writes when it checks senders, such as mx.google.com.--sender <str>: Who may send faxes by email: address=login. Repeat for more.--copier ADDRESS@NETWORK: A copier that sends by direct SMTP, without DKIM or SPF: its email address and its network address, such as 'scanner@example.com 192.168.1.40'. Repeat for more.--check-seconds <int>: How often to check, in seconds.--ask-secret / --no-ask-secret: Ask for the password or client secret without showing it. [default: ask-secret]--help: Show this message and exit.
faxbot delivery connectors update¶
Change a connector. Settings you leave out stay as they are.
Usage:
$ faxbot delivery connectors update [OPTIONS] {name}
Arguments:
name: The connector name. [required]
Options:
--name <str>: New name.--check-seconds <int>: How often to check, in seconds.--mailbox <str>: Mailbox for documents with no sidecar.--sender <str>: Replace who may send faxes by email: address=login. Repeat for more.--new-secret: Ask for a new password or client secret without showing it.--service-account-file <str>: A new Google service account key file.--help: Show this message and exit.
faxbot delivery connectors test¶
Sign in to the mailbox or open the folder and look, without changing anything.
Usage:
$ faxbot delivery connectors test [OPTIONS] {name}
Arguments:
name: The connector name. [required]
Options:
--help: Show this message and exit.
faxbot delivery connectors pause¶
Stop checking a connector. A connector that sends faxes loses its sending key until you resume it.
Usage:
$ faxbot delivery connectors pause [OPTIONS] {name}
Arguments:
name: The connector name. [required]
Options:
--help: Show this message and exit.
faxbot delivery connectors resume¶
Check a connector again. A connector that sends faxes gets a new sending key.
Usage:
$ faxbot delivery connectors resume [OPTIONS] {name}
Arguments:
name: The connector name. [required]
Options:
--help: Show this message and exit.
faxbot delivery connectors remove¶
Remove a connector. What it brought in or sent stays listed.
Usage:
$ faxbot delivery connectors remove [OPTIONS] {name}
Arguments:
name: The connector name. [required]
Options:
--help: Show this message and exit.
faxbot delivery connectors items¶
List what connectors brought in or sent, newest first, with anything seen again or refused.
Usage:
$ faxbot delivery connectors items [OPTIONS] [name]
Arguments:
name: Only this connector.
Options:
--limit <int range>: How many to show. [default: 100; 1<=x<=500]--help: Show this message and exit.
faxbot delivery connectors fax¶
Show who asked for a fax that came in by email or from a folder.
Usage:
$ faxbot delivery connectors fax [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID from 'faxbot faxes sent list'. [required]
Options:
--help: Show this message and exit.
faxbot delivery connectors choices¶
Show the mailboxes, people and mail services you can use when adding a connector.
Usage:
$ faxbot delivery connectors choices [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers¶
The fax services Faxbot sends and receives with, their settings, and your own phone line for faxing.
Usage:
$ faxbot delivery providers [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the fax and storage providers...status: Show whether the active provider is ready...show: Show a provider's settings.configure: Change a provider's settings, or start...callbacks: Show the addresses your receiving provider...validate: Check the file that describes a fax...install: Install a custom HTTP fax provider from...import: Add several fax services at once from a...long-pages: Show or set long pages for each delivery...efax: eFax receiving: whether Faxbot is...humblefax: HumbleFax receiving: whether Faxbot is...trunk: Your own phone line for faxing, to a phone...accounts: The provider accounts Faxbot sends and...digital: Direct messages and FHIR: the HISP account...destinations: Where Faxbot may dial: numbers in your...
faxbot delivery providers list¶
List the fax and storage providers installed, and which ones are in use.
Usage:
$ faxbot delivery providers list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers status¶
Show whether the active provider is ready and how many faxes are in each state.
Usage:
$ faxbot delivery providers status [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers show¶
Show a provider's settings. Passwords and keys are hidden.
Usage:
$ faxbot delivery providers show [OPTIONS] {provider}
Arguments:
provider: Provider from 'faxbot delivery providers list'. [required]
Options:
--role <str>: Only say whether it is used for outbound (sending), inbound (receiving) or storage.--help: Show this message and exit.
faxbot delivery providers configure¶
Change a provider's settings, or start using it for sending, receiving or storage.
Passwords and keys are never typed as NAME=VALUE, where they would stay in your shell history: use --secret NAME to type one without showing it, or --secret-stdin NAME to read it from standard input.
Usage:
$ faxbot delivery providers configure [OPTIONS] {provider} [NAME=VALUE...]
Arguments:
provider: Provider from 'faxbot delivery providers list'. [required]NAME=VALUE...: Provider settings to change.
Options:
--secret NAME: Prompt for this setting's value without echoing it, for passwords and keys. Repeat for more.--secret-stdin NAME: Read this password or key from standard input, one line each, for scripts. Repeat for more.--role <str>: With --enable: outbound (sending), inbound (receiving) or storage.--enable: Use this provider for sending, receiving or storage (choose which with --role).--help: Show this message and exit.
faxbot delivery providers callbacks¶
Show the addresses your receiving provider must call for incoming faxes.
Usage:
$ faxbot delivery providers callbacks [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers validate¶
Check the file that describes a fax service before you add it. Nothing is installed or sent.
Usage:
$ faxbot delivery providers validate [OPTIONS] {manifest}
Arguments:
manifest: The file that describes the fax service (JSON). [required]
Options:
--help: Show this message and exit.
faxbot delivery providers install¶
Install a custom HTTP fax provider from its manifest file.
Usage:
$ faxbot delivery providers install [OPTIONS] {manifest}
Arguments:
manifest: The file that describes the fax service (JSON). [required]
Options:
--help: Show this message and exit.
faxbot delivery providers import¶
Add several fax services at once from a file of their descriptions.
Usage:
$ faxbot delivery providers import [OPTIONS] {FILE}
Arguments:
FILE: A JSON file of provider descriptions, or a Markdown file with them in code blocks; '-' reads standard input. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers long-pages¶
Show or set long pages for each delivery route, and blank space at the bottom of pages.
Usage:
$ faxbot delivery providers long-pages [OPTIONS] [route]
Arguments:
route: Route to change, as listed: sip, sinch, documo, humblefax, efax, phaxio or signalwire.
Options:
--long-pages ON|OFF|DEFAULT: Several pages on one long page on this route: on, off, or default.--blank-space ON|OFF|DEFAULT: For all faxes on your phone line (route sip): leave out the blank bottom of pages for machines without error correction. On, off, or default.--help: Show this message and exit.
faxbot delivery providers efax¶
eFax receiving: whether Faxbot is collecting your faxes from eFax.
Usage:
$ faxbot delivery providers efax [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
status: Show whether Faxbot is collecting your...
faxbot delivery providers efax status¶
Show whether Faxbot is collecting your received faxes from eFax, when it last checked, and faxes still stored at eFax.
Usage:
$ faxbot delivery providers efax status [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers humblefax¶
HumbleFax receiving: whether Faxbot is collecting your faxes from HumbleFax, and checking now.
Usage:
$ faxbot delivery providers humblefax [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
status: Show whether Faxbot is collecting your...check: Check HumbleFax for received faxes now,...
faxbot delivery providers humblefax status¶
Show whether Faxbot is collecting your received faxes from HumbleFax, when it last checked and what it found.
Usage:
$ faxbot delivery providers humblefax status [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers humblefax check¶
Check HumbleFax for received faxes now, instead of waiting for the next check.
Usage:
$ faxbot delivery providers humblefax check [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk¶
Your own phone line for faxing, to a phone carrier or to your phone system: presets, status and recent calls.
Usage:
$ faxbot delivery providers trunk [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
status: Check the SIP trunk: registration with the...apply: Connect the saved phone line settings.calls: List recent calls on the phone line,...negotiation: Show how fax calls on your phone line...restart-engine: Restart the fax engine once no fax is...mode: Choose how new fax calls are sent, T.38...limits: Show or change how many calls the trunk...presets: List the carriers and phone systems Faxbot...use: Choose a carrier or phone system preset...caller-ids: The caller ID each sending account's calls...confirm-caller-id: Confirm that you hold a caller ID and may...own-access: For Telekom CompanyFlex: the internet...withdraw-caller-id: Withdraw a caller-ID confirmation; calls...answer-cap: See or change whether Faxbot hangs up when...teams-annex: Print what to set on your Teams Direct...copiers: List the copier makers whose documents...network: Whether fax over IP (T.38) works on the...telnyx: Telnyx settings for fax over IP (T.38) on...send-only: Numbers you show on faxes you send but...analog-line: An analog phone line through a gateway:...copier-extensions: Copiers that register to Faxbot as their...caller-check: The caller-verification stamp on received...
faxbot delivery providers trunk status¶
Check the SIP trunk: registration with the carrier, Faxbot's public IP address, and the last call.
Usage:
$ faxbot delivery providers trunk status [OPTIONS]
Options:
--account KEY: Which trunk, by its key from 'faxbot delivery providers accounts list'; the first trunk when left out.--help: Show this message and exit.
faxbot delivery providers trunk apply¶
Connect the saved phone line settings. Faxbot restarts its fax engine to load them once no call is in progress, or tells you how to restart it yourself.
Usage:
$ faxbot delivery providers trunk apply [OPTIONS]
Options:
--wait / --no-wait: Wait until the SIP trunk registers, then show the trunk check. [default: wait]--timeout <int range>: Seconds to wait. [default: 60; 5<=x<=600]--help: Show this message and exit.
faxbot delivery providers trunk calls¶
List recent calls on the phone line, newest first, each with one sentence about what happened.
Usage:
$ faxbot delivery providers trunk calls [OPTIONS]
Options:
--limit <int range>: How many calls to show, newest first. [default: 10; 1<=x<=200]--direction <str>: Only outbound or inbound calls.--help: Show this message and exit.
faxbot delivery providers trunk negotiation¶
Show how fax calls on your phone line went, grouped by compression, error correction and speed: calls, how many succeeded, seconds per confirmed page and calls per delivered fax. Faxbot changes speed or compression for one number only after its own calls to it fail the same way more than once, and never turns error correction off.
Usage:
$ faxbot delivery providers trunk negotiation [OPTIONS]
Options:
--days DAYS: How many days to count: 7, 30 or 90. [default: 30]--help: Show this message and exit.
faxbot delivery providers trunk restart-engine¶
Restart the fax engine once no fax is being sent or received.
Usage:
$ faxbot delivery providers trunk restart-engine [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk mode¶
Choose how new fax calls are sent, T.38 (fax over IP) or audio when T.38 fails, then reconnect the trunk.
Usage:
$ faxbot delivery providers trunk mode [OPTIONS] {t38|audio}
Arguments:
t38|audio: t38 (recommended), or audio when T.38 faxes fail on your line. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk limits¶
Show or change how many calls the trunk takes at once and how many new calls a second. Faxes beyond them wait for a free line; they never fail for it.
Usage:
$ faxbot delivery providers trunk limits [OPTIONS]
Options:
--calls-at-once <int range>: Calls at once on the trunk; 0 means the same as the fax lines. [0<=x<=200]--calls-per-second <int range>: New calls per second; 0 means your carrier's published limit, or no limit. [0<=x<=100]--help: Show this message and exit.
faxbot delivery providers trunk presets¶
List the carriers and phone systems Faxbot knows the settings for, or show one with where each setting comes from. For a phone system it also lists, in order, what you set in it.
Usage:
$ faxbot delivery providers trunk presets [OPTIONS] [PRESET]
Arguments:
[PRESET]: Show one preset in full, for example avaya-ipoffice.
Options:
--help: Show this message and exit.
faxbot delivery providers trunk use¶
Choose a carrier or phone system preset for the SIP trunk and save its settings; then connect it with faxbot delivery providers trunk apply.
A phone system recognizes Faxbot by its IP address, so it needs no username or password.
Usage:
$ faxbot delivery providers trunk use [OPTIONS] {PRESET}
Arguments:
PRESET: Carrier or phone system preset, for example telnyx (see faxbot delivery providers trunk presets). [required]
Options:
--host <str>: The carrier's server address, or your phone system's address (IP Office, or Aura Session Manager).--port <int range>: The carrier's port, when not the usual one. [1<=x<=65535]--transport <str>: How Faxbot connects to the line: udp, tcp or tls (encrypted), where the preset offers it.--number-format e164|local|local_area: How numbers are dialed: e164 (international format, +44...), local (as a phone at your site dials them), or on an analog line local_area (ten digits for numbers in its local calling area, 1 and ten digits for others).--prefix <str>: Outside-line digits before a number dialled as a phone here dials it, such as 9; on an analog line, *70 turns call waiting off for the call.--help: Show this message and exit.
faxbot delivery providers trunk caller-ids¶
The caller ID each sending account's calls show, what you confirmed about it, and the rate decks priced by caller ID.
Usage:
$ faxbot delivery providers trunk caller-ids [OPTIONS]
Options:
--quote NUMBER: Show how a fax to this number is priced by caller ID on each sending account.--help: Show this message and exit.
faxbot delivery providers trunk confirm-caller-id¶
Confirm that you hold a caller ID and may send faxes from it on one account, so calls from it get the rate its carrier gives that caller ID.
Usage:
$ faxbot delivery providers trunk confirm-caller-id [OPTIONS] {ACCOUNT} {CALLER_ID}
Arguments:
ACCOUNT: The sending account, by its key from 'faxbot delivery providers accounts list'. [required]CALLER_ID: The caller ID with its country code, such as +442079460000. [required]
Options:
--evidence TEXT: How you know you may send from it on this account, such as the number order or invoice. [required]--evidence-url URL: A link to that evidence.--bought-here: The number was bought on this account, so the carrier prices calls from it to its own country as local.--help: Show this message and exit.
faxbot delivery providers trunk own-access¶
For Telekom CompanyFlex: the internet address of your Telekom line. On any other access Faxbot encrypts the calls and sends audio fax by itself, as CompanyFlex requires.
Usage:
$ faxbot delivery providers trunk own-access [OPTIONS] [ADDRESSES]
Arguments:
ADDRESSES: Your Telekom line's internet addresses or ranges, comma-separated; '' clears them.
Options:
--help: Show this message and exit.
faxbot delivery providers trunk withdraw-caller-id¶
Withdraw a caller-ID confirmation; calls from it are priced as unconfirmed again. The history is kept.
Usage:
$ faxbot delivery providers trunk withdraw-caller-id [OPTIONS] {ACCOUNT} {CALLER_ID}
Arguments:
ACCOUNT: The sending account. [required]CALLER_ID: The confirmed caller ID. [required]
Options:
--note TEXT: Why, for the history.--help: Show this message and exit.
faxbot delivery providers trunk answer-cap¶
See or change whether Faxbot hangs up when no fax machine answers within 50 seconds.
Usage:
$ faxbot delivery providers trunk answer-cap [OPTIONS] [on|off]
Arguments:
[on|off]: on: hang up when no fax machine answers within 50 seconds, where the carrier bills by the minute. off: wait the usual 60 seconds. Leave it out to see the setting.
Options:
--account KEY: Which trunk, by its key from 'faxbot delivery providers accounts list'; the first trunk when left out.--help: Show this message and exit.
faxbot delivery providers trunk teams-annex¶
Print what to set on your Teams Direct Routing SBC so the fax numbers reach Faxbot before Teams, and the checklist before the Teams port order.
Usage:
$ faxbot delivery providers trunk teams-annex [OPTIONS]
Options:
--vendor audiocodes|ribbon|oracle|anynode: The company that makes your Teams Direct Routing SBC. [required]--address ADDRESS: Faxbot's address on your network, written into the steps; Faxbot fills it in when it is published there.--numbers NUMBERS: Your fax numbers or their pattern, written into the steps.--help: Show this message and exit.
faxbot delivery providers trunk copiers¶
List the copier makers whose documents show fax over the network with SIP and T.38, or show what to set on one.
Usage:
$ faxbot delivery providers trunk copiers [OPTIONS] [COPIER]
Arguments:
[COPIER]: Show one copier in full, such as ricoh-im.
Options:
--help: Show this message and exit.
faxbot delivery providers trunk network¶
Whether fax over IP (T.38) works on the network Faxbot runs on, and what to do when it does not.
Usage:
$ faxbot delivery providers trunk network [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
status: Show whether fax over IP (T.38) works on...check: Run the network check again now; new calls...router-ports: Let Faxbot open its fax ports on your...
faxbot delivery providers trunk network status¶
Show whether fax over IP (T.38) works on this network, where Faxbot runs, and how to fix it when it does not.
Usage:
$ faxbot delivery providers trunk network status [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk network check¶
Run the network check again now; new calls use fax over IP only when it works.
Usage:
$ faxbot delivery providers trunk network check [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk network router-ports¶
Let Faxbot open its fax ports on your router (on, the default) or not (off), then check the network again.
Usage:
$ faxbot delivery providers trunk network router-ports [OPTIONS] {on|off}
Arguments:
on|off: on lets Faxbot open its fax ports on your router; off stops it and closes any it opened. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk telnyx¶
Telnyx settings for fax over IP (T.38) on your trunk numbers.
Usage:
$ faxbot delivery providers trunk telnyx [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
status: Show whether Telnyx has fax over IP (T.38)...t38-on: Turn on fax over IP (T.38) at Telnyx for...names: Show whether Telnyx looks up callers'...name-lookup-off: Turn off caller-name lookup at Telnyx for...
faxbot delivery providers trunk telnyx status¶
Show whether Telnyx has fax over IP (T.38) turned on for each trunk number, from the last check.
Usage:
$ faxbot delivery providers trunk telnyx status [OPTIONS]
Options:
--account KEY: Which trunk, by its key from 'faxbot delivery providers accounts list'; the first trunk when left out.--help: Show this message and exit.
faxbot delivery providers trunk telnyx t38-on¶
Turn on fax over IP (T.38) at Telnyx for one trunk number. Only that setting changes.
Usage:
$ faxbot delivery providers trunk telnyx t38-on [OPTIONS] {NUMBER}
Arguments:
NUMBER: The trunk number, for example +17208565062. [required]
Options:
--account KEY: Which trunk, by its key from 'faxbot delivery providers accounts list'; the first trunk when left out.--help: Show this message and exit.
faxbot delivery providers trunk telnyx names¶
Show whether Telnyx looks up callers' names on each trunk number, and what that costs, from the last check.
Usage:
$ faxbot delivery providers trunk telnyx names [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk telnyx name-lookup-off¶
Turn off caller-name lookup at Telnyx for one trunk number. Faxbot never shows callers' names; only that setting changes.
Usage:
$ faxbot delivery providers trunk telnyx name-lookup-off [OPTIONS] {NUMBER}
Arguments:
NUMBER: The trunk number, for example +17208565062. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk send-only¶
Numbers you show on faxes you send but never receive on here, such as your main office number.
Usage:
$ faxbot delivery providers trunk send-only [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: Show your send-only numbers, where each...add: Add a send-only number.remove: Remove a send-only number; it counts as...
faxbot delivery providers trunk send-only list¶
Show your send-only numbers, where each shows, and numbers you rent only to send from.
Usage:
$ faxbot delivery providers trunk send-only list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk send-only add¶
Add a send-only number. To show it, set it as a trunk's caller ID or as the station ID too.
Usage:
$ faxbot delivery providers trunk send-only add [OPTIONS] {NUMBER}
Arguments:
NUMBER: The number with its country code, such as +13035550100. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk send-only remove¶
Remove a send-only number; it counts as one of your numbers again only if an account receives on it.
Usage:
$ faxbot delivery providers trunk send-only remove [OPTIONS] {NUMBER}
Arguments:
NUMBER: The send-only number to remove. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk analog-line¶
An analog phone line through a gateway: its local calling area and its prices, so local numbers go out on it at no extra cost.
Usage:
$ faxbot delivery providers trunk analog-line [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
show: Show an analog line's local calling area...routing: Let Faxbot choose an analog line by...import: Import an analog line's local calling area...
faxbot delivery providers trunk analog-line show¶
Show an analog line's local calling area and prices.
Usage:
$ faxbot delivery providers trunk analog-line show [OPTIONS]
Options:
--account KEY: Which trunk, by its key from 'faxbot delivery providers accounts list'; the first trunk when left out. [default: sip]--help: Show this message and exit.
faxbot delivery providers trunk analog-line routing¶
Let Faxbot choose an analog line by itself, or stop it. Importing a local calling area turns this on.
Usage:
$ faxbot delivery providers trunk analog-line routing [OPTIONS] {on|off}
Arguments:
on|off: on: Faxbot may choose the line by itself; off: only a sending rule that names it uses it. [required]
Options:
--account KEY: Which trunk, by its key from 'faxbot delivery providers accounts list'; the first trunk when left out. [default: sip]--help: Show this message and exit.
faxbot delivery providers trunk analog-line import¶
Import an analog line's local calling area from a file you saved, so local numbers go out on it at no extra cost. Faxbot never looks the area up itself.
Usage:
$ faxbot delivery providers trunk analog-line import [OPTIONS] {FILE}
Arguments:
FILE: The list of local prefixes for your line: the Local Calling Guide's Local prefixes page saved as HTML, its XML, a CSV with NPA and NXX columns, or one prefix a line such as 303-426. [required]
Options:
--account KEY: Which trunk, by its key from 'faxbot delivery providers accounts list'; the first trunk when left out. [default: sip]--plan <str>: The calling plan your line has, when the list names several.--line NPA-NXX: Your line's own prefix or number, checked against the list.--toll-rate AMOUNT: What the line charges a minute for calls outside the local area, from your phone bill; 0 when your plan includes them. Needed the first time.--monthly-fee AMOUNT: The line's monthly fee, shown with its prices.--increment <int range>: The billing step for calls outside the local area, in seconds. [default: 60; 1<=x<=3600]--source URL: The address of the page the list came from.--help: Show this message and exit.
faxbot delivery providers trunk copier-extensions¶
Copiers that register to Faxbot as their own extension: their faxes go out through your routes and rules, and faxes for their numbers go on to them.
Usage:
$ faxbot delivery providers trunk copier-extensions [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List your copier extensions and where...add: Add a copier extension.remove: Take a copier extension away and revoke...received: Say whether a received fax went on to its...
faxbot delivery providers trunk copier-extensions list¶
List your copier extensions and where their faxes go.
Usage:
$ faxbot delivery providers trunk copier-extensions list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk copier-extensions add¶
Add a copier extension. Its password is printed once: enter it on the copier, then press Apply on the trunk page (faxbot delivery providers trunk apply) so the fax engine loads it.
Usage:
$ faxbot delivery providers trunk copier-extensions add [OPTIONS] {name} {extension}
Arguments:
name: The copier, such as "Front desk Ricoh". [required]extension: Its extension, 3 to 6 digits, such as 601. [required]
Options:
--mailbox <str>: The mailbox its faxes are sent from, by ID.--number <str>: A fax number whose faxes go on to it; repeat it.--receive copier|intake: copier: faxes to its numbers go on to it; intake: they stay in Received. [default: copier]--help: Show this message and exit.
faxbot delivery providers trunk copier-extensions remove¶
Take a copier extension away and revoke its sending key.
Usage:
$ faxbot delivery providers trunk copier-extensions remove [OPTIONS] {copier}
Arguments:
copier: The copier, by its extension, name or ID. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk copier-extensions received¶
Say whether a received fax went on to its copier, or why it stays in Received.
Usage:
$ faxbot delivery providers trunk copier-extensions received [OPTIONS] {fax_id}
Arguments:
fax_id: A received fax's ID. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk caller-check¶
The caller-verification stamp on received faxes: what the network asserted about who called, and your registered senders.
Usage:
$ faxbot delivery providers trunk caller-check [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
show: Show your registered senders for received...set: Replace your registered senders for...
faxbot delivery providers trunk caller-check show¶
Show your registered senders for received faxes.
Usage:
$ faxbot delivery providers trunk caller-check show [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers trunk caller-check set¶
Replace your registered senders for received faxes: caller numbers a received fax's stamp checks.
Usage:
$ faxbot delivery providers trunk caller-check set [OPTIONS] [NUMBER]...
Arguments:
[NUMBER]...: Every registered sender, such as +13035550150; none clears the list.
Options:
--help: Show this message and exit.
faxbot delivery providers accounts¶
The provider accounts Faxbot sends and receives with, trunks included: add one, switch one off, or choose the defaults.
Usage:
$ faxbot delivery providers accounts [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List every provider account, what it does...show: Show one account: its settings, its...add: Add another provider account, such as a...update: Change an extra account.enable: Switch an account on.disable: Switch an account off.default-sending: Choose the account Faxbot sends by when no...default-receiving: Choose the account whose notifications...fax-application: Create the Fax Application a Telnyx Fax...health: Whether each account is ready, and what to...country-rules: Countries whose regulator licenses calls...
faxbot delivery providers accounts list¶
List every provider account, what it does and whether it is ready.
Usage:
$ faxbot delivery providers accounts list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers accounts show¶
Show one account: its settings, its numbers and the address to give your provider.
Usage:
$ faxbot delivery providers accounts show [OPTIONS] {KEY}
Arguments:
KEY: The account's key or name. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers accounts add¶
Add another provider account, such as a second Sinch account or a second trunk. Asks for its secrets.
Usage:
$ faxbot delivery providers accounts add [OPTIONS]
Options:
--provider <str>: The provider, such as sinch or sip for a trunk. [required]--key <str>: A short key for rules to name it, such as sinch-uk. [required]--label <str>: Its name, such as "Sinch (UK)".--site <str>: The site its calls start from (see faxbot delivery rules sites).--sends / --no-sends: Faxbot may send faxes by it. [default: sends]--receives / --no-receives: Faxbot receives faxes on it. On when the provider can receive.--number <str>: A fax number this account receives on (repeat it).--at-once <int range>: Faxes at once on this account, or lines at once on a trunk; 0 for no limit. [x>=0]--calls-per-second <int range>: Trunks: calls started each second; 0 for no limit. [x>=0]--daily-limit AMOUNT: Stop using this account for the day once it has cost this much; none for no limit.--setting NAME=VALUE: A provider setting that is not secret (repeat it). 'show' lists them.--secrets-from-stdin: Read secrets as NAME=VALUE lines from standard input instead of asking for each one.--help: Show this message and exit.
faxbot delivery providers accounts update¶
Change an extra account. The first account of a provider is changed on its own provider settings.
Usage:
$ faxbot delivery providers accounts update [OPTIONS] {KEY}
Arguments:
KEY: The account's key or name. [required]
Options:
--label <str>: A new name.--site <str>: The site its calls start from (see faxbot delivery rules sites).--no-site: Take it out of its site.--sends / --no-sends: Faxbot may send faxes by it.--receives / --no-receives: Faxbot receives faxes on it.--number <str>: Replace its fax numbers with these (repeat it).--at-once <int range>: Faxes at once on this account, or lines at once on a trunk; 0 for no limit. [x>=0]--calls-per-second <int range>: Trunks: calls started each second; 0 for no limit. [x>=0]--daily-limit AMOUNT: Stop using this account for the day once it has cost this much; none for no limit.--setting NAME=VALUE: A provider setting that is not secret (repeat it). 'show' lists them.--secret NAME: A secret to change; Faxbot asks for its new value.--secrets-from-stdin: Read secrets as NAME=VALUE lines from standard input instead of asking for each one.--help: Show this message and exit.
faxbot delivery providers accounts enable¶
Switch an account on. Faxbot uses it for new attempts at once.
Usage:
$ faxbot delivery providers accounts enable [OPTIONS] {KEY}
Arguments:
KEY: The account's key or name. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers accounts disable¶
Switch an account off. Waiting faxes go by other accounts their rules allow, or wait; none is sent twice.
Usage:
$ faxbot delivery providers accounts disable [OPTIONS] {KEY}
Arguments:
KEY: The account's key or name. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers accounts default-sending¶
Choose the account Faxbot sends by when no rule says otherwise.
Usage:
$ faxbot delivery providers accounts default-sending [OPTIONS] {KEY}
Arguments:
KEY: The account's key or name. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers accounts default-receiving¶
Choose the account whose notifications arrive at the provider's original address.
Usage:
$ faxbot delivery providers accounts default-receiving [OPTIONS] {KEY}
Arguments:
KEY: The account's key or name. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers accounts fax-application¶
Create the Fax Application a Telnyx Fax API account sends with, in your Telnyx account, and save its ID.
Usage:
$ faxbot delivery providers accounts fax-application [OPTIONS] [KEY]
Arguments:
KEY: The Telnyx Fax API account's key or name; the first one when left out. [default: telnyx_fax]
Options:
--name <str>: Its name in Telnyx, such as "Faxbot".--help: Show this message and exit.
faxbot delivery providers accounts health¶
Whether each account is ready, and what to do when it is not.
Usage:
$ faxbot delivery providers accounts health [OPTIONS] [KEY]
Arguments:
KEY: One account's key or name; all when left out.
Options:
--help: Show this message and exit.
faxbot delivery providers accounts country-rules¶
Countries whose regulator licenses calls over the internet (the UAE and Saudi Arabia), and whether each of your accounts there is confirmed. Faxes are never blocked for it.
Usage:
$ faxbot delivery providers accounts country-rules [OPTIONS]
Options:
--confirm ACCOUNT: Confirm that this account's provider meets the country's rules.--withdraw ACCOUNT: Withdraw that confirmation.--country AE|SA: The country.--evidence TEXT: How you know, such as the provider's licence or your contract.--help: Show this message and exit.
faxbot delivery providers digital¶
Direct messages and FHIR: the HISP account and FHIR clients Faxbot delivers faxes with instead of calling, when a recipient can take them.
Usage:
$ faxbot delivery providers digital [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the HISP account and FHIR clients and...show: Show one account: its settings, its plan...add: Add a HISP account or a FHIR client.update: Change an account's name, settings or...signing-key: Make a new signing key for a FHIR client.public-keys: Print a FHIR client's public key set, for...trust-bundle: Load the trust bundle your HISP belongs...
faxbot delivery providers digital list¶
List the HISP account and FHIR clients and whether each is ready.
Usage:
$ faxbot delivery providers digital list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers digital show¶
Show one account: its settings, its plan and what it still needs.
Usage:
$ faxbot delivery providers digital show [OPTIONS] {KEY}
Arguments:
KEY: The account's key or name. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers digital add¶
Add a HISP account or a FHIR client. Asks for the HISP password unless you give it another way.
Usage:
$ faxbot delivery providers digital add [OPTIONS]
Options:
--kind <str>: hisp for Direct messages, fhir for a FHIR client. [required]--key <str>: A short key, such as hisp or fhir-epic. [required]--label <str>: Its name, such as "Direct through Inpriva".--setting NAME=VALUE: A setting that is not secret (repeat it). 'show' lists them.--file NAME=PATH: Read a setting or secret from a file, such as certificate=cert.pem or private_key=key.pem.--secret NAME: A secret to enter; Faxbot asks for its value.--secrets-from-stdin: Read secrets as NAME=VALUE lines from standard input instead of asking for each one.--help: Show this message and exit.
faxbot delivery providers digital update¶
Change an account's name, settings or secrets, or turn it on or off.
Usage:
$ faxbot delivery providers digital update [OPTIONS] {KEY}
Arguments:
KEY: The account's key or name. [required]
Options:
--label <str>: A new name.--on / --off: Turn it on or off.--setting NAME=VALUE: A setting that is not secret (repeat it). 'show' lists them.--file NAME=PATH: Read a setting or secret from a file, such as certificate=cert.pem or private_key=key.pem.--secret NAME: A secret to enter; Faxbot asks for its value.--secrets-from-stdin: Read secrets as NAME=VALUE lines from standard input instead of asking for each one.--help: Show this message and exit.
faxbot delivery providers digital signing-key¶
Make a new signing key for a FHIR client. Register its public key set with the recipient's system.
Usage:
$ faxbot delivery providers digital signing-key [OPTIONS] {KEY}
Arguments:
KEY: The FHIR client's key or name. [required]
Options:
--algorithm <str>: RS384 (an RSA key) or ES384 (an elliptic-curve key).--help: Show this message and exit.
faxbot delivery providers digital public-keys¶
Print a FHIR client's public key set, for a recipient's system that asks for it pasted in.
Usage:
$ faxbot delivery providers digital public-keys [OPTIONS] {KEY}
Arguments:
KEY: The FHIR client's key or name. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers digital trust-bundle¶
Load the trust bundle your HISP belongs to, so Faxbot can check recipients' certificates.
Usage:
$ faxbot delivery providers digital trust-bundle [OPTIONS] {KEY}
Arguments:
KEY: The HISP account's key or name. [required]
Options:
--url <str>: The trust bundle's web address (https).--file <path>: A trust bundle file (.p7b or PEM).--help: Show this message and exit.
faxbot delivery providers destinations¶
Where Faxbot may dial: numbers in your country, other countries, and premium-rate, special-service and satellite numbers. Faxes to anything not allowed wait in Sent for your approval.
Usage:
$ faxbot delivery providers destinations [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: Show what Faxbot may dial and why.allow: Let Faxbot dial a class of numbers or a...block: Hold every fax to a class of numbers or a...reset: Put a class of numbers or a country back...
faxbot delivery providers destinations list¶
Show what Faxbot may dial and why.
Usage:
$ faxbot delivery providers destinations list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery providers destinations allow¶
Let Faxbot dial a class of numbers or a country without asking.
Usage:
$ faxbot delivery providers destinations allow [OPTIONS] {CLASS}
Arguments:
CLASS: What to allow: national, national-toll-free, national-mobile, premium, special-service, satellite, a two-letter country code such as GB, or a calling code such as +44. [required]
Options:
--ceiling PRICE: The highest price a minute a call may cost before the fax waits for your approval, such as 0.25; none removes it.--help: Show this message and exit.
faxbot delivery providers destinations block¶
Hold every fax to a class of numbers or a country in Sent for your approval.
Usage:
$ faxbot delivery providers destinations block [OPTIONS] {CLASS}
Arguments:
CLASS: What to block: national, national-toll-free, national-mobile, premium, special-service, satellite, a two-letter country code such as GB, or a calling code such as +44. [required]
Options:
--help: Show this message and exit.
faxbot delivery providers destinations reset¶
Put a class of numbers or a country back to Faxbot's own default.
Usage:
$ faxbot delivery providers destinations reset [OPTIONS] {CLASS}
Arguments:
CLASS: What to put back: national, national-toll-free, national-mobile, premium, special-service, satellite, a two-letter country code such as GB, or a calling code such as +44. [required]
Options:
--ceiling PRICE: A price ceiling a minute to keep, such as 0.25; none removes it.--help: Show this message and exit.
faxbot delivery rules¶
Sending rules: which provider account carries each fax, and limits every fax must meet. Changes go into a draft until you publish it.
Usage:
$ faxbot delivery rules [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the rules, as they read in your draft...show: Show the published rules, or an earlier...add: Add a rule to the draft.update: Change a rule in the draft.move: Move a rule.enable: Switch a rule on in the draft.disable: Switch a rule off in the draft, keeping it...remove: Remove a rule from the draft.check: Check the draft for problems, and see...publish: Put the draft into effect for new faxes.discard: Throw away the draft.history: List the published versions of the rules,...diff: Show what changed between two versions of...restore: Make an earlier version the draft, so you...explain: Which route a fax would take, and why.apply-to-waiting: Send faxes that are still waiting by the...export: Print the draft (or the published rules)...import: Replace the draft with rules from a JSON...lists: Recipient groups that rules can name, and...regions: Regions: named sets of countries and...sites: Sites: the places your organization sends...workflows: Workflows: named kinds of work, such as...court: The California court profile: faxes filed...
faxbot delivery rules list¶
List the rules, as they read in your draft when you have one.
Usage:
$ faxbot delivery rules list [OPTIONS]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules show¶
Show the published rules, or an earlier version of them.
Usage:
$ faxbot delivery rules show [OPTIONS]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--revision <int range>: An earlier version to show. [x>=1]--help: Show this message and exit.
faxbot delivery rules add¶
Add a rule to the draft. A rule that says how to send is a routing rule; any other rule is a limit.
Usage:
$ faxbot delivery rules add [OPTIONS] {name}
Arguments:
name: What the rule is for, in your words, such as "UK numbers go through Sinch". [required]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--when FIELD=VALUE: A condition, FIELD=VALUE; give several, and every one must match. Fields: to-number, to-list, to-prefix, to-country, to-region, to-recipient, partner, own-number, approved-alternate, in-site-country, from-person, from-key, from-group, from-mailbox, from-site, workflow, pages-over, pages-under, larger-than-mb, case-packet, urgent, real-call, label, days, between, site-time. Several values: to-country=GB,IE. Yes or no fields: partner=yes. days=mon-fri or weekends; between=18:00-07:00.--unless FIELD=VALUE: An exception, FIELD=VALUE, with the same fields as --when: the rule does not apply to a fax that matches every exception.--use ACCOUNT: Send by this account only.--try ACCOUNT: Try these accounts in the order given (repeat it).--cheapest ACCOUNT: Send by the cheapest reliable of these accounts (repeat it).--site-accounts SITE: Send by a site's accounts: sender for the sender's own site, or a site's key.--in-order: With --site-accounts: use the site's accounts in their listed order.--automatic: Let Faxbot choose the cheapest reliable route, as it does today.--never ACCOUNT: Never send by these accounts (repeat it).--require-direct: Send only by direct delivery to a verified partner.--require-encryption: Send only encrypted: direct delivery, or SSL Fax where the number has used it before. SSL Fax cannot confirm who answers at the other end.--cap AMOUNT: Use only routes that cost at most this much for the fax.--approval: Hold the fax until someone who may approve faxes approves it.--separate-approver: Hold the fax for approval by someone other than the sender.--send-days DAYS: Send the fax only on these days, such as mon-fri.--send-between HH:MM-HH:MM: Send the fax only between these times, such as 18:00-07:00.--real-call: Place a real call, even to your own numbers.--when-busy wait|next: When every line is busy: wait for a free line, or use the next account.--pages-per-sheet as-allowed|one: Pages per sheet: as many as the receiving machine allows, or one.--alternate use|never|only: Dial the recipient's approved alternate number: when there is one, never, or only (hold the fax when there is none).--subaddress DIGITS: The department or mailbox to ask for at the recipient's number (a subaddress, up to 20 digits). Their fax machine must take subaddresses. A setting of a rule that says how to send: add --automatic to keep the usual route.--mandatory / --not-mandatory: Organization rules only: mailbox and workflow rules cannot replace a mandatory routing rule, and no one can send a fax anyway around a mandatory limit.--before RULE: Put it before this rule.--off: Add it switched off.--help: Show this message and exit.
faxbot delivery rules update¶
Change a rule in the draft. --when replaces all its conditions, and any action option replaces all it does.
Usage:
$ faxbot delivery rules update [OPTIONS] {RULE}
Arguments:
RULE: The rule's id or name. [required]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--name <str>: A new name.--when FIELD=VALUE: A condition, FIELD=VALUE; give several, and every one must match. Fields: to-number, to-list, to-prefix, to-country, to-region, to-recipient, partner, own-number, approved-alternate, in-site-country, from-person, from-key, from-group, from-mailbox, from-site, workflow, pages-over, pages-under, larger-than-mb, case-packet, urgent, real-call, label, days, between, site-time. Several values: to-country=GB,IE. Yes or no fields: partner=yes. days=mon-fri or weekends; between=18:00-07:00.--unless FIELD=VALUE: An exception, FIELD=VALUE, with the same fields as --when: the rule does not apply to a fax that matches every exception.--no-unless: Remove the exceptions.--use ACCOUNT: Send by this account only.--try ACCOUNT: Try these accounts in the order given (repeat it).--cheapest ACCOUNT: Send by the cheapest reliable of these accounts (repeat it).--site-accounts SITE: Send by a site's accounts: sender for the sender's own site, or a site's key.--in-order: With --site-accounts: use the site's accounts in their listed order.--automatic: Let Faxbot choose the cheapest reliable route, as it does today.--never ACCOUNT: Never send by these accounts (repeat it).--require-direct: Send only by direct delivery to a verified partner.--require-encryption: Send only encrypted: direct delivery, or SSL Fax where the number has used it before. SSL Fax cannot confirm who answers at the other end.--cap AMOUNT: Use only routes that cost at most this much for the fax.--approval: Hold the fax until someone who may approve faxes approves it.--separate-approver: Hold the fax for approval by someone other than the sender.--send-days DAYS: Send the fax only on these days, such as mon-fri.--send-between HH:MM-HH:MM: Send the fax only between these times, such as 18:00-07:00.--real-call: Place a real call, even to your own numbers.--when-busy wait|next: When every line is busy: wait for a free line, or use the next account.--pages-per-sheet as-allowed|one: Pages per sheet: as many as the receiving machine allows, or one.--alternate use|never|only: Dial the recipient's approved alternate number: when there is one, never, or only (hold the fax when there is none).--subaddress DIGITS: The department or mailbox to ask for at the recipient's number (a subaddress, up to 20 digits). Their fax machine must take subaddresses. A setting of a rule that says how to send: add --automatic to keep the usual route.--mandatory / --not-mandatory: Organization rules only: mailbox and workflow rules cannot replace a mandatory routing rule, and no one can send a fax anyway around a mandatory limit.--help: Show this message and exit.
faxbot delivery rules move¶
Move a rule. Routing rules are read from the top, and the first that matches a fax chooses its route.
Usage:
$ faxbot delivery rules move [OPTIONS] {RULE}
Arguments:
RULE: The rule's id or name. [required]
Options:
--before RULE: Put it before this rule.--to-end: Put it last.--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules enable¶
Switch a rule on in the draft.
Usage:
$ faxbot delivery rules enable [OPTIONS] {RULE}
Arguments:
RULE: The rule's id or name. [required]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules disable¶
Switch a rule off in the draft, keeping it for later.
Usage:
$ faxbot delivery rules disable [OPTIONS] {RULE}
Arguments:
RULE: The rule's id or name. [required]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules remove¶
Remove a rule from the draft.
Usage:
$ faxbot delivery rules remove [OPTIONS] {RULE}
Arguments:
RULE: The rule's id or name. [required]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules check¶
Check the draft for problems, and see which recent faxes it would send differently.
Usage:
$ faxbot delivery rules check [OPTIONS]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--replay <int range>: How many recent faxes to try under the draft. [default: 200; 0<=x<=1000]--help: Show this message and exit.
faxbot delivery rules publish¶
Put the draft into effect for new faxes. Faxes already waiting keep the rules they were accepted under.
Usage:
$ faxbot delivery rules publish [OPTIONS]
Options:
--note <str>: What changed and why, for the history. [required]--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules discard¶
Throw away the draft. The published rules stay as they are.
Usage:
$ faxbot delivery rules discard [OPTIONS]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--yes: Do not ask first.--help: Show this message and exit.
faxbot delivery rules history¶
List the published versions of the rules, newest first.
Usage:
$ faxbot delivery rules history [OPTIONS]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules diff¶
Show what changed between two versions of the rules.
Usage:
$ faxbot delivery rules diff [OPTIONS] {A} {B}
Arguments:
A: The earlier version. [required]B: The later version. [required]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules restore¶
Make an earlier version the draft, so you can check and publish it again.
Usage:
$ faxbot delivery rules restore [OPTIONS] {N}
Arguments:
N: The version to start from. [required]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules explain¶
Which route a fax would take, and why. Nothing is sent and nothing is saved.
Usage:
$ faxbot delivery rules explain [OPTIONS]
Options:
--to NUMBER: The fax number to try. [required]--pages <int range>: Pages in the fax. [default: 1; 1<=x<=1000]--size-mb <float range>: The file size in megabytes. [x>=0]--as PERSON: Who sends it: a person or integration, or me (the default).--mailbox <str>: The mailbox it is sent from.--workflow KEY: The workflow it is part of.--urgent: The fax is marked urgent.--real-call: The sender asks for a real call.--label <str>: A label the sender puts on the fax.--at TIME: When it is sent, in this installation's time zone, such as 2026-10-07 18:30.--draft: Try the draft instead of the published rules.--revision <int range>: Try an earlier version. [x>=1]--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules apply-to-waiting¶
Send faxes that are still waiting by the current rules. Faxes already sent or being sent stay as they are.
Usage:
$ faxbot delivery rules apply-to-waiting [OPTIONS]
Options:
--yes: Do not ask first.--help: Show this message and exit.
faxbot delivery rules export¶
Print the draft (or the published rules) as JSON, to edit many rules at once.
Usage:
$ faxbot delivery rules export [OPTIONS]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--file <path>: Write to this file instead of the screen.--help: Show this message and exit.
faxbot delivery rules import¶
Replace the draft with rules from a JSON file. Nothing takes effect until you publish.
Usage:
$ faxbot delivery rules import [OPTIONS] {FILE}
Arguments:
FILE: A JSON file from 'export', or - for standard input. [required]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules lists¶
Recipient groups that rules can name, and the labels senders can put on a fax.
Usage:
$ faxbot delivery rules lists [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the recipient groups and the labels...set: Add a recipient group, or replace one.remove: Remove a recipient group.labels: Set the labels senders can put on a fax,...
faxbot delivery rules lists list¶
List the recipient groups and the labels senders can use.
Usage:
$ faxbot delivery rules lists list [OPTIONS]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules lists set¶
Add a recipient group, or replace one.
Usage:
$ faxbot delivery rules lists set [OPTIONS] {KEY}
Arguments:
KEY: A short key for the recipient group, such as uk-clinics. [required]
Options:
--name <str>: Its name, such as "UK clinics". [required]--number <str>: A fax number in the group (repeat it).--prefix <str>: Numbers starting with this, such as +4420 (repeat it).--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules lists remove¶
Remove a recipient group. Rules that name it must change first, or the check says so.
Usage:
$ faxbot delivery rules lists remove [OPTIONS] {KEY}
Arguments:
KEY: A short key for the recipient group, such as uk-clinics. [required]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules lists labels¶
Set the labels senders can put on a fax, such as legal or clinical.
Usage:
$ faxbot delivery rules lists labels [OPTIONS] [LABEL]
Arguments:
LABEL: Every label senders may choose; none removes them all.
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules regions¶
Regions: named sets of countries and number prefixes that rules can name.
Usage:
$ faxbot delivery rules regions [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the regions.set: Add a region, or replace one.remove: Remove a region.
faxbot delivery rules regions list¶
List the regions.
Usage:
$ faxbot delivery rules regions list [OPTIONS]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules regions set¶
Add a region, or replace one.
Usage:
$ faxbot delivery rules regions set [OPTIONS] {KEY}
Arguments:
KEY: A short key for the region, such as uk-clinics. [required]
Options:
--name <str>: Its name, such as "Northern England". [required]--country <str>: A country code, such as GB (repeat it).--prefix <str>: Numbers starting with this (repeat it).--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules regions remove¶
Remove a region.
Usage:
$ faxbot delivery rules regions remove [OPTIONS] {KEY}
Arguments:
KEY: A short key for the region, such as uk-clinics. [required]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules sites¶
Sites: the places your organization sends from, with their mailboxes and groups.
Usage:
$ faxbot delivery rules sites [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the sites, with their mailboxes,...set: Add a site, or replace one.remove: Remove a site.
faxbot delivery rules sites list¶
List the sites, with their mailboxes, groups and accounts.
Usage:
$ faxbot delivery rules sites list [OPTIONS]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules sites set¶
Add a site, or replace one. Give an account its site with 'faxbot delivery providers accounts update KEY --site'.
Usage:
$ faxbot delivery rules sites set [OPTIONS] {KEY}
Arguments:
KEY: A short key for the site, such as uk-clinics. [required]
Options:
--name <str>: Its name, such as "Leeds office". [required]--country <str>: Its country code, such as GB.--time-zone <str>: Its time zone, such as Europe/London.--mailbox <str>: A mailbox that sends from it (repeat it).--group <str>: A group that sends from it (repeat it).--account KEY: An account its calls start from (repeat it).--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules sites remove¶
Remove a site.
Usage:
$ faxbot delivery rules sites remove [OPTIONS] {KEY}
Arguments:
KEY: A short key for the site, such as uk-clinics. [required]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules workflows¶
Workflows: named kinds of work, such as referrals, that can have their own rules.
Usage:
$ faxbot delivery rules workflows [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the workflows.set: Add a workflow, or replace one.remove: Remove a workflow.
faxbot delivery rules workflows list¶
List the workflows.
Usage:
$ faxbot delivery rules workflows list [OPTIONS]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules workflows set¶
Add a workflow, or replace one. A workflow can then have its own rules: --scope workflow:KEY.
Usage:
$ faxbot delivery rules workflows set [OPTIONS] {KEY}
Arguments:
KEY: A short key for the workflow, such as uk-clinics. [required]
Options:
--name <str>: Its name, such as "Referrals". [required]--mailbox <str>: A mailbox whose faxes are part of it (repeat it).--label <str>: A label that puts a fax in it (repeat it).--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules workflows remove¶
Remove a workflow.
Usage:
$ faxbot delivery rules workflows remove [OPTIONS] {KEY}
Arguments:
KEY: A short key for the workflow, such as uk-clinics. [required]
Options:
--scope SCOPE: Whose rules: organization (the default), mailbox:NAME or workflow:KEY. [default: organization]--help: Show this message and exit.
faxbot delivery rules court¶
The California court profile: faxes filed with a court or served on a party go exactly as given, with the MC-005 cover sheet when filing, and keep their transmission record.
Usage:
$ faxbot delivery rules court [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
show: Show where the court profile applies, what...attach: Send every fax from a mailbox, or whose...detach: Stop sending a mailbox's faxes, or a...courts: List which California superior courts take...deadline: Extend a deadline that runs from service...record: Save a court fax's transmission record,...
faxbot delivery rules court show¶
Show where the court profile applies, what it does, and the rules and holidays it rests on.
Usage:
$ faxbot delivery rules court show [OPTIONS]
Options:
--help: Show this message and exit.
faxbot delivery rules court attach¶
Send every fax from a mailbox, or whose route a routing rule chooses, under the court profile. Their senders must then give the case details.
Usage:
$ faxbot delivery rules court attach [OPTIONS] {mailbox|rule} {name}
Arguments:
mailbox|rule: Attach it to a mailbox or a routing rule. [required]name: The mailbox or routing rule, by its name or ID. [required]
Options:
--help: Show this message and exit.
faxbot delivery rules court detach¶
Stop sending a mailbox's faxes, or a routing rule's, under the court profile.
Usage:
$ faxbot delivery rules court detach [OPTIONS] {mailbox|rule} {name}
Arguments:
mailbox|rule: A mailbox or a routing rule. [required]name: The mailbox or routing rule, by its name or ID. [required]
Options:
--help: Show this message and exit.
faxbot delivery rules court courts¶
List which California superior courts take direct fax filing, which stopped and which refuse it, each with its source.
Usage:
$ faxbot delivery rules court courts [OPTIONS]
Options:
--status accepts|stopped|does_not_accept: Only courts in this state.--help: Show this message and exit.
faxbot delivery rules court deadline¶
Extend a deadline that runs from service by fax by two court days (rule 2.306(d)), counting court holidays.
Usage:
$ faxbot delivery rules court deadline [OPTIONS] {DAY}
Arguments:
DAY: The deadline you worked out from a fax service date, such as 2026-11-20. [required]
Options:
--help: Show this message and exit.
faxbot delivery rules court record¶
Save a court fax's transmission record, with a draft proof of transmission or of service, as a PDF.
Usage:
$ faxbot delivery rules court record [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID of a court fax. [required]
Options:
-o, --output <str>: Save the PDF here; the default is transmission-record-<fax>.pdf.--help: Show this message and exit.
faxbot recipients¶
Fax numbers you send to: routing, batching several faxes into one call, and direct delivery partners.
Usage:
$ faxbot recipients [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the numbers you fax, with how faxes...show: Show one number you fax: its settings, how...set: Change a number's name, notes, preferred...limits: Show or set the highest speed and error...tuning: Show or set whether Faxbot makes pages...fax-machine: What a number's fax machine said on recent...schedule: Show or set when Faxbot sends to one...polling: Show or set whether Faxbot may collect...collect: Call another site's fax server once and...hold: Show or set whether another site's fax...hold-fax: Hold a document for another site to...held: List the faxes held for another site to...withdraw: Take a held fax back so the other site can...check: Before a first fax: check whether the NPI...register-sender: Send faxes to RECIPIENT only from the...registered-senders: Recipients that recognise your faxes by...unregister-sender: Stop pinning RECIPIENT to one trunk; faxes...iaf: Internet Aware Fax to fax servers that...together: Send short faxes to the same number...encoded: Encoded pages (experimental): allow...partners: Partners: other offices running Faxbot,...toll-free: A recipient's toll-free fax number, used...digital: A recipient's Direct address or FHIR...
faxbot recipients list¶
List the numbers you fax, with how faxes went and what they cost over the last 30 days.
Usage:
$ faxbot recipients list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot recipients show¶
Show one number you fax: its settings, how faxes to it went, and how Faxbot would send now.
Usage:
$ faxbot recipients show [OPTIONS] {number}
Arguments:
number: Fax number. [required]
Options:
--pages <int range>: Estimate the cost of a fax this many pages long. [default: 1; 1<=x<=1000]--help: Show this message and exit.
faxbot recipients set¶
Change a number's name, notes, preferred route, calls at once, case packets, pages per sheet, blank space, shading, keys to press after it answers, or how faxes sent together to it mark each document.
Usage:
$ faxbot recipients set [OPTIONS] {number}
Arguments:
number: Fax number. [required]
Options:
--name <str>: A name for this destination.--notes <str>: Notes for your team.--preferred-route <str>: Route to use first, as listed by 'faxbot recipients show'. Use 'automatic' for the cheapest reliable route.--calls-at-once N|default: Calls at once to this number: a number from 1 to 20, 0 for no limit, or 'default' for one at a time.--accepts-references / --no-references: Whether this recipient accepts case packets that reference documents they already received instead of resending them.--index-page: Faxes sent together to this number start with one index page listing each document's pages, instead of a separator page before each document. Records that the recipient agreed to it. Sending together must be on ('faxbot recipients together set').--page-headers: Faxes sent together to this number have a line at the top of every page naming its document and page, with no separator or index page. Records that the recipient agreed to it. Needs your header text and sending number (faxbot admin settings set fax_header=... fax_station_id=...).--separator-pages: Go back to a separator page before each document sent together to this number.--pages-per-sheet MACHINE|NEVER: Several pages on one long page: machine (as the receiving machine allows) or never.--blank-space ON|OFF|DEFAULT: Leave out the blank bottom of pages when this machine has no error correction: on, off, or default for the setting all faxes use.--shading ON|OFF|DEFAULT: Fax-friendly shading on documents sent to this recipient: on (always when it shortens the call), off (never), or default for the setting all faxes use.--needs-cover / --no-cover-needed: Whether this recipient needs a cover sheet: its faxes then keep their cover even when the sender sends the cover's notice in the header.--station-check WARN|REFUSE: When this number answers as another fax machine: warn (the fax goes on and Sent says so) or refuse (Faxbot hangs up before any page).--expected-station NUMBER: A fax number this recipient's machine shows, such as the one on its letterhead, so Faxbot expects it.--after-answer KEYS|none: Keys to press once this number answers, before the fax starts, for a fax machine behind a phone menu: such as 2, or 2w105 (w is a short pause, W a one-second pause). 'none' presses none. Only calls over your trunk can press keys, and the seconds in the menu are billed.--help: Show this message and exit.
faxbot recipients limits¶
Show or set the highest speed and error correction for one fax machine that keeps failing.
Usage:
$ faxbot recipients limits [OPTIONS] {number}
Arguments:
number: Fax number. [required]
Options:
--speed RATE: Highest speed for this number: 14400, 9600, 7200, 4800, or default for the setting all faxes use.--error-correction ON|OFF: Error correction for this number: on, off, or default.--help: Show this message and exit.
faxbot recipients tuning¶
Show or set whether Faxbot makes pages smaller for one number, without changing what it prints.
Usage:
$ faxbot recipients tuning [OPTIONS] {number}
Arguments:
number: Fax number. [required]
Options:
--smaller DEFAULT|OFF: Smaller pages for this number: default (as set for all faxes) or off.--smallest-format ON|OFF: Also send this number the smallest page format. Turn this on only if its fax machine prints faxes from Faxbot correctly.--help: Show this message and exit.
faxbot recipients fax-machine¶
What a number's fax machine said on recent calls, what Faxbot learned from them, and what it changes.
Usage:
$ faxbot recipients fax-machine [OPTIONS] {number}
Arguments:
number: A fax number you send to or receive from. [required]
Options:
--forget: Forget that fax over IP or audio fax failed with this number, so its next calls use the usual settings.--help: Show this message and exit.
faxbot recipients schedule¶
Show or set when Faxbot sends to one recipient: the hours it takes faxes, and the busy hours and call hours Faxbot learned.
Usage:
$ faxbot recipients schedule [OPTIONS] {number}
Arguments:
number: Fax number. [required]
Options:
--days DAYS: Days the recipient takes faxes, such as mon,tue,wed,thu,fri.--from HH:MM: Time the recipient starts taking faxes, such as 08:00.--until HH:MM: Time the recipient stops taking faxes, such as 18:00.--any-time: The recipient takes faxes at any time (clears the days and hours).--time-zone ZONE: The recipient's time zone, such as America/New_York, or default for your installation's.--learn / --no-learn: Whether Faxbot learns when this number is usually busy, slow or failing, and holds ordinary faxes for a better hour.--help: Show this message and exit.
faxbot recipients polling¶
Show or set whether Faxbot may collect faxes from another site's fax server by calling it, the password it sends, and a timetable for collecting by itself.
Usage:
$ faxbot recipients polling [OPTIONS] {number}
Arguments:
number: Fax number of the other site. [required]
Options:
--on / --off: Allow or stop collecting faxes from this number. Faxbot never collects by itself.--name NAME: A name for the other site, such as "Denver office".--selective-address DIGITS: The address the other fax server asks callers to give before it sends a held fax, if it asks for one.--password DIGITS: The polling password the other fax server asks for; kept sealed, never shown. Give "" to clear it.--collect-at TIMES: Times of day to collect by themselves, such as 08:00,16:00. Needs --collect-days.--collect-days DAYS: Days to collect by themselves, such as mon,tue,wed,thu,fri.--time-zone ZONE: The other site's time zone for the timetable, such as America/Denver.--no-timetable: Clear the timetable: Faxbot collects only when you ask.--help: Show this message and exit.
faxbot recipients collect¶
Call another site's fax server once and collect the fax it holds for you (it arrives in Received).
Usage:
$ faxbot recipients collect [OPTIONS] {number}
Arguments:
number: Fax number of the other site. [required]
Options:
--help: Show this message and exit.
faxbot recipients hold¶
Show or set whether another site's fax server may call Faxbot and collect the faxes held for it, and what it must give to get them.
Usage:
$ faxbot recipients hold [OPTIONS] {number}
Arguments:
number: Fax number of the other site. [required]
Options:
--on / --off: Allow or stop this number collecting faxes from Faxbot.--name NAME: A name for the other site, such as "Denver office".--selective-address DIGITS: The address the other site must give to get its faxes; leave empty for none.--password DIGITS: The polling password the other site must give; kept sealed, never shown. Give "" to clear it.--help: Show this message and exit.
faxbot recipients hold-fax¶
Hold a document for another site to collect: it goes out when that site calls Faxbot and asks for it.
Usage:
$ faxbot recipients hold-fax [OPTIONS] {number} {document}
Arguments:
number: Fax number of the other site. [required]document: The PDF or fax TIFF to hold for it. [required]
Options:
--help: Show this message and exit.
faxbot recipients held¶
List the faxes held for another site to collect, and what happened to each.
Usage:
$ faxbot recipients held [OPTIONS] {number}
Arguments:
number: Fax number of the other site. [required]
Options:
--help: Show this message and exit.
faxbot recipients withdraw¶
Take a held fax back so the other site can no longer collect it.
Usage:
$ faxbot recipients withdraw [OPTIONS] {number} {HELD-FAX}
Arguments:
number: Fax number of the other site. [required]HELD-FAX: The held fax, from 'faxbot recipients held'. [required]
Options:
--help: Show this message and exit.
faxbot recipients check¶
Before a first fax: check whether the NPI registry (NPPES) lists this number for the provider you name. It only warns; it never stops a fax.
Usage:
$ faxbot recipients check [OPTIONS] {number}
Arguments:
number: The fax number you are about to send to. [required]
Options:
--name <str>: The provider or person the fax is for.--help: Show this message and exit.
faxbot recipients register-sender¶
Send faxes to RECIPIENT only from the trunk, caller ID and station ID registered with it. When that trunk cannot send them, they wait in Sent; they never go from another number.
Usage:
$ faxbot recipients register-sender [OPTIONS] {RECIPIENT}
Arguments:
RECIPIENT: The recipient's fax number, such as +902122220000. [required]
Options:
--caller-id NUMBER: The caller ID registered with the recipient. [required]--station-id TEXT: The station ID registered with it, if it differs from the caller ID.--account KEY: The trunk registered with it, by its key from 'faxbot delivery providers accounts list'; the first trunk when left out. [default: sip]--note TEXT: Where it is registered, for the history.--help: Show this message and exit.
faxbot recipients registered-senders¶
Recipients that recognise your faxes by the number they come from, and the trunk registered with each.
Usage:
$ faxbot recipients registered-senders [OPTIONS]
Options:
--help: Show this message and exit.
faxbot recipients unregister-sender¶
Stop pinning RECIPIENT to one trunk; faxes to it go by your sending rules again. The history is kept.
Usage:
$ faxbot recipients unregister-sender [OPTIONS] {RECIPIENT}
Arguments:
RECIPIENT: The recipient's fax number. [required]
Options:
--note TEXT: Why, for the history.--help: Show this message and exit.
faxbot recipients iaf¶
Internet Aware Fax to fax servers that receive over the internet, such as another Faxbot or a Brooktrout SR140.
Usage:
$ faxbot recipients iaf [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the fax servers you approved for...add: Send faxes to and from a fax server as...remove: Stop Internet Aware Fax for a fax server:...
faxbot recipients iaf list¶
List the fax servers you approved for Internet Aware Fax, and partner offices marked for it.
Usage:
$ faxbot recipients iaf list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot recipients iaf add¶
Send faxes to and from a fax server as Internet Aware Fax. Never for a fax machine on a phone line.
Usage:
$ faxbot recipients iaf add [OPTIONS] {number}
Arguments:
number: The fax server's number. [required]
Options:
--kind <str>: faxbot (another Faxbot) or server (a fax server that takes Internet Aware Fax, such as an SR140). [required]--name <str>: A name you will recognise, such as "Head office SR140". [required]--help: Show this message and exit.
faxbot recipients iaf remove¶
Stop Internet Aware Fax for a fax server: its faxes go at fax line speed again.
Usage:
$ faxbot recipients iaf remove [OPTIONS] {number}
Arguments:
number: The approved number (or its ID, from --json). [required]
Options:
--help: Show this message and exit.
faxbot recipients together¶
Send short faxes to the same number together in one call, where the recipient agreed and it saves money.
Usage:
$ faxbot recipients together [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
show: Show whether faxes to a number go together...set: Turn sending together on for a number, or...check: Show whether a fax to this number would...off: Turn off batching for a number; faxes...
faxbot recipients together show¶
Show whether faxes to a number go together in one call, why that saves money or not, and what it saved.
Usage:
$ faxbot recipients together show [OPTIONS] {number}
Arguments:
number: Fax number. [required]
Options:
--help: Show this message and exit.
faxbot recipients together set¶
Turn sending together on for a number, or change how long faxes wait.
Usage:
$ faxbot recipients together set [OPTIONS] {number}
Arguments:
number: Fax number. [required]
Options:
--recipient-agreed: Record that this recipient has agreed to receive several documents in one call. Needed to turn sending together on.--wait MINUTES: Longest time a fax waits for others (default 10). [1<=x<=60]--max-pages <int range>: Most pages one call carries, separator pages included (default 30). [2<=x<=200]--mixed-senders / --same-sender-only: Whether faxes from different users or API keys may share one call (default: no).--help: Show this message and exit.
faxbot recipients together check¶
Show whether a fax to this number would wait to go with others, or go straight away.
Usage:
$ faxbot recipients together check [OPTIONS] {number}
Arguments:
number: Fax number. [required]
Options:
--help: Show this message and exit.
faxbot recipients together off¶
Turn off batching for a number; faxes waiting for it are sent straight away.
Usage:
$ faxbot recipients together off [OPTIONS] {number}
Arguments:
number: Fax number. [required]
Options:
--help: Show this message and exit.
faxbot recipients encoded¶
Encoded pages (experimental): allow recipient-approved documents that the recipient's Faxbot decodes. Faxbot compares each attempt's route.
Usage:
$ faxbot recipients encoded [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
show: Show whether faxes to a number may go as...set: Turn encoded pages on for a number, or...off: Turn encoded pages off for a number; its...
faxbot recipients encoded show¶
Show whether faxes to a number may go as encoded pages, and who recorded the recipient's agreement.
Usage:
$ faxbot recipients encoded show [OPTIONS] {number}
Arguments:
number: Fax number. [required]
Options:
--help: Show this message and exit.
faxbot recipients encoded set¶
Turn encoded pages on for a number, or change their style, error correction or shared key.
Usage:
$ faxbot recipients encoded set [OPTIONS] {number}
Arguments:
number: Fax number. [required]
Options:
--recipient-agreed: Record that this recipient agreed to receive encoded pages that their Faxbot decodes. Needed to turn encoded pages on.--style dense|picture: Dense pages (the default), or a picture of the first page with the document hidden in its dots. With a shared key the picture is a plain pattern instead.--error-correction low|medium|high: How much damage on the line the pages survive (default medium). Higher carries less.--shared-key KEY: Encrypt documents with a key you and the recipient agreed outside fax (8 to 200 characters). Only its fingerprint is shown afterwards.--decoder any|capacity: The recipient's decoder: any Faxbot decoder (the default), or capacity for a Faxbot decoder from October 2026 or later, so Faxbot may also send capacity pages.--clear-key: Stop encrypting with the shared key.--help: Show this message and exit.
faxbot recipients encoded off¶
Turn encoded pages off for a number; its faxes go as normal pages.
Usage:
$ faxbot recipients encoded off [OPTIONS] {number}
Arguments:
number: Fax number. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners¶
Partners: other offices running Faxbot, which get your faxes over the internet instead of a phone call.
Usage:
$ faxbot recipients partners [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
card: Show this installation's partner card.list: List your partners, or show one in full:...add: Add a partner from their card.challenge: Fax the partner a one-page code to enter...confirm: Enter the code from a partner's check fax...revoke: Remove a partner.fax-images: Accept faxes from a partner as the exact...tunnel-calls: Fax calls with a partner inside an...tunnel-check: Check now whether a fax to a partner would...deliveries: List recent faxes sent to and received...notice-fax: Send each document to a partner directly...notices: List notice faxes sent and received, and...notice-faxes: List the received faxes of one or two...pair: Pair a document a partner delivered...transfers: List documents sent to and received from...repairs: List fax calls with partners that broke...introduce: Introduce two of your partners to each other.may-introduce: Set whether a partner may be introduced to...relay: Partner relays: a partner office sends...send-once: Send once: a partner's intake files one...windows: Line windows and preflight with partners...discover: Recipients that run Faxbot, found from...publish: Publish your fax number in a directory you...
faxbot recipients partners card¶
Show this installation's partner card. Partners need it to add you for direct delivery.
Usage:
$ faxbot recipients partners card [OPTIONS]
Options:
-o, --output <str>: Save the card to this file.--help: Show this message and exit.
faxbot recipients partners list¶
List your partners, or show one in full: what it accepts from you and which encoded pages its Faxbot reads.
Usage:
$ faxbot recipients partners list [OPTIONS] [PARTNER]
Arguments:
[PARTNER]: Show one partner in full: its organization, fax number or id.
Options:
--help: Show this message and exit.
faxbot recipients partners add¶
Add a partner from their card. Then send them a check fax to confirm their number.
Usage:
$ faxbot recipients partners add [OPTIONS] {card_file}
Arguments:
card_file: The partner's card file, or '-' for standard input. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners challenge¶
Fax the partner a one-page code to enter in their Faxbot, which proves the number is theirs.
Usage:
$ faxbot recipients partners challenge [OPTIONS] {partner}
Arguments:
partner: Partner organization, fax number or id. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners confirm¶
Enter the code from a partner's check fax to prove this installation to them.
Usage:
$ faxbot recipients partners confirm [OPTIONS] {partner} {code}
Arguments:
partner: Partner organization, fax number or id. [required]code: The verification code printed on the partner's challenge fax. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners revoke¶
Remove a partner. Faxes to their number go by phone again.
Usage:
$ faxbot recipients partners revoke [OPTIONS] {partner}
Arguments:
partner: Partner organization, fax number or id. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners fax-images¶
Accept faxes from a partner as the exact fax image (on, the default) or only as original documents (off).
Usage:
$ faxbot recipients partners fax-images [OPTIONS] {partner} {on|off}
Arguments:
partner: Partner organization, fax number or id. [required]on|off: on (the default) accepts the partner's faxes as the exact fax image, filed like any received fax; off accepts only original documents. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners tunnel-calls¶
Fax calls with a partner inside an encrypted tunnel, with no carrier. You set up the WireGuard tunnel yourself, inside the fax engine's network; Faxbot only places and takes calls through it.
Usage:
$ faxbot recipients partners tunnel-calls [OPTIONS] {partner} {on|off}
Arguments:
partner: Partner organization, fax number or id. [required]on|off: on takes the partner's fax calls inside your encrypted tunnel; off stops taking them. [required]
Options:
--address ADDRESS: The partner's address inside the tunnel, such as 10.20.0.2 or 10.20.0.2:5070. Faxes to them go there when the tunnel is up.--check: Also check now whether a fax to them would go inside the tunnel.--help: Show this message and exit.
faxbot recipients partners tunnel-check¶
Check now whether a fax to a partner would go inside the encrypted tunnel, as the fax engine's network sees it. Places no call.
Usage:
$ faxbot recipients partners tunnel-check [OPTIONS] {partner}
Arguments:
partner: Partner organization, fax number or id. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners deliveries¶
List recent faxes sent to and received from partners over the internet.
Usage:
$ faxbot recipients partners deliveries [OPTIONS]
Options:
--help: Show this message and exit.
faxbot recipients partners notice-fax¶
Send each document to a partner directly with a one-page notice by fax (on), or with no fax (off).
Usage:
$ faxbot recipients partners notice-fax [OPTIONS] {partner} {on|off}
Arguments:
partner: Partner organization, fax number or ID. [required]on|off: on sends each document to the partner directly with a one-page notice by fax, for a fax intake that needs a fax event; off (the default) sends documents directly with no fax. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners notices¶
List notice faxes sent and received, and whether each was paired with its document.
Usage:
$ faxbot recipients partners notices [OPTIONS]
Options:
--ids: Also show the ID to pair a notice with.--help: Show this message and exit.
faxbot recipients partners notice-faxes¶
List the received faxes of one or two pages that may be a held document's notice page, newest first.
Usage:
$ faxbot recipients partners notice-faxes [OPTIONS] {notice}
Arguments:
notice: The notice's ID, from 'faxbot recipients partners notices --ids'. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners pair¶
Pair a document a partner delivered directly with its notice fax, or file it without one.
Usage:
$ faxbot recipients partners pair [OPTIONS] {notice}
Arguments:
notice: The notice's ID, from 'faxbot recipients partners notices --ids'. [required]
Options:
--code <str>: The 20-digit code printed on the notice page.--fax <str>: The received fax that is the notice, from 'faxbot faxes received list --ids'.--without-notice: File the document in Received without its notice fax.--help: Show this message and exit.
faxbot recipients partners transfers¶
List documents sent to and received from partners in pieces, and how many pieces each side holds.
Usage:
$ faxbot recipients partners transfers [OPTIONS]
Options:
--help: Show this message and exit.
faxbot recipients partners repairs¶
List fax calls with partners that broke part way, and how each was completed directly.
Usage:
$ faxbot recipients partners repairs [OPTIONS]
Options:
--help: Show this message and exit.
faxbot recipients partners introduce¶
Introduce two of your partners to each other. Both must have agreed to be introduced.
Usage:
$ faxbot recipients partners introduce [OPTIONS] {first} {second}
Arguments:
first: A partner: organization, fax number or id. [required]second: The partner to introduce them to. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners may-introduce¶
Set whether a partner may be introduced to your other partners (off by default).
Usage:
$ faxbot recipients partners may-introduce [OPTIONS] {partner} {on|off}
Arguments:
partner: Partner organization, fax number or id. [required]on|off: on once the partner agreed to be introduced to your other partners; off (the default) never introduces them. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners relay¶
Partner relays: a partner office sends your faxes to its own country as local calls, or you send theirs.
Usage:
$ faxbot recipients partners relay [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List relay agreements both ways: partners...show: Show the relay agreements with one...offer: Offer to send a partner's faxes as local...accept: Accept a partner's offer to send your...withdraw: End a relay agreement with a partner at once.price: Give a partner you relay for new prices...quote: Ask a partner what sending your faxes...costs: Show what relays carried and cost: faxes...suggestions: Show partners whose local price would have...faxes: List faxes relayed for partners and faxes...
faxbot recipients partners relay list¶
List relay agreements both ways: partners who send your faxes, and partners whose faxes you send.
Usage:
$ faxbot recipients partners relay list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot recipients partners relay show¶
Show the relay agreements with one partner, their limits, prices and what each side should know.
Usage:
$ faxbot recipients partners relay show [OPTIONS] {partner}
Arguments:
partner: Partner organization, fax number or id. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners relay offer¶
Offer to send a partner's faxes as local calls from here. They accept from their Faxbot.
Usage:
$ faxbot recipients partners relay offer [OPTIONS] {partner}
Arguments:
partner: Partner organization, fax number or id. [required]
Options:
--country <str>: A country they may send to through you, by its two-letter code (AU). Repeat for more.--region <str>: A region from your sending rules. Repeat for more.--pages <int range>: Most pages a month. Default: no limit. [x>=1]--spend <str>: Most money a month, such as '80 AUD'. Default: no limit.--hours <str>: Your hours for their faxes, such as 'mon-fri 08:00-18:00'. Default: any time.--together: Their faxes may share a call with other senders' faxes to the same number.--same-organization: They are an office of your own organization.--help: Show this message and exit.
faxbot recipients partners relay accept¶
Accept a partner's offer to send your faxes as local calls in their country.
Usage:
$ faxbot recipients partners relay accept [OPTIONS] {partner}
Arguments:
partner: Partner organization, fax number or id. [required]
Options:
--reply-number <str>: The number printed on your relayed faxes for replies. Default: your reply number.--together: Your faxes may share a call with other senders' faxes to the same number.--same-organization: They are an office of your own organization.--marketing-business-number <str>: For marketing faxes: your business number (such as an ABN), printed on the first page.--marketing-contact <str>: For marketing faxes: how to contact you.--marketing-opt-out <str>: For marketing faxes: where recipients ask to stop.--help: Show this message and exit.
faxbot recipients partners relay withdraw¶
End a relay agreement with a partner at once. Faxes already accepted for relaying still go.
Usage:
$ faxbot recipients partners relay withdraw [OPTIONS] {partner}
Arguments:
partner: Partner organization, fax number or id. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners relay price¶
Give a partner you relay for new prices from your current rate cards.
Usage:
$ faxbot recipients partners relay price [OPTIONS] {partner}
Arguments:
partner: Partner organization, fax number or id. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners relay quote¶
Ask a partner what sending your faxes through them would cost. Nothing is relayed.
Usage:
$ faxbot recipients partners relay quote [OPTIONS] {partner}
Arguments:
partner: Partner organization, fax number or id. [required]
Options:
--country <str>: A country to price, by its two-letter code (AU). Repeat for more. [required]--help: Show this message and exit.
faxbot recipients partners relay costs¶
Show what relays carried and cost: faxes you relayed for partners, and faxes partners sent for you.
Usage:
$ faxbot recipients partners relay costs [OPTIONS]
Options:
--days <int range>: How many days back to count. [default: 30; 1<=x<=366]--help: Show this message and exit.
faxbot recipients partners relay suggestions¶
Show partners whose local price would have cost less than your own calls lately.
Usage:
$ faxbot recipients partners relay suggestions [OPTIONS]
Options:
--days <int range>: How many days back to count. [default: 30; 1<=x<=366]--help: Show this message and exit.
faxbot recipients partners relay faxes¶
List faxes relayed for partners and faxes partners relayed for you, newest first.
Usage:
$ faxbot recipients partners relay faxes [OPTIONS]
Options:
--days <int range>: How many days back to list. [default: 30; 1<=x<=366]--help: Show this message and exit.
faxbot recipients partners send-once¶
Send once: a partner's intake files one copy of a fax for each of its numbers, so the same document to several of them goes over the internet once.
Usage:
$ faxbot recipients partners send-once [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List send-once agreements both ways, and...offer: Let a partner send one copy to your...accept: Accept a partner's offer: your faxes to...end: End a send-once agreement with a partner...
faxbot recipients partners send-once list¶
List send-once agreements both ways, and the bytes partners did not need sent again in the last 30 days.
Usage:
$ faxbot recipients partners send-once list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot recipients partners send-once offer¶
Let a partner send one copy to your intake, which files it for each of these numbers by your receiving rules.
Usage:
$ faxbot recipients partners send-once offer [OPTIONS] {partner} {numbers}...
Arguments:
partner: Partner organization, fax number or ID. [required]numbers...: Your fax numbers that your intake files for, such as +15551234567 +15551234568. [required]
Options:
--intake <str>: The name of your intake, as the partner sees it. [default: Central intake]--help: Show this message and exit.
faxbot recipients partners send-once accept¶
Accept a partner's offer: your faxes to its numbers then go once to its intake, with no telephone call.
Usage:
$ faxbot recipients partners send-once accept [OPTIONS] {partner}
Arguments:
partner: Partner organization, fax number or ID. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners send-once end¶
End a send-once agreement with a partner at once; faxes to those numbers go by your usual routes again.
Usage:
$ faxbot recipients partners send-once end [OPTIONS] {partner}
Arguments:
partner: Partner organization, fax number or ID. [required]
Options:
--direction yours|theirs: Which agreement to end when there are both: 'yours' (their intake files your faxes) or 'theirs' (yours files theirs).--help: Show this message and exit.
faxbot recipients partners windows¶
Line windows and preflight with partners that take part: ask before paying to send by phone, and queue for a partner's limited lines instead of retrying into a busy one.
Usage:
$ faxbot recipients partners windows [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
show: Show your receiving settings and, for each...settings: Set what you offer partners that take...partner: Take part with a partner (on) or stop...
faxbot recipients partners windows show¶
Show your receiving settings and, for each partner, whether you take part, its windows and its answers.
Usage:
$ faxbot recipients partners windows show [OPTIONS] [PARTNER]
Arguments:
[PARTNER]: Show one partner only.
Options:
--help: Show this message and exit.
faxbot recipients partners windows settings¶
Set what you offer partners that take part: lines, the reserve for other callers, the window and the policy for urgent faxes and deadlines.
Usage:
$ faxbot recipients partners windows settings [OPTIONS]
Options:
--lines N|trunk: Lines you offer partners; trunk uses the trunk's lines less the reserve.--reserve <int range>: Lines kept for callers that don't take part. [0<=x<=500]--window MINUTES: How long a window stays open. [1<=x<=240]--urgent go|wait: go: urgent faxes start without a window; wait: they wait too.--deadline go|wait: go: a fax that would miss its send-by time starts without a window; wait: it still waits.--help: Show this message and exit.
faxbot recipients partners windows partner¶
Take part with a partner (on) or stop (off), and the document classes you refuse from it.
Usage:
$ faxbot recipients partners windows partner [OPTIONS] {partner} {on|off}
Arguments:
partner: Partner organization or id. [required]on|off: on: take part with this partner. [required]
Options:
--refuse CLASS: A document class you refuse from them; repeat it.--reason <str>: The reason they see for a refusal.--help: Show this message and exit.
faxbot recipients partners discover¶
Recipients that run Faxbot, found from your fax calls, introductions and directories you trust, and the settings for finding them.
Usage:
$ faxbot recipients partners discover [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List recipients that run Faxbot and could...lookup: Look a fax number up now in the...enroll: Add a suggested recipient as a partner.dismiss: Stop suggesting a recipient.settings: Show or change how Faxbot finds partners.
faxbot recipients partners discover list¶
List recipients that run Faxbot and could become partners, and the latest lookups.
Usage:
$ faxbot recipients partners discover list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot recipients partners discover lookup¶
Look a fax number up now in the directories you trust.
Usage:
$ faxbot recipients partners discover lookup [OPTIONS] {number}
Arguments:
number: Fax number to look up, with its country code. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners discover enroll¶
Add a suggested recipient as a partner. Then send them a code by fax to confirm their number.
Usage:
$ faxbot recipients partners discover enroll [OPTIONS] {suggestion}
Arguments:
suggestion: Suggested recipient: organization, fax number or id. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners discover dismiss¶
Stop suggesting a recipient.
Usage:
$ faxbot recipients partners discover dismiss [OPTIONS] {suggestion}
Arguments:
suggestion: Suggested recipient: organization, fax number or id. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners discover settings¶
Show or change how Faxbot finds partners.
Usage:
$ faxbot recipients partners discover settings [OPTIONS]
Options:
--answer-lookups on|off: Let Faxbots that fax you read your partner card (on by default).--from-calls on|off: Look up the other side of your fax calls when it shows it runs Faxbot (on by default).--directory DOMAIN: A directory you trust; repeat for several. Replaces the list.--no-directories: Trust no directory.--help: Show this message and exit.
faxbot recipients partners publish¶
Publish your fax number in a directory you control, so other Faxbots can find you.
Usage:
$ faxbot recipients partners publish [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the fax numbers you published, with...add: Make the signed record that publishes your...check: Check that a directory's DNS has the record.withdraw: Stop publishing a fax number.
faxbot recipients partners publish list¶
List the fax numbers you published, with the record each directory needs.
Usage:
$ faxbot recipients partners publish list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot recipients partners publish add¶
Make the signed record that publishes your fax number in a directory. Add it to that domain's DNS.
Usage:
$ faxbot recipients partners publish add [OPTIONS] {number}
Arguments:
number: Your fax number: the one on your partner card. [required]
Options:
--directory DOMAIN: The directory domain you control, such as faxdirectory.example.org. [required]--help: Show this message and exit.
faxbot recipients partners publish check¶
Check that a directory's DNS has the record.
Usage:
$ faxbot recipients partners publish check [OPTIONS] {publication}
Arguments:
publication: The directory, the fax number or the id. [required]
Options:
--help: Show this message and exit.
faxbot recipients partners publish withdraw¶
Stop publishing a fax number. Then delete its record from the directory's DNS.
Usage:
$ faxbot recipients partners publish withdraw [OPTIONS] {publication}
Arguments:
publication: The directory, the fax number or the id. [required]
Options:
--help: Show this message and exit.
faxbot recipients toll-free¶
A recipient's toll-free fax number, used only after you record who at the recipient agreed. The recipient pays for those calls.
Usage:
$ faxbot recipients toll-free [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
show: Show a recipient's toll-free fax number...note: Put a recipient's toll-free fax number on...approve: Record that the recipient agreed to faxes...withdraw: Withdraw a recipient's toll-free number;...lookup: Look up toll-free fax numbers the NPI...
faxbot recipients toll-free show¶
Show a recipient's toll-free fax number and every approval recorded for it.
Usage:
$ faxbot recipients toll-free show [OPTIONS] {number}
Arguments:
number: The recipient's own fax number. [required]
Options:
--help: Show this message and exit.
faxbot recipients toll-free note¶
Put a recipient's toll-free fax number on file without approving it; Faxbot does not use it yet.
Usage:
$ faxbot recipients toll-free note [OPTIONS] {number} {TOLL_FREE}
Arguments:
number: The recipient's own fax number. [required]TOLL_FREE: The toll-free fax number the recipient publishes. [required]
Options:
--help: Show this message and exit.
faxbot recipients toll-free approve¶
Record that the recipient agreed to faxes on its toll-free number: who, when and the evidence. The recipient pays for those calls.
Usage:
$ faxbot recipients toll-free approve [OPTIONS] {number} {TOLL_FREE}
Arguments:
number: The recipient's own fax number. [required]TOLL_FREE: The toll-free fax number the recipient approved. [required]
Options:
--by <str>: Who at the recipient agreed, for example "Dana, intake lead". [required]--on DATE: The day they agreed, as 2026-10-03. [required]--evidence <str>: Where the agreement is recorded, such as an email and its date. [required]--help: Show this message and exit.
faxbot recipients toll-free withdraw¶
Withdraw a recipient's toll-free number; Faxbot sends to its own number again. The history is kept.
Usage:
$ faxbot recipients toll-free withdraw [OPTIONS] {number}
Arguments:
number: The recipient's own fax number. [required]
Options:
--evidence <str>: Why, or where the withdrawal is recorded.--help: Show this message and exit.
faxbot recipients toll-free lookup¶
Look up toll-free fax numbers the NPI registry (NPPES) lists for a provider. It suggests only; nothing is approved.
Usage:
$ faxbot recipients toll-free lookup [OPTIONS] {number}
Arguments:
number: The recipient's own fax number. [required]
Options:
--npi <str>: The provider's ten-digit NPI.--name <str>: Or the organization name, with --city or --state.--city <str>: City, with --name.--state <str>: Two-letter state, with --name.--help: Show this message and exit.
faxbot recipients digital¶
A recipient's Direct address or FHIR endpoint: put one on file, confirm it, withdraw it, or look one up in the NPI registry.
Usage:
$ faxbot recipients digital [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
show: Show a recipient's Direct address and FHIR...add: Put a recipient's Direct address or FHIR...confirm: Confirm an address, so faxes to this...withdraw: Stop using a confirmed address; faxes go...dismiss: Dismiss a suggested address you do not want.nppes: Ask the NPI registry for this provider's...messages: List Direct messages and FHIR documents...
faxbot recipients digital show¶
Show a recipient's Direct address and FHIR endpoint, and whether Faxbot may use them.
Usage:
$ faxbot recipients digital show [OPTIONS] {NUMBER}
Arguments:
NUMBER: The fax number. [required]
Options:
--help: Show this message and exit.
faxbot recipients digital add¶
Put a recipient's Direct address or FHIR endpoint on file. Faxbot uses it only once confirmed.
Usage:
$ faxbot recipients digital add [OPTIONS] {NUMBER}
Arguments:
NUMBER: The fax number. [required]
Options:
--direct <str>: The recipient's Direct address.--fhir <str>: The recipient's FHIR server base address (https).--account <str>: The HISP account or FHIR client to use; the first one if left out.--organization <str>: Who it belongs to.--confirm: Confirm it now, so faxes may go this way.--note <str>: Where the recipient gave it, for the history.--help: Show this message and exit.
faxbot recipients digital confirm¶
Confirm an address, so faxes to this number may go that way when it is the better route.
Usage:
$ faxbot recipients digital confirm [OPTIONS] {NUMBER} {ADDRESS}
Arguments:
NUMBER: The fax number. [required]ADDRESS: The Direct address or FHIR address, as shown. [required]
Options:
--note <str>: Why, for the history.--help: Show this message and exit.
faxbot recipients digital withdraw¶
Stop using a confirmed address; faxes go by fax again.
Usage:
$ faxbot recipients digital withdraw [OPTIONS] {NUMBER} {ADDRESS}
Arguments:
NUMBER: The fax number. [required]ADDRESS: The Direct address or FHIR address, as shown. [required]
Options:
--note <str>: Why, for the history.--help: Show this message and exit.
faxbot recipients digital dismiss¶
Dismiss a suggested address you do not want.
Usage:
$ faxbot recipients digital dismiss [OPTIONS] {NUMBER} {ADDRESS}
Arguments:
NUMBER: The fax number. [required]ADDRESS: The Direct address or FHIR address, as shown. [required]
Options:
--note <str>: Why, for the history.--help: Show this message and exit.
faxbot recipients digital nppes¶
Ask the NPI registry for this provider's Direct address and FHIR endpoint, as suggestions to check.
Usage:
$ faxbot recipients digital nppes [OPTIONS] {NUMBER}
Arguments:
NUMBER: The fax number. [required]
Options:
--npi <str>: The recipient's ten-digit NPI. [required]--help: Show this message and exit.
faxbot recipients digital messages¶
List Direct messages and FHIR documents sent and received, newest first, with what happened to each.
Usage:
$ faxbot recipients digital messages [OPTIONS]
Options:
--received: Show messages received.--sent: Show messages sent.--limit <int range>: How many to show. [default: 50; 1<=x<=200]--fax FAX_ID: Show only the messages one sent fax went as.--help: Show this message and exit.
faxbot admin¶
Look after the installation: people and access, setup, settings, checks, logs, the security log, backups and restarts.
Usage:
$ faxbot admin [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
health: Check that Faxbot answers and is ready to...audit: Show the security log of access changes...restart: Restart Faxbot, when the installation...status: Show whether the database is up to date,...migrate: Update the database after you install a...recover-owner: Recover owner access when no owner can...backup: Copy everything Faxbot needs to a new...restore: Restore a backup after checking every file...access: Who can use Faxbot and what each person...setup: Suggested packs of rules and settings from...settings: Every Faxbot setting: show, change, check...analysis: AI analysis: configure a model, test the...npi: Your NPI numbers, so Faxbot can tell you...diagnostics: Check the installation without sending a fax.logs: The activity log: sign-ins, faxes, phone...codec: Encode a document as payload pages, or...profiles: Server addresses and keys saved on this...
faxbot admin health¶
Check that Faxbot answers and is ready to send and receive faxes, for whichever of those it is set up to do. No key is needed. For scripts, the command ends with exit code 1 when Faxbot is not ready for them.
Usage:
$ faxbot admin health [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin audit¶
Show the security log of access changes and sign-ins, newest first.
Usage:
$ faxbot admin audit [OPTIONS]
Options:
--limit <int range>: How many entries to show. [default: 50; x>=1]--who <str>: Only actions by this user or integration.--operation <str>: Only this kind of action, for example create_user.--ids: Also show internal ids.--help: Show this message and exit.
faxbot admin restart¶
Restart Faxbot, when the installation allows it.
Usage:
$ faxbot admin restart [OPTIONS]
Options:
-y, --yes: Do not ask for confirmation.--help: Show this message and exit.
faxbot admin status¶
Show whether the database is up to date, whether settings are saved, and how many records there are.
Usage:
$ faxbot admin status [OPTIONS]
Options:
--database-url URL: Where the database is, if not the usual place (./faxbot.db, as the server uses). [env var: DATABASE_URL]--data-dir FOLDER: Where the data folder is, if not the usual place (./faxdata, as the server uses). [env var: FAX_DATA_DIR]--key-file FILE: Installation encryption key file (default: .configuration.key in the data folder). [env var: FAXBOT_INSTALLATION_KEY_PATH]--direct-key-file FILE: Direct delivery signing key file (default: .direct-identity.key in the data folder). [env var: FAXBOT_DIRECT_KEY_PATH]--help: Show this message and exit.
faxbot admin migrate¶
Update the database after you install a new version of Faxbot.
Usage:
$ faxbot admin migrate [OPTIONS]
Options:
--database-url URL: Where the database is, if not the usual place (./faxbot.db, as the server uses). [env var: DATABASE_URL]--data-dir FOLDER: Where the data folder is, if not the usual place (./faxdata, as the server uses). [env var: FAX_DATA_DIR]--key-file FILE: Installation encryption key file (default: .configuration.key in the data folder). [env var: FAXBOT_INSTALLATION_KEY_PATH]--direct-key-file FILE: Direct delivery signing key file (default: .direct-identity.key in the data folder). [env var: FAXBOT_DIRECT_KEY_PATH]--help: Show this message and exit.
faxbot admin recover-owner¶
Recover owner access when no owner can sign in: create a new installation key and show it once.
Run it while Faxbot is stopped. Anything that used the old installation key stops working. Then start Faxbot and create an owner with faxbot admin access owner enroll.
Usage:
$ faxbot admin recover-owner [OPTIONS]
Options:
-y, --yes: Do not ask for confirmation.--database-url URL: Where the database is, if not the usual place (./faxbot.db, as the server uses). [env var: DATABASE_URL]--data-dir FOLDER: Where the data folder is, if not the usual place (./faxdata, as the server uses). [env var: FAX_DATA_DIR]--key-file FILE: Installation encryption key file (default: .configuration.key in the data folder). [env var: FAXBOT_INSTALLATION_KEY_PATH]--direct-key-file FILE: Direct delivery signing key file (default: .direct-identity.key in the data folder). [env var: FAXBOT_DIRECT_KEY_PATH]--help: Show this message and exit.
faxbot admin backup¶
Copy everything Faxbot needs to a new folder: the database, the data folder and the installation keys, with checksums to check them later.
The copy holds private keys and fax documents, so keep it as safe as the installation itself.
Usage:
$ faxbot admin backup [OPTIONS] {folder}
Arguments:
folder: New, empty folder for the backup. [required]
Options:
--database-url URL: Where the database is, if not the usual place (./faxbot.db, as the server uses). [env var: DATABASE_URL]--data-dir FOLDER: Where the data folder is, if not the usual place (./faxdata, as the server uses). [env var: FAX_DATA_DIR]--key-file FILE: Installation encryption key file (default: .configuration.key in the data folder). [env var: FAXBOT_INSTALLATION_KEY_PATH]--direct-key-file FILE: Direct delivery signing key file (default: .direct-identity.key in the data folder). [env var: FAXBOT_DIRECT_KEY_PATH]--help: Show this message and exit.
faxbot admin restore¶
Restore a backup after checking every file in it.
Usage:
$ faxbot admin restore [OPTIONS] {folder}
Arguments:
folder: Backup folder made by faxbot admin backup. [required]
Options:
--force: Replace the database, data folder and keys already on this computer.--database-url URL: Where the database is, if not the usual place (./faxbot.db, as the server uses). [env var: DATABASE_URL]--data-dir FOLDER: Where the data folder is, if not the usual place (./faxdata, as the server uses). [env var: FAX_DATA_DIR]--key-file FILE: Installation encryption key file (default: .configuration.key in the data folder). [env var: FAXBOT_INSTALLATION_KEY_PATH]--direct-key-file FILE: Direct delivery signing key file (default: .direct-identity.key in the data folder). [env var: FAXBOT_DIRECT_KEY_PATH]--help: Show this message and exit.
faxbot admin access¶
Who can use Faxbot and what each person may do: people, groups, roles, keys, sign-ins and paired phones.
Usage:
$ faxbot admin access [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
me: Show who your key belongs to and what it...users: People who sign in to Faxbot, and the apps...integrations: Apps and devices, such as scanners, that...groups: Groups of people who share the same access.roles: Roles: named sets of permissions, such as...grants: Who has which role, and for which...keys: Keys that let apps, scripts, scanners and...sessions: People signed in to the console in a browser.pair: Pair the Faxbot iPhone app with this...resources: The places a role can apply to: the whole...owner: Create an owner, who can do everything in...
faxbot admin access me¶
Show who your key belongs to and what it may do.
Usage:
$ faxbot admin access me [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin access users¶
People who sign in to Faxbot, and the apps and devices that use their own key.
Usage:
$ faxbot admin access users [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List people and apps.show: Show a person or app with their groups,...add: Add a user.update: Change a person's or app's name, sign-in...reset-password: Give a user a new temporary password,...
faxbot admin access users list¶
List people and apps.
Usage:
$ faxbot admin access users list [OPTIONS]
Options:
--kind <str>: user, integration or all. [default: all]--search <str>: Only users whose name or sign-in name contains this text.--limit <int range>: Show at most this many. [x>=1]--ids: Also show internal ids.--help: Show this message and exit.
faxbot admin access users show¶
Show a person or app with their groups, roles, keys and what they may do.
Usage:
$ faxbot admin access users show [OPTIONS] {who}
Arguments:
who: Sign-in name, display name or id. [required]
Options:
--ids: Also show internal ids.--help: Show this message and exit.
faxbot admin access users add¶
Add a user. Their temporary password is shown once.
Usage:
$ faxbot admin access users add [OPTIONS] {login}
Arguments:
login: Sign-in name. [required]
Options:
--name <str>: Display name. [required]--disabled: Add the person without letting them sign in yet.--help: Show this message and exit.
faxbot admin access users update¶
Change a person's or app's name, sign-in name, or whether they can use Faxbot.
Usage:
$ faxbot admin access users update [OPTIONS] {who}
Arguments:
who: Sign-in name, display name or id. [required]
Options:
--name <str>: New display name.--login <str>: New sign-in name (users only).--enable: Switch on.--disable: Disable the user. This ends their sessions and stops their keys.--help: Show this message and exit.
faxbot admin access users reset-password¶
Give a user a new temporary password, shown once. Their sessions end.
Usage:
$ faxbot admin access users reset-password [OPTIONS] {who}
Arguments:
who: Sign-in name, display name or id. [required]
Options:
--help: Show this message and exit.
faxbot admin access integrations¶
Apps and devices, such as scanners, that use Faxbot with their own key.
Usage:
$ faxbot admin access integrations [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
add: Add an app or device, such as a scanner,...list: List the apps and devices, such as...
faxbot admin access integrations add¶
Add an app or device, such as a scanner, that uses Faxbot with its own key. Next give it a role, then create its key.
Usage:
$ faxbot admin access integrations add [OPTIONS] {name}
Arguments:
name: Name, for example "Front desk scanner". [required]
Options:
--disabled: Create the group disabled, so its roles do not apply yet.--help: Show this message and exit.
faxbot admin access integrations list¶
List the apps and devices, such as scanners, that use Faxbot with their own key.
Usage:
$ faxbot admin access integrations list [OPTIONS]
Options:
--ids: Also show internal ids.--help: Show this message and exit.
faxbot admin access groups¶
Groups of people who share the same access.
Usage:
$ faxbot admin access groups [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List groups.show: Show a group with its members and roles.add: Add a group.update: Rename a group, change its description or...members: Add people to a group or remove them.
faxbot admin access groups list¶
List groups.
Usage:
$ faxbot admin access groups list [OPTIONS]
Options:
--ids: Also show internal ids.--help: Show this message and exit.
faxbot admin access groups show¶
Show a group with its members and roles.
Usage:
$ faxbot admin access groups show [OPTIONS] {name}
Arguments:
name: Group name or id. [required]
Options:
--ids: Also show internal ids.--help: Show this message and exit.
faxbot admin access groups add¶
Add a group.
Usage:
$ faxbot admin access groups add [OPTIONS] {name}
Arguments:
name: Group name. [required]
Options:
--description <str>: What the group is for.--disabled: Create the group disabled, so its roles do not apply yet.--help: Show this message and exit.
faxbot admin access groups update¶
Rename a group, change its description or switch it on or off.
Usage:
$ faxbot admin access groups update [OPTIONS] {name}
Arguments:
name: Group name or id. [required]
Options:
--name <str>: New name.--description <str>: New description.--enable: Switch on.--disable: Disable the group; members lose its roles.--help: Show this message and exit.
faxbot admin access groups members¶
Add people to a group or remove them.
Usage:
$ faxbot admin access groups members [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
add: Add a person or app to a group.remove: Remove a user or integration from a group.
faxbot admin access groups members add¶
Add a person or app to a group.
Usage:
$ faxbot admin access groups members add [OPTIONS] {group} {who}
Arguments:
group: Group name or id. [required]who: Sign-in name, display name or id of the user or integration. [required]
Options:
--help: Show this message and exit.
faxbot admin access groups members remove¶
Remove a user or integration from a group.
Usage:
$ faxbot admin access groups members remove [OPTIONS] {group} {who}
Arguments:
group: Group name or id. [required]who: Sign-in name, display name or id. [required]
Options:
--help: Show this message and exit.
faxbot admin access roles¶
Roles: named sets of permissions, such as Fax operator, that you give to people.
Usage:
$ faxbot admin access roles [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List roles.show: Show a role and its permissions.permissions: List everything a role can allow.add: Add a role of your own, choosing what it...update: Change a custom role.
faxbot admin access roles list¶
List roles.
Usage:
$ faxbot admin access roles list [OPTIONS]
Options:
--ids: Also show internal ids.--help: Show this message and exit.
faxbot admin access roles show¶
Show a role and its permissions.
Usage:
$ faxbot admin access roles show [OPTIONS] {name}
Arguments:
name: Role name or id. [required]
Options:
--ids: Also show internal ids.--help: Show this message and exit.
faxbot admin access roles permissions¶
List everything a role can allow.
Usage:
$ faxbot admin access roles permissions [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin access roles add¶
Add a role of your own, choosing what it allows. See faxbot admin access roles permissions for the choices.
Usage:
$ faxbot admin access roles add [OPTIONS] {name}
Arguments:
name: Role name. [required]
Options:
-p, --permission <str>: A permission, for example fax:send. Repeat for more.--description <str>: What the role is for.--disabled: Create the group disabled, so its roles do not apply yet.--help: Show this message and exit.
faxbot admin access roles update¶
Change a custom role. Built-in roles cannot be changed.
Usage:
$ faxbot admin access roles update [OPTIONS] {name}
Arguments:
name: Role name or id. [required]
Options:
--name <str>: New name.--description <str>: New description.-p, --permission <str>: Replace all permissions with these. Repeat for more.--add <str>: Add this permission. Repeat for more.--remove <str>: Remove this permission. Repeat for more.--enable: Switch on.--disable: Disable the role everywhere it is assigned.--help: Show this message and exit.
faxbot admin access grants¶
Who has which role, and for which mailboxes or faxes.
Usage:
$ faxbot admin access grants [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List who has which role, and where.add: Give a person, app or group a role.remove: Take a role away from a user, integration...
faxbot admin access grants list¶
List who has which role, and where.
Usage:
$ faxbot admin access grants list [OPTIONS]
Options:
--who <str>: Only grants for this user, integration or group.--on <str>: Only grants on this resource, such as installation or mailbox:NAME.--ids: Also show internal ids.--help: Show this message and exit.
faxbot admin access grants add¶
Give a person, app or group a role.
Usage:
$ faxbot admin access grants add [OPTIONS] {who} {role}
Arguments:
who: User, integration or group. Prefix with group: or user: if names overlap. [required]role: Role name, for example "Fax operator". [required]
Options:
--on <str>: Where the role applies: installation (the default), mailbox:NAME, personal:USER, unassigned, or a resource from faxbot admin access resources list. [default: installation]--help: Show this message and exit.
faxbot admin access grants remove¶
Take a role away from a user, integration or group.
Usage:
$ faxbot admin access grants remove [OPTIONS] {who} {role}
Arguments:
who: User, integration or group. [required]role: Role name. [required]
Options:
--on <str>: Where the role applies: installation (the default), mailbox:NAME, personal:USER, unassigned, or a resource from faxbot admin access resources list. [default: installation]--help: Show this message and exit.
faxbot admin access keys¶
Keys that let apps, scripts, scanners and phones use Faxbot without a password.
Usage:
$ faxbot admin access keys [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List keys and who they belong to.create: Create a key.rotate: Replace a key with a new one.revoke: Revoke a key permanently.approve: Approve an older key that is waiting for...update: Change a key's name, note or expiry date.
faxbot admin access keys list¶
List keys and who they belong to. A key itself is shown only once, when it is created.
Usage:
$ faxbot admin access keys list [OPTIONS]
Options:
--for <str>: Only keys of this user or integration.--help: Show this message and exit.
faxbot admin access keys create¶
Create a key. It is shown once, so store it straight away.
Usage:
$ faxbot admin access keys create [OPTIONS]
Options:
-p, --permission <str>: What the key may do, for example fax:send. Repeat for more. [required]--for <str>: User or integration the key belongs to. Default: you.--on <str>: Where the role applies: installation (the default), mailbox:NAME, personal:USER, unassigned, or a resource from faxbot admin access resources list. [default: installation]--name <str>: A name to recognise the key by.--note <str>: A note about where the key is used.--expires <str>: Expiry date, for example 2027-01-31.--help: Show this message and exit.
faxbot admin access keys rotate¶
Replace a key with a new one. The old one stops working at once; the new one is shown once.
Usage:
$ faxbot admin access keys rotate [OPTIONS] {key_id}
Arguments:
key_id: Key ID or key name. [required]
Options:
--help: Show this message and exit.
faxbot admin access keys revoke¶
Revoke a key permanently.
Usage:
$ faxbot admin access keys revoke [OPTIONS] {key_id}
Arguments:
key_id: Key ID or key name. [required]
Options:
--help: Show this message and exit.
faxbot admin access keys approve¶
Approve an older key that is waiting for review: choose whose it is and what it may do.
Usage:
$ faxbot admin access keys approve [OPTIONS] {key_id}
Arguments:
key_id: Key ID of a key that needs review. [required]
Options:
--for <str>: User or integration the key will belong to. [required]-p, --permission <str>: A permission for the key, for example fax:send. Repeat for more. [required]--on <str>: Where the role applies: installation (the default), mailbox:NAME, personal:USER, unassigned, or a resource from faxbot admin access resources list. [default: installation]--help: Show this message and exit.
faxbot admin access keys update¶
Change a key's name, note or expiry date.
Usage:
$ faxbot admin access keys update [OPTIONS] {key_id}
Arguments:
key_id: Key ID or key name. [required]
Options:
--name <str>: New name.--note <str>: New note.--expires <str>: New expiry date.--no-expiry: Remove the expiry date.--help: Show this message and exit.
faxbot admin access sessions¶
People signed in to the console in a browser.
Usage:
$ faxbot admin access sessions [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List people signed in to the console.revoke: End a session.
faxbot admin access sessions list¶
List people signed in to the console.
Usage:
$ faxbot admin access sessions list [OPTIONS]
Options:
--for <str>: Another user's sessions. Default: yours.--ids: Also show internal ids.--help: Show this message and exit.
faxbot admin access sessions revoke¶
End a session.
Usage:
$ faxbot admin access sessions revoke [OPTIONS] {session_id}
Arguments:
session_id: Session id from 'faxbot admin access sessions list --ids'. [required]
Options:
--help: Show this message and exit.
faxbot admin access pair¶
Pair the Faxbot iPhone app with this installation.
Usage:
$ faxbot admin access pair [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
new: Create a six-digit pairing code for one...device: Test pairing as if this computer were a...
faxbot admin access pair new¶
Create a six-digit pairing code for one phone. It works once, within five minutes.
Usage:
$ faxbot admin access pair new [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin access pair device¶
Test pairing as if this computer were a phone: exchange a pairing code for the device's own API key.
Usage:
$ faxbot admin access pair device [OPTIONS] {code}
Arguments:
code: The six-digit pairing code. [required]
Options:
--device-name <str>: Device name shown on the new key. [default: Command line]--save-profile NAME: Save the new key in this profile instead of printing it.--help: Show this message and exit.
faxbot admin access resources¶
The places a role can apply to: the whole installation, a mailbox or a person's own faxes.
Usage:
$ faxbot admin access resources [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the places a role can apply to.
faxbot admin access resources list¶
List the places a role can apply to.
Usage:
$ faxbot admin access resources list [OPTIONS]
Options:
--kind <str>: Resource type: installation, legacy, mailbox or personal.--ids: Also show internal ids.--help: Show this message and exit.
faxbot admin access owner¶
Create an owner, who can do everything in Faxbot, using the installation key.
Usage:
$ faxbot admin access owner [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
enroll: Create a named owner, with full control,...
faxbot admin access owner enroll¶
Create a named owner, with full control, and a temporary password shown once.
Use the installation key or an existing owner's API key. This works for the first owner, and to regain access after faxbot admin recover-owner.
Usage:
$ faxbot admin access owner enroll [OPTIONS]
Options:
--login <str>: Sign-in name for the new owner. [required]--name <str>: The owner's display name. [required]--help: Show this message and exit.
faxbot admin setup¶
Suggested packs of rules and settings from what Faxbot already knows: preview a plan, see it, and apply it in one step.
Usage:
$ faxbot admin setup [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
plan: Preview a plan from what Faxbot already...list: List saved setup plans so you can inspect...show: Show a plan: its suggestions, what's...apply: Apply a plan's chosen suggestions in one...
faxbot admin setup plan¶
Preview a plan from what Faxbot already knows. Changes nothing and sends nothing.
Usage:
$ faxbot admin setup plan [OPTIONS]
Options:
--name <str>: Your business name, printed at the top of each page.--country <str>: The country your organization works in, such as US or GB. Leave out if you are not sure.--mailbox-country <str>: A mailbox and the country it works in, as 'NAME=COUNTRY'. Repeat for each mailbox.--help: Show this message and exit.
faxbot admin setup list¶
List saved setup plans so you can inspect an earlier plan with show.
Usage:
$ faxbot admin setup list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin setup show¶
Show a plan: its suggestions, what's missing and each mailbox's settings.
Usage:
$ faxbot admin setup show [OPTIONS] [number]
Arguments:
number: The plan number. Default: the newest plan.
Options:
--help: Show this message and exit.
faxbot admin setup apply¶
Apply a plan's chosen suggestions in one step; refused if your settings or rules changed since.
Usage:
$ faxbot admin setup apply [OPTIONS] {number}
Arguments:
number: The plan number, from faxbot admin setup plan. [required]
Options:
--only <str>: The suggestions to apply, by number, such as '1,4'. Default: every suggestion the plan chose.--help: Show this message and exit.
faxbot admin settings¶
Every Faxbot setting: show, change, check and save them. Passwords and keys are never shown.
Usage:
$ faxbot admin settings [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
get: Show the settings, including changes...set: Change settings by name, for example...validate: Check a provider's credentials without...reload: Read the saved settings again and show any...persist: Save every setting to the server's...export: Print every setting, one per line, as it...
faxbot admin settings get¶
Show the settings, including changes waiting for a restart.
Usage:
$ faxbot admin settings get [OPTIONS] [section]
Arguments:
section: Only this section, for example limits or inbound.
Options:
--help: Show this message and exit.
faxbot admin settings set¶
Change settings by name, for example max_file_size_mb=20. Faxbot checks the result before saving it.
Passwords and keys are never typed as NAME=VALUE, where they would stay in your shell history: use --secret NAME to type one without showing it, or --secret-stdin NAME to read it from standard input.
Usage:
$ faxbot admin settings set [OPTIONS] [NAME=VALUE...]
Arguments:
NAME=VALUE...: Settings to change, for example max_file_size_mb=20 fax_disabled=false.
Options:
--secret NAME: Ask for this setting without showing what you type, for passwords and provider keys. Repeat for more.--secret-stdin NAME: Read this password or key from standard input, one line each, for scripts. Repeat for more.--text: Send every value exactly as typed.--help: Show this message and exit.
faxbot admin settings validate¶
Check a provider's credentials without saving them or sending a fax.
Credentials are read from these environment variables so they stay out of your shell history: PHAXIO_API_KEY, PHAXIO_API_SECRET, SINCH_PROJECT_ID, SINCH_API_KEY, SINCH_API_SECRET, AMI_HOST, AMI_USERNAME, AMI_PASSWORD, EFAX_APP_ID, EFAX_API_KEY and EFAX_USER_ID. Checking eFax credentials can end the eFax session Faxbot was using; Faxbot signs in again by itself.
Usage:
$ faxbot admin settings validate [OPTIONS] {backend}
Arguments:
backend: Provider whose credentials to check: phaxio, sinch, efax or sip. [required]
Options:
--ami-port <int>: SIP only: the Asterisk manager interface port, if not 5038.--help: Show this message and exit.
faxbot admin settings reload¶
Read the saved settings again and show any changes still waiting for a restart.
Usage:
$ faxbot admin settings reload [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin settings persist¶
Save every setting to the server's recovery file (owners only). Goes away in the next release; use 'faxbot admin backup'.
Usage:
$ faxbot admin settings persist [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin settings export¶
Print every setting, one per line, as it would appear in a settings file. Passwords and keys are shown as ***.
Usage:
$ faxbot admin settings export [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin analysis¶
AI analysis: configure a model, test the connection, and refresh its advice.
Usage:
$ faxbot admin analysis [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
status: Read the saved analysis, its freshness and...run: Queue a fresh analysis.test: Test the saved model connection with a...configure: Save model settings.
faxbot admin analysis status¶
Read the saved analysis, its freshness and the next refresh time.
Usage:
$ faxbot admin analysis status [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin analysis run¶
Queue a fresh analysis. Check status for the result; this does not change fax settings.
Usage:
$ faxbot admin analysis run [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin analysis test¶
Test the saved model connection with a synthetic request, without fax records.
Usage:
$ faxbot admin analysis test [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin analysis configure¶
Save model settings. The owner must enable analysis before operational data is sent.
Usage:
$ faxbot admin analysis configure [OPTIONS]
Options:
--provider <str>: openai, openrouter or compatible.--model <str>: The model identifier from your provider.--base-url <str>: API base address for a compatible provider.--interval-hours <int range>: Refresh interval in hours; 0 means manual only. [0<=x<=168]--enable / --disable: Allow or stop operational analysis.--key-prompt: Enter the model API key without showing it.--key-stdin: Read the model API key from standard input.--help: Show this message and exit.
faxbot admin npi¶
Your NPI numbers, so Faxbot can tell you when a number you might give up is still printed on your NPI record.
Usage:
$ faxbot admin npi [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: Show your NPIs and the numbers the NPI...add: Add one of your NPIs (one per location if...remove: Stop treating an NPI as yours.check: Read each of your NPIs from NPPES now.
faxbot admin npi list¶
Show your NPIs and the numbers the NPI registry (NPPES) lists for each.
Usage:
$ faxbot admin npi list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin npi add¶
Add one of your NPIs (one per location if you have several) and read its record from NPPES.
Usage:
$ faxbot admin npi add [OPTIONS] {number}
Arguments:
number: Your ten-digit NPI. [required]
Options:
--label <str>: A name for this location, such as Denver office.--help: Show this message and exit.
faxbot admin npi remove¶
Stop treating an NPI as yours. What Faxbot read for it stays as history.
Usage:
$ faxbot admin npi remove [OPTIONS] {number}
Arguments:
number: The NPI to remove. [required]
Options:
--help: Show this message and exit.
faxbot admin npi check¶
Read each of your NPIs from NPPES now.
Usage:
$ faxbot admin npi check [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin diagnostics¶
Check the installation without sending a fax.
Usage:
$ faxbot admin diagnostics [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
database: Show whether Faxbot can reach its...run: Check sending, receiving, the fax engine,...show: Show the last diagnostics results without...engine: List what the fax engine reports now:...test-fax: Add a test fax with a real one-page...routes: Route problems: failures that belong to...receiving: Whether each of your numbers can receive...power: The UPS Faxbot reads, so it holds long...test-lines: Send a test fax to a public test line...
faxbot admin diagnostics database¶
Show whether Faxbot can reach its database, and how many records you can see.
Usage:
$ faxbot admin diagnostics database [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin diagnostics run¶
Check sending, receiving, the fax engine, this server and security now. Sends nothing, changes nothing.
Usage:
$ faxbot admin diagnostics run [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin diagnostics show¶
Show the last diagnostics results without checking again.
Usage:
$ faxbot admin diagnostics show [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin diagnostics engine¶
List what the fax engine reports now: trunk sign-ins, checked addresses, calls or faxes.
Usage:
$ faxbot admin diagnostics engine [OPTIONS] {VIEW}
Arguments:
VIEW: registrations, contacts, calls or faxes. [required]
Options:
--help: Show this message and exit.
faxbot admin diagnostics test-fax¶
Add a test fax with a real one-page document, marked as a test, to check mailboxes and email delivery.
Usage:
$ faxbot admin diagnostics test-fax [OPTIONS]
Options:
--from <str>: Sender fax number to show. [default: +15550000000]--to <str>: Your fax number the test fax arrives on, for example +15551234567.--help: Show this message and exit.
faxbot admin diagnostics routes¶
Route problems: failures that belong to one of your sending routes rather than to the numbers it called, and the 2-by-2 test that tells them apart.
Usage:
$ faxbot admin diagnostics routes [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: Route problems Faxbot found (open ones...close: Close a route problem by hand, for example...test: Plan a 2-by-2 test: two of your sending...send: Send one test fax of a 2-by-2 test.show-test: What a 2-by-2 test shows so far.upstream: Record which carrier a provider uses...
faxbot admin diagnostics routes list¶
Route problems Faxbot found (open ones first), recent 2-by-2 tests, and known shared upstreams.
Usage:
$ faxbot admin diagnostics routes list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin diagnostics routes close¶
Close a route problem by hand, for example after you fixed the trunk; Faxbot sets aside what it taught.
Usage:
$ faxbot admin diagnostics routes close [OPTIONS] {PROBLEM}
Arguments:
PROBLEM: The first characters of the problem, from routes list. [required]
Options:
--help: Show this message and exit.
faxbot admin diagnostics routes test¶
Plan a 2-by-2 test: two of your sending accounts against two of your own numbers. Nothing is sent yet.
Usage:
$ faxbot admin diagnostics routes test [OPTIONS]
Options:
--route-a ACCOUNT: The first sending account, such as sip or sinch. [required]--route-b ACCOUNT: The second sending account. [required]--number-a NUMBER: Your first own receiving number. [required]--number-b NUMBER: Your second own receiving number. [required]--help: Show this message and exit.
faxbot admin diagnostics routes send¶
Send one test fax of a 2-by-2 test. This places one real call; each test fax is sent once.
Usage:
$ faxbot admin diagnostics routes send [OPTIONS] {TEST} {CELL}
Arguments:
TEST: The first characters of the test. [required]CELL: a1, a2, b1 or b2: the first or second account (a, b) to your first or second number (1, 2). [required]
Options:
--help: Show this message and exit.
faxbot admin diagnostics routes show-test¶
What a 2-by-2 test shows so far.
Usage:
$ faxbot admin diagnostics routes show-test [OPTIONS] {TEST}
Arguments:
TEST: The first characters of the test. [required]
Options:
--help: Show this message and exit.
faxbot admin diagnostics routes upstream¶
Record which carrier a provider uses upstream, so Faxbot can say when two routes share a path.
Usage:
$ faxbot admin diagnostics routes upstream [OPTIONS] {PROVIDER}
Arguments:
PROVIDER: The provider, such as sinch. [required]
Options:
--upstream CARRIER: The carrier the provider is known to use upstream.--source WEB_ADDRESS: Where that is published (required with --upstream).--read-on DATE: The day you read the source, such as 2026-10-10.--unknown: Faxbot no longer knows what this provider uses upstream.--help: Show this message and exit.
faxbot admin diagnostics receiving¶
Whether each of your numbers can receive faxes now, and which receiver owns each number.
Usage:
$ faxbot admin diagnostics receiving [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
check: Check each number you receive on, from...owner: Name the one receiver of a number's faxes,...
faxbot admin diagnostics receiving check¶
Check each number you receive on, from receiving evidence only. Sends nothing.
Usage:
$ faxbot admin diagnostics receiving check [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin diagnostics receiving owner¶
Name the one receiver of a number's faxes, so two places never take them without you knowing.
Usage:
$ faxbot admin diagnostics receiving owner [OPTIONS] {NUMBER}
Arguments:
NUMBER: One of your fax numbers. [required]
Options:
--account KEY: The receiving account that takes its faxes, such as sip.--elsewhere NAME: A receiver outside this Faxbot, such as "the fax machine at reception".--release: Name no receiver for the number.--move: Move the number from the receiver that has it now.--help: Show this message and exit.
faxbot admin diagnostics power¶
The UPS Faxbot reads, so it holds long calls while the office runs on battery.
Usage:
$ faxbot admin diagnostics power [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
show: What the UPS says now and how Faxbot uses it.set: Read this UPS through NUT; Faxbot then...off: Stop reading the UPS; calls start without...
faxbot admin diagnostics power show¶
What the UPS says now and how Faxbot uses it.
Usage:
$ faxbot admin diagnostics power show [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin diagnostics power set¶
Read this UPS through NUT; Faxbot then holds a call that the battery could not see through.
Usage:
$ faxbot admin diagnostics power set [OPTIONS]
Options:
--address HOST: The NUT server's address, such as 192.168.1.5. [required]--port <int>: The NUT server's port; NUT uses 3493. [default: 3493]--ups NAME: The UPS name on that server; the first it lists when left out.--reserve-minutes <int>: Minutes of battery a call must leave to spare. [default: 2]--help: Show this message and exit.
faxbot admin diagnostics power off¶
Stop reading the UPS; calls start without checking the battery.
Usage:
$ faxbot admin diagnostics power off [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin diagnostics test-lines¶
Send a test fax to a public test line whose operator invites test faxes, and see what came back.
Usage:
$ faxbot admin diagnostics test-lines [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: The public test lines, whether Faxbot may...send: Send one test fax to a public test line, now.replies: Received faxes that are replies to test...show: One test fax's result and what came back.receipt: Look up a Faxbeep test fax on Faxbeep's...reply: Mark a received fax as a test fax's reply.
faxbot admin diagnostics test-lines list¶
The public test lines, whether Faxbot may dial each, whether a reply reaches Faxbot, and recent tests.
Usage:
$ faxbot admin diagnostics test-lines list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin diagnostics test-lines send¶
Send one test fax to a public test line, now. Faxbot never sends one by itself.
Usage:
$ faxbot admin diagnostics test-lines send [OPTIONS] {LINE}
Arguments:
LINE: The line, such as faxbeep-us (see faxbot admin diagnostics test-lines list). [required]
Options:
--allow-country: If Faxbot may not dial this country yet, allow it from now on without asking.--yes: Do not ask before sending to a public page.--help: Show this message and exit.
faxbot admin diagnostics test-lines replies¶
Received faxes that are replies to test faxes, as Received labels them.
Usage:
$ faxbot admin diagnostics test-lines replies [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin diagnostics test-lines show¶
One test fax's result and what came back.
Usage:
$ faxbot admin diagnostics test-lines show [OPTIONS] {TEST}
Arguments:
TEST: The start of a recent test fax ID (see test-lines list). [required]
Options:
--help: Show this message and exit.
faxbot admin diagnostics test-lines receipt¶
Look up a Faxbeep test fax on Faxbeep's public page now.
Usage:
$ faxbot admin diagnostics test-lines receipt [OPTIONS] {TEST}
Arguments:
TEST: The start of a recent Faxbeep test fax ID. [required]
Options:
--help: Show this message and exit.
faxbot admin diagnostics test-lines reply¶
Mark a received fax as a test fax's reply.
Usage:
$ faxbot admin diagnostics test-lines reply [OPTIONS] {TEST} {RECEIVED}
Arguments:
TEST: The start of a recent test fax ID. [required]RECEIVED: The received fax that is the reply, as test-lines show offers it. [required]
Options:
--help: Show this message and exit.
faxbot admin logs¶
The activity log: sign-ins, faxes, phone pairing and terminal use.
Usage:
$ faxbot admin logs [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: Show recent activity log entries.tail: Show the end of the activity log file,...
faxbot admin logs list¶
Show recent activity log entries.
Usage:
$ faxbot admin logs list [OPTIONS]
Options:
--search <str>: Only entries containing this text.--event <str>: Only log entries of this event type, for example job_created.--since <str>: Only entries after this time, for example 2026-10-01.--limit <int range>: How many entries to show. [default: 200; x>=1]--help: Show this message and exit.
faxbot admin logs tail¶
Show the end of the activity log file, when Faxbot writes one.
Usage:
$ faxbot admin logs tail [OPTIONS]
Options:
--search <str>: Only lines containing this text.--event <str>: Only log entries of this event type.--lines <int range>: How many of the last lines to show. [default: 200; 1<=x<=20000]--help: Show this message and exit.
faxbot admin codec¶
Encode a document as payload pages, or decode payload pages from a received fax file, on this computer (experimental).
Usage:
$ faxbot admin codec [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
decode: Decode the encoded pages in a fax file on...encode: Encode a document as payload pages on this...
faxbot admin codec decode¶
Decode the encoded pages in a fax file on this computer, check the document's fingerprint and save it.
Usage:
$ faxbot admin codec decode [OPTIONS] {source}
Arguments:
source: A received fax file: PDF, TIFF, PNG or JPEG. [required]
Options:
-o, --output <path>: Where to write the original document.--shared-key KEY: The shared key, when the document was encrypted.--force: Replace the file if it exists.--help: Show this message and exit.
faxbot admin codec encode¶
Encode a document as payload pages on this computer and save them as a fax TIFF.
Usage:
$ faxbot admin codec encode [OPTIONS] {source}
Arguments:
source: A PDF or plain-text file. [required]
Options:
-o, --output <path>: The fax TIFF to write. [required]--resolution standard|fine|superfine|300|400: The fax resolution the pages are made for. [default: fine]--layout grid|runs|picture|enumerative|capacity: grid survives resolution changes; runs needs the exact image; picture hides the document in a picture; enumerative needs an unchanged image and a recipient whose Faxbot supports enumerative profile 1; capacity carries the most for its line time or pages and needs the exact image and a decoder from October 2026 or later. [default: grid]--capacity-profile time|balanced|pages: With --layout capacity: time for the shortest call (routes billed by the minute), pages for the fewest pages (routes billed by the page), or balanced. [default: time]--error-correction low|medium|high: How much damage the pages survive. [default: medium]--shared-key KEY: Encrypt with this shared key.--force: Replace the file if it exists.--help: Show this message and exit.
faxbot admin profiles¶
Server addresses and keys saved on this computer, so you do not have to type them each time.
Usage:
$ faxbot admin profiles [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
save: Save a server address and key as a profile.list: List saved profiles.use: Make a saved profile the default.remove: Delete a saved profile and its key.
faxbot admin profiles save¶
Save a server address and key as a profile. You are asked for the key without it being shown.
Usage:
$ faxbot admin profiles save [OPTIONS] [name]
Arguments:
name: Profile name. [default: default]
Options:
--url <str>: Server address for this profile. Default: the address in use now.--key-stdin: Read the key from standard input instead of asking for it.--no-key: Save the address only.--use / --no-use: Make this the default profile. [default: use]--help: Show this message and exit.
faxbot admin profiles list¶
List saved profiles. Keys are never shown.
Usage:
$ faxbot admin profiles list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot admin profiles use¶
Make a saved profile the default.
Usage:
$ faxbot admin profiles use [OPTIONS] {name}
Arguments:
name: Profile name. [required]
Options:
--help: Show this message and exit.
faxbot admin profiles remove¶
Delete a saved profile and its key.
Usage:
$ faxbot admin profiles remove [OPTIONS] {name}
Arguments:
name: Profile name. [required]
Options:
--help: Show this message and exit.