Skip to content

Command reference

Every command accepts --json, which prints JSON instead of tables. Errors exit with status 1; with --json they print {"error": "…"}.

Save the server URL and workspace key for later commands.

Terminal window
visiconvert login --url <URL> [OPTIONS]
Argument Required Description
--url <URL> Yes Server URL, e.g. https://convert.example.com (https unless it is localhost)
--key-stdin No Read the key from stdin instead of prompting.

Forget the saved server URL and key.

Terminal window
visiconvert logout

Server health, Twilio connection and what to do next.

Terminal window
visiconvert status

Save Twilio credentials. The auth token is read from stdin, never from arguments.

Terminal window
visiconvert connect twilio --account-sid <ACCOUNT_SID> [OPTIONS]
Argument Required Description
--account-sid <ACCOUNT_SID> Yes Twilio Account SID, starting with AC.
--token-stdin No Read the auth token from stdin instead of prompting.

Tracking numbers in this workspace.

Terminal window
visiconvert numbers list

Numbers in your Twilio account that are not tracked yet.

Terminal window
visiconvert numbers available

Track a Twilio number for one source and campaign.

Terminal window
visiconvert numbers add <PHONE_NUMBER> --forward-to <FORWARD_TO> --source <SOURCE> --campaign <CAMPAIGN> [OPTIONS]
Argument Required Description
<PHONE_NUMBER> Yes The Twilio number, e.g. +15125550142.
--forward-to <FORWARD_TO> Yes The business line calls ring through to.
--source <SOURCE> Yes Marketing source, e.g. “Google Ads” or “Yard signs”.
--campaign <CAMPAIGN> Yes Campaign within the source.
--label <LABEL> No Defaults to the campaign.

Leads, newest first.

Terminal window
visiconvert leads list [OPTIONS]
Argument Required Description
--since <SINCE> No 7d, 24h, 30m, or a date like 2026-10-01.
--source <SOURCE> No Only leads from this source.
--status <STATUS> No unreviewed, qualified, unqualified or spam.
--limit <LIMIT> No Most leads to show. Default: 50.
--demo No Include sample leads.

Add a lead that did not arrive by phone.

Terminal window
visiconvert leads add --name <NAME> --contact <CONTACT> --source <SOURCE> [OPTIONS]
Argument Required Description
--name <NAME> Yes Who the lead is.
--contact <CONTACT> Yes Phone or email.
--source <SOURCE> Yes Marketing source.
--campaign <CAMPAIGN> No Campaign within the source.
--notes <NOTES> No Free-text notes.
--external-id <EXTERNAL_ID> No Your ID for this lead; repeating it will not create a duplicate.

Mark a lead qualified, unqualified, spam or unreviewed.

Terminal window
visiconvert leads qualify <LEAD> <QUALIFICATION> [OPTIONS]
Argument Required Description
<LEAD> Yes Lead ID or a unique prefix of at least 6 characters.
<QUALIFICATION> Yes qualified, unqualified, spam or unreviewed.
--notes <NOTES> No Replace the lead’s notes.

Record a booked job, or cancel one.

Terminal window
visiconvert leads outcome <LEAD> --ref <REFERENCE> [OPTIONS]
Argument Required Description
<LEAD> Yes Lead ID or a unique prefix of at least 6 characters.
--ref <REFERENCE> Yes Job or invoice number; reusing it revises that booking.
--booked <BOOKED> No Booked value in USD, e.g. 1250.00.
--canceled No Cancel the booking with this reference.

Bookings recorded on a lead.

Terminal window
visiconvert leads outcomes <LEAD>
Argument Required Description
<LEAD> Yes Lead ID or a unique prefix of at least 6 characters.

Leads, qualified leads, bookings and revenue by source.

Terminal window
visiconvert report sources

Run as an MCP server on stdio for AI agents.

Terminal window
visiconvert mcp [OPTIONS]
Argument Required Description
--allow-changes No Expose tools that add numbers and leads, qualify leads and record bookings.