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 system 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 system 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 where a sent fax is now.received: Received faxes: list and open them, give...sent: Sent faxes: list them, open one, download...numbers: Your fax numbers: which mailbox each...recipients: Fax numbers you send to: routing, batching...providers: The fax services Faxbot sends and receives...costs: What faxing costs you: spending by route,...access: Who can use Faxbot and what each person...system: Look after the installation: settings,...
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.--help: Show this message and exit.
faxbot status¶
Show where a sent fax is now.
Usage:
$ faxbot status [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID shown when the fax was sent. [required]
Options:
--help: Show this message and exit.
faxbot received¶
Received faxes: list and open them, give each one an owner, and see where they were delivered.
Usage:
$ faxbot 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.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...deliveries: Delivery of received faxes to email and...
faxbot received list¶
List received faxes you can see.
Usage:
$ faxbot 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 received show and pdf.--help: Show this message and exit.
faxbot received show¶
Show one received fax.
Usage:
$ faxbot received show [OPTIONS] {inbound_id}
Arguments:
inbound_id: A received fax's ID, from 'faxbot received list --ids' or 'faxbot received owners --ids'. [required]
Options:
--help: Show this message and exit.
faxbot received pdf¶
Download the document of a received fax.
Usage:
$ faxbot received pdf [OPTIONS] {inbound_id}
Arguments:
inbound_id: A received fax's ID, from 'faxbot received list --ids' or 'faxbot 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 received fetch¶
Ask Faxbot to fetch a received fax's document again now.
Usage:
$ faxbot received fetch [OPTIONS] {inbound_id}
Arguments:
inbound_id: A received fax's ID, from 'faxbot received list --ids' or 'faxbot received owners --ids'. [required]
Options:
--help: Show this message and exit.
faxbot 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 received recover [OPTIONS]
Options:
--help: Show this message and exit.
faxbot received import¶
Import a PDF from another system as if it were a received fax.
Usage:
$ faxbot 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 received owners¶
List received faxes with their owner and state: open ones first, soonest target first.
Usage:
$ faxbot 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 received history¶
Show who has owned a received fax and everything that happened to it.
Usage:
$ faxbot received history [OPTIONS] {item_id}
Arguments:
item_id: A received fax's ID, from 'faxbot received list --ids' or 'faxbot received owners --ids'. [required]
Options:
--help: Show this message and exit.
faxbot received counts¶
Count the received faxes you can see in each state, such as waiting for an owner or overdue.
Usage:
$ faxbot received counts [OPTIONS]
Options:
--help: Show this message and exit.
faxbot received assign¶
Give a received fax to an owner. They must already be able to see it.
Usage:
$ faxbot received assign [OPTIONS] {item_id} {user}
Arguments:
item_id: A received fax's ID, from 'faxbot received list --ids' or 'faxbot received owners --ids'. [required]user: The new owner: their login or name. [required]
Options:
--help: Show this message and exit.
faxbot received acknowledge¶
Acknowledge a received fax you own.
Usage:
$ faxbot received acknowledge [OPTIONS] {item_id}
Arguments:
item_id: A received fax's ID, from 'faxbot received list --ids' or 'faxbot received owners --ids'. [required]
Options:
--help: Show this message and exit.
faxbot received done¶
Mark a received fax done, with a short note.
Usage:
$ faxbot received done [OPTIONS] {item_id}
Arguments:
item_id: A received fax's ID, from 'faxbot received list --ids' or 'faxbot received owners --ids'. [required]
Options:
--note <str>: What was done, up to 200 characters. [required]--help: Show this message and exit.
faxbot received reopen¶
Reopen a received fax marked done. Its owner acknowledges it again.
Usage:
$ faxbot received reopen [OPTIONS] {item_id}
Arguments:
item_id: A received fax's ID, from 'faxbot received list --ids' or 'faxbot received owners --ids'. [required]
Options:
--help: Show this message and exit.
faxbot 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 received export [OPTIONS] {item_id}
Arguments:
item_id: A received fax's ID, from 'faxbot received list --ids' or 'faxbot 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 received deliveries¶
Delivery of received faxes to email and other places, and any that failed.
Usage:
$ faxbot 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 received deliveries list¶
List received documents and their delivery, newest first.
Usage:
$ faxbot 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 received deliveries retry.--help: Show this message and exit.
faxbot received deliveries retry¶
Try delivering a received document again.
Usage:
$ faxbot received deliveries retry [OPTIONS] {item_id}
Arguments:
item_id: Item ID from 'faxbot received deliveries list --ids'. [required]
Options:
--help: Show this message and exit.
faxbot sent¶
Sent faxes: list them, open one, download what was sent and follow its delivery.
Usage:
$ faxbot 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...
faxbot sent list¶
List sent faxes, newest first, with what each cost. Fax numbers are partly hidden.
Usage:
$ faxbot 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 sent show, pdf and refresh.--help: Show this message and exit.
faxbot sent show¶
Show one sent fax.
Usage:
$ faxbot sent show [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID. [required]
Options:
--help: Show this message and exit.
faxbot sent pdf¶
Download the document of a sent fax.
Usage:
$ faxbot 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 sent refresh¶
Ask the provider for the latest status of a sent fax. This never sends it again.
Usage:
$ faxbot sent refresh [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID. [required]
Options:
--help: Show this message and exit.
faxbot sent evidence¶
Show the evidence of a sent fax's delivery: each step and what the fax service reported.
Usage:
$ faxbot sent evidence [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID, from 'faxbot sent list --ids'. [required]
Options:
--help: Show this message and exit.
faxbot 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 sent confirm-receipt [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID, from 'faxbot 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 sent send-now¶
Send a waiting fax now; the faxes waiting with it go in the same call.
Usage:
$ faxbot 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 numbers¶
Your fax numbers: which mailbox each number's faxes go to, the mailboxes themselves, and email delivery.
Usage:
$ faxbot 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, or the...mailboxes: Mailboxes that hold received faxes, and...email: Email delivery of received faxes.
faxbot numbers list¶
List your fax numbers: who provides each one, the mailbox its faxes go to, and whether they are emailed.
Usage:
$ faxbot numbers list [OPTIONS]
Options:
--ids: Also show internal ids.--help: Show this message and exit.
faxbot numbers add¶
Send faxes that arrive on a number to a mailbox.
Usage:
$ faxbot 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]--help: Show this message and exit.
faxbot numbers update¶
Change a fax number's mailbox, or the number itself.
Usage:
$ faxbot numbers update [OPTIONS] {number}
Arguments:
number: Fax number of the rule to change. [required]
Options:
--number <str>: New fax number.--mailbox <str>: New mailbox.--help: Show this message and exit.
faxbot numbers mailboxes¶
Mailboxes that hold received faxes, and how soon someone should acknowledge them.
Usage:
$ faxbot numbers 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 numbers mailboxes list¶
List mailboxes.
Usage:
$ faxbot numbers mailboxes list [OPTIONS]
Options:
--ids: Also show internal ids.--help: Show this message and exit.
faxbot numbers mailboxes add¶
Add a mailbox.
Usage:
$ faxbot numbers 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 numbers mailboxes update¶
Rename a mailbox or switch it on or off.
Usage:
$ faxbot numbers 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 numbers 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 numbers 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 numbers email¶
Email delivery of received faxes.
Usage:
$ faxbot numbers email [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
connectors: The email inboxes and other places...
faxbot numbers email connectors¶
The email inboxes and other places received faxes are delivered to.
Usage:
$ faxbot numbers 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 numbers email connectors list¶
List the email inboxes and other places received faxes are delivered to.
Usage:
$ faxbot numbers email connectors list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot numbers email connectors add¶
Add an email inbox that received faxes are delivered to.
Usage:
$ faxbot numbers 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 numbers email connectors update¶
Change an email delivery. Settings you leave out stay as they are.
Usage:
$ faxbot numbers 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 numbers email connectors test¶
Send a test email to check a delivery address.
Usage:
$ faxbot numbers 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 numbers email connectors remove¶
Stop delivering to an email inbox and remove it.
Usage:
$ faxbot numbers 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 recipients¶
Fax numbers you send to: routing, batching several faxes into one call, direct delivery partners and case packets.
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...together: Send short faxes to the same number...partners: Partners: other offices running Faxbot,...cases: Case packets: when you fax documents for a...
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, or whether it accepts case packets.
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.--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 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 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.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.deliveries: List recent faxes sent to and received...
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.
Usage:
$ faxbot recipients partners list [OPTIONS]
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 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 cases¶
Case packets: when you fax documents for a case, leave out the ones the recipient already has.
Usage:
$ faxbot recipients 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 already sent...send: Send a case packet, leaving out documents...
faxbot recipients cases list¶
List the newest cases you sent packets for: who received them, documents sent and received, and when.
Usage:
$ faxbot recipients cases list [OPTIONS]
Options:
--limit <int range>: How many cases to show. [default: 50; 1<=x<=200]--help: Show this message and exit.
faxbot recipients cases documents¶
List the documents of a case already sent to a recipient, and which they accepted.
Usage:
$ faxbot recipients 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 sent in.--help: Show this message and exit.
faxbot recipients cases send¶
Send a case packet, leaving out documents the recipient already has.
Usage:
$ faxbot recipients 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.--preview: Show what would be sent without sending.--help: Show this message and exit.
faxbot providers¶
The fax services Faxbot sends and receives with, their settings, and your own phone line for faxing.
Usage:
$ faxbot 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...efax: eFax receiving: whether Faxbot is...trunk: Your own phone line for faxing, to a phone...
faxbot providers list¶
List the fax and storage providers installed, and which ones are in use.
Usage:
$ faxbot providers list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot providers status¶
Show whether the active provider is ready and how many faxes are in each state.
Usage:
$ faxbot providers status [OPTIONS]
Options:
--help: Show this message and exit.
faxbot providers show¶
Show a provider's settings. Passwords and keys are hidden.
Usage:
$ faxbot providers show [OPTIONS] {provider}
Arguments:
provider: Provider from 'faxbot 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 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 providers configure [OPTIONS] {provider} [NAME=VALUE...]
Arguments:
provider: Provider from 'faxbot 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 providers callbacks¶
Show the addresses your receiving provider must call for incoming faxes.
Usage:
$ faxbot providers callbacks [OPTIONS]
Options:
--help: Show this message and exit.
faxbot providers validate¶
Check the file that describes a fax service before you add it. Nothing is installed or sent.
Usage:
$ faxbot providers validate [OPTIONS] {manifest}
Arguments:
manifest: The file that describes the fax service (JSON). [required]
Options:
--help: Show this message and exit.
faxbot providers install¶
Install a custom HTTP fax provider from its manifest file.
Usage:
$ faxbot providers install [OPTIONS] {manifest}
Arguments:
manifest: The file that describes the fax service (JSON). [required]
Options:
--help: Show this message and exit.
faxbot providers import¶
Add several fax services at once from a file of their descriptions.
Usage:
$ faxbot 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 providers efax¶
eFax receiving: whether Faxbot is collecting your faxes from eFax.
Usage:
$ faxbot providers efax [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
status: Show whether Faxbot is collecting your...
faxbot 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 providers efax status [OPTIONS]
Options:
--help: Show this message and exit.
faxbot providers trunk¶
Your own phone line for faxing, to a phone carrier or to your phone system: presets, status and recent calls.
Usage:
$ faxbot 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 fast fax service once no fax...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...network: Whether fax over IP (T.38) works on the...telnyx: Telnyx settings for fax over IP (T.38) on...
faxbot providers trunk status¶
Check the SIP trunk: registration with the carrier, Faxbot's public IP address, and the last call.
Usage:
$ faxbot providers trunk status [OPTIONS]
Options:
--help: Show this message and exit.
faxbot 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 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 providers trunk calls¶
List recent calls on the phone line, newest first, each with one sentence about what happened.
Usage:
$ faxbot 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 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 only measures these; it changes nothing because of them.
Usage:
$ faxbot 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 providers trunk restart-engine¶
Restart the fast fax service once no fax is being sent or received.
Usage:
$ faxbot providers trunk restart-engine [OPTIONS]
Options:
--help: Show this message and exit.
faxbot 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 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 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 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 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 providers trunk presets [OPTIONS] [PRESET]
Arguments:
[PRESET]: Show one preset in full, for example avaya-ipoffice.
Options:
--help: Show this message and exit.
faxbot providers trunk use¶
Choose a carrier or phone system preset for the SIP trunk and save its settings; then connect it with faxbot providers trunk apply.
A phone system recognizes Faxbot by its IP address, so it needs no username or password.
Usage:
$ faxbot providers trunk use [OPTIONS] {PRESET}
Arguments:
PRESET: Carrier or phone system preset, for example telnyx (see faxbot 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: How numbers are dialed: e164 (international format, +44...) or local (as a phone at your site dials them).--prefix <str>: Outside-line digits before a number dialled as a phone here dials it, such as 9.--help: Show this message and exit.
faxbot 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 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 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 providers trunk network status [OPTIONS]
Options:
--help: Show this message and exit.
faxbot providers trunk network check¶
Run the network check again now; new calls use fax over IP only when it works.
Usage:
$ faxbot providers trunk network check [OPTIONS]
Options:
--help: Show this message and exit.
faxbot 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 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 providers trunk telnyx¶
Telnyx settings for fax over IP (T.38) on your trunk numbers.
Usage:
$ faxbot 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...
faxbot 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 providers trunk telnyx status [OPTIONS]
Options:
--help: Show this message and exit.
faxbot providers trunk telnyx t38-on¶
Turn on fax over IP (T.38) at Telnyx for one trunk number. Only that setting changes.
Usage:
$ faxbot providers trunk telnyx t38-on [OPTIONS] {NUMBER}
Arguments:
NUMBER: The trunk number, for example +17208565062. [required]
Options:
--help: Show this message and exit.
faxbot costs¶
What faxing costs you: spending by route, charges from your carrier, and the prices and plans Faxbot uses.
Usage:
$ faxbot costs [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
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...savings: Show how much money Faxbot saved by...recommendations: Show ways to pay less: numbers where...rate-cards: Show the prices Faxbot uses to estimate...plans: Show the price plans a fax service...
faxbot costs spending¶
Show what faxing cost per route: carrier charges, estimates for faxes not billed yet, and what is waiting.
Usage:
$ faxbot costs spending [OPTIONS]
Options:
--since <str>: Start date, for example 2026-09-01. Default: the last 30 days.--help: Show this message and exit.
faxbot costs reconcile¶
Ask your SIP trunk carrier now what each recent call cost. This never changes a fax's delivery result.
Usage:
$ faxbot costs reconcile [OPTIONS]
Options:
--help: Show this message and exit.
faxbot costs fax¶
Show what one fax cost: the carrier's charge, or why it is not known yet.
Usage:
$ faxbot costs fax [OPTIONS] {fax_id}
Arguments:
fax_id: Fax ID from 'faxbot sent list --ids' or, with --received, from 'faxbot received list --ids'. [required]
Options:
--received: The fax is a received fax.--help: Show this message and exit.
faxbot costs received¶
Show what the call that brought in a received fax cost, or the cost of every received fax.
Usage:
$ faxbot costs received [OPTIONS] [fax_id]
Arguments:
fax_id: Received fax ID, from 'faxbot received list --ids'.
Options:
--all: Every received fax you can see, newest 100 first.--help: Show this message and exit.
faxbot costs savings¶
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 costs savings [OPTIONS]
Options:
--days <int range>: How many days back to count. [default: 30; 1<=x<=366]--help: Show this message and exit.
faxbot costs recommendations¶
Show ways to pay less: numbers where another route cost less per delivered fax in the last 30 days, numbers that could share incoming lines, and whether each monthly plan is worth its fee.
Usage:
$ faxbot costs recommendations [OPTIONS]
Options:
--help: Show this message and exit.
faxbot costs rate-cards¶
Show the prices Faxbot uses to estimate costs, or replace them from a file.
Usage:
$ faxbot costs 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 costs plans¶
Show the price plans a fax service advertises, with where Faxbot found them and when.
Usage:
$ faxbot costs plans [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 access¶
Who can use Faxbot and what each person may do: people, groups, roles, keys, sign-ins and paired phones.
Usage:
$ faxbot 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 access me¶
Show who your key belongs to and what it may do.
Usage:
$ faxbot access me [OPTIONS]
Options:
--help: Show this message and exit.
faxbot access users¶
People who sign in to Faxbot, and the apps and devices that use their own key.
Usage:
$ faxbot 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 access users list¶
List people and apps.
Usage:
$ faxbot 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 access users show¶
Show a person or app with their groups, roles, keys and what they may do.
Usage:
$ faxbot 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 access users add¶
Add a user. Their temporary password is shown once.
Usage:
$ faxbot 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 access users update¶
Change a person's or app's name, sign-in name, or whether they can use Faxbot.
Usage:
$ faxbot 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 access users reset-password¶
Give a user a new temporary password, shown once. Their sessions end.
Usage:
$ faxbot access users reset-password [OPTIONS] {who}
Arguments:
who: Sign-in name, display name or id. [required]
Options:
--help: Show this message and exit.
faxbot access integrations¶
Apps and devices, such as scanners, that use Faxbot with their own key.
Usage:
$ faxbot 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 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 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 access integrations list¶
List the apps and devices, such as scanners, that use Faxbot with their own key.
Usage:
$ faxbot access integrations list [OPTIONS]
Options:
--ids: Also show internal ids.--help: Show this message and exit.
faxbot access groups¶
Groups of people who share the same access.
Usage:
$ faxbot 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 access groups list¶
List groups.
Usage:
$ faxbot access groups list [OPTIONS]
Options:
--ids: Also show internal ids.--help: Show this message and exit.
faxbot access groups show¶
Show a group with its members and roles.
Usage:
$ faxbot 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 access groups add¶
Add a group.
Usage:
$ faxbot 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 access groups update¶
Rename a group, change its description or switch it on or off.
Usage:
$ faxbot 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 access groups members¶
Add people to a group or remove them.
Usage:
$ faxbot 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 access groups members add¶
Add a person or app to a group.
Usage:
$ faxbot 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 access groups members remove¶
Remove a user or integration from a group.
Usage:
$ faxbot 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 access roles¶
Roles: named sets of permissions, such as Fax operator, that you give to people.
Usage:
$ faxbot 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 access roles list¶
List roles.
Usage:
$ faxbot access roles list [OPTIONS]
Options:
--ids: Also show internal ids.--help: Show this message and exit.
faxbot access roles show¶
Show a role and its permissions.
Usage:
$ faxbot 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 access roles permissions¶
List everything a role can allow.
Usage:
$ faxbot access roles permissions [OPTIONS]
Options:
--help: Show this message and exit.
faxbot access roles add¶
Add a role of your own, choosing what it allows. See faxbot access roles permissions for the choices.
Usage:
$ faxbot 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 access roles update¶
Change a custom role. Built-in roles cannot be changed.
Usage:
$ faxbot 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 access grants¶
Who has which role, and for which mailboxes or faxes.
Usage:
$ faxbot 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 access grants list¶
List who has which role, and where.
Usage:
$ faxbot 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 access grants add¶
Give a person, app or group a role.
Usage:
$ faxbot 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 access resources list. [default: installation]--help: Show this message and exit.
faxbot access grants remove¶
Take a role away from a user, integration or group.
Usage:
$ faxbot 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 access resources list. [default: installation]--help: Show this message and exit.
faxbot access keys¶
Keys that let apps, scripts, scanners and phones use Faxbot without a password.
Usage:
$ faxbot 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 access keys list¶
List keys and who they belong to. A key itself is shown only once, when it is created.
Usage:
$ faxbot access keys list [OPTIONS]
Options:
--for <str>: Only keys of this user or integration.--help: Show this message and exit.
faxbot access keys create¶
Create a key. It is shown once, so store it straight away.
Usage:
$ faxbot 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 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 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 access keys rotate [OPTIONS] {key_id}
Arguments:
key_id: Key ID or key name. [required]
Options:
--help: Show this message and exit.
faxbot access keys revoke¶
Revoke a key permanently.
Usage:
$ faxbot access keys revoke [OPTIONS] {key_id}
Arguments:
key_id: Key ID or key name. [required]
Options:
--help: Show this message and exit.
faxbot access keys approve¶
Approve an older key that is waiting for review: choose whose it is and what it may do.
Usage:
$ faxbot 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 access resources list. [default: installation]--help: Show this message and exit.
faxbot access keys update¶
Change a key's name, note or expiry date.
Usage:
$ faxbot 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 access sessions¶
People signed in to the console in a browser.
Usage:
$ faxbot 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 access sessions list¶
List people signed in to the console.
Usage:
$ faxbot 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 access sessions revoke¶
End a session.
Usage:
$ faxbot access sessions revoke [OPTIONS] {session_id}
Arguments:
session_id: Session id from 'faxbot access sessions list --ids'. [required]
Options:
--help: Show this message and exit.
faxbot access pair¶
Pair the Faxbot iPhone app with this installation.
Usage:
$ faxbot 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 access pair new¶
Create a six-digit pairing code for one phone. It works once, within five minutes.
Usage:
$ faxbot access pair new [OPTIONS]
Options:
--help: Show this message and exit.
faxbot 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 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 access resources¶
The places a role can apply to: the whole installation, a mailbox or a person's own faxes.
Usage:
$ faxbot access resources [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
list: List the places a role can apply to.
faxbot access resources list¶
List the places a role can apply to.
Usage:
$ faxbot 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 access owner¶
Create an owner, who can do everything in Faxbot, using the installation key.
Usage:
$ faxbot access owner [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
enroll: Create a named owner, with full control,...
faxbot 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 system recover-owner.
Usage:
$ faxbot 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 system¶
Look after the installation: settings, checks, logs, the security log, backups and restarts.
Usage:
$ faxbot system [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...settings: Every Faxbot setting: show, change, check...diagnostics: Check the installation without sending a fax.logs: The activity log: sign-ins, faxes, phone...profiles: Server addresses and keys saved on this...
faxbot system 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 system health [OPTIONS]
Options:
--help: Show this message and exit.
faxbot system audit¶
Show the security log of access changes and sign-ins, newest first.
Usage:
$ faxbot system 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 system restart¶
Restart Faxbot, when the installation allows it.
Usage:
$ faxbot system restart [OPTIONS]
Options:
-y, --yes: Do not ask for confirmation.--help: Show this message and exit.
faxbot system status¶
Show whether the database is up to date, whether settings are saved, and how many records there are.
Usage:
$ faxbot system 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 system migrate¶
Update the database after you install a new version of Faxbot.
Usage:
$ faxbot system 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 system 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 access owner enroll.
Usage:
$ faxbot system 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 system 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 system 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 system restore¶
Restore a backup after checking every file in it.
Usage:
$ faxbot system restore [OPTIONS] {folder}
Arguments:
folder: Backup folder made by faxbot system 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 system settings¶
Every Faxbot setting: show, change, check and save them. Passwords and keys are never shown.
Usage:
$ faxbot system 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 system settings get¶
Show the settings, including changes waiting for a restart.
Usage:
$ faxbot system settings get [OPTIONS] [section]
Arguments:
section: Only this section, for example limits or inbound.
Options:
--help: Show this message and exit.
faxbot system 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 system 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 system 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 system 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 system settings reload¶
Read the saved settings again and show any changes still waiting for a restart.
Usage:
$ faxbot system settings reload [OPTIONS]
Options:
--help: Show this message and exit.
faxbot system settings persist¶
Save every setting to the server's recovery file (owners only). Goes away in the next release; use 'faxbot system backup'.
Usage:
$ faxbot system settings persist [OPTIONS]
Options:
--help: Show this message and exit.
faxbot system settings export¶
Print every setting, one per line, as it would appear in a settings file. Passwords and keys are shown as ***.
Usage:
$ faxbot system settings export [OPTIONS]
Options:
--help: Show this message and exit.
faxbot system diagnostics¶
Check the installation without sending a fax.
Usage:
$ faxbot system 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...
faxbot system diagnostics database¶
Show whether Faxbot can reach its database, and how many records you can see.
Usage:
$ faxbot system diagnostics database [OPTIONS]
Options:
--help: Show this message and exit.
faxbot system diagnostics run¶
Check sending, receiving, the fax engine, this server and security now. Sends nothing, changes nothing.
Usage:
$ faxbot system diagnostics run [OPTIONS]
Options:
--help: Show this message and exit.
faxbot system diagnostics show¶
Show the last diagnostics results without checking again.
Usage:
$ faxbot system diagnostics show [OPTIONS]
Options:
--help: Show this message and exit.
faxbot system diagnostics engine¶
List what the fax engine reports now: trunk sign-ins, checked addresses, calls or faxes.
Usage:
$ faxbot system diagnostics engine [OPTIONS] {VIEW}
Arguments:
VIEW: registrations, contacts, calls or faxes. [required]
Options:
--help: Show this message and exit.
faxbot system 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 system 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 system logs¶
The activity log: sign-ins, faxes, phone pairing and terminal use.
Usage:
$ faxbot system 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 system logs list¶
Show recent activity log entries.
Usage:
$ faxbot system 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 system logs tail¶
Show the end of the activity log file, when Faxbot writes one.
Usage:
$ faxbot system 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 system profiles¶
Server addresses and keys saved on this computer, so you do not have to type them each time.
Usage:
$ faxbot system 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 system profiles save¶
Save a server address and key as a profile. You are asked for the key without it being shown.
Usage:
$ faxbot system 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 system profiles list¶
List saved profiles. Keys are never shown.
Usage:
$ faxbot system profiles list [OPTIONS]
Options:
--help: Show this message and exit.
faxbot system profiles use¶
Make a saved profile the default.
Usage:
$ faxbot system profiles use [OPTIONS] {name}
Arguments:
name: Profile name. [required]
Options:
--help: Show this message and exit.
faxbot system profiles remove¶
Delete a saved profile and its key.
Usage:
$ faxbot system profiles remove [OPTIONS] {name}
Arguments:
name: Profile name. [required]
Options:
--help: Show this message and exit.