AvairAI CLI command reference

Every command with its arguments, options and examples. avair <command> --help prints the same text.

Global options

Every command takes these.

--json: print stable JSON only
--no-input: never prompt or open a browser
-y, --yes: confirm live and credit-spending actions
--dry-run: show what would happen without sending requests or changing anything on this computer
--debug: print request diagnostics

auth

`avair auth login`

Options:

--with-token: read a personal access token from stdin

Examples:

avair auth login
avair auth login --with-token

`avair auth status`

Check that you are signed in and show who you are

Examples:

avair auth status

`avair auth logout`

Sign out on this computer

Examples:

avair auth logout

whoami

Show the current Avair identity and tenant

`avair whoami`

Show the current Avair identity and tenant

Examples:

avair whoami
avair whoami --json

account

Your account

`avair account usage`

Campaign quota, Tools credits and contact limits, each as its own control

Examples:

avair account usage

profile

Your user profile

`avair profile show`

Show your user profile

Examples:

avair profile show

`avair profile edit`

Agents may change name, title and sign-off settings; email, phone and role are refused

Options:

--first-name <name>: your first name
--last-name <name>: your last name
--job-title <title>: your job title
--booking-link <url>: your meeting booking link
--signature-mode <mode>: AUTO or CUSTOM
--signature <text>: your own email sign-off text, used when the mode is CUSTOM

Examples:

avair profile edit --job-title "Sales Director"
avair profile edit --first-name Jane --last-name Doe --booking-link https://example.com/book

`avair profile content-style show`

Show your content style and examples

Examples:

avair profile content-style show

`avair profile content-style set`

Replace your content style and examples from a JSON file

Options:

--input <file>: JSON with selected_style, examples, default_instructions, preferred_language

Examples:

avair profile content-style set --input content-style.json

campaigns

Create, build, review and launch campaigns

`avair campaigns list`

List campaigns

Options:

--status <status>: a campaign status, ALL_DRAFTS or ALL
--mine: only campaigns you own or are assigned to
--search <text>: only campaigns that match this text
--limit <n>: page size (default: "50")
--skip <n>: rows to skip (default: "0")

Examples:

avair campaigns list
avair campaigns list --status ALL_DRAFTS --mine --limit 20
avair campaigns list --search "Texas"

`avair campaigns show <id>`

Show one campaign

Examples:

avair campaigns show CAMPAIGN_ID

`avair campaigns watch <id>`

Wait until the campaign stops generating

Options:

--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair campaigns watch CAMPAIGN_ID
avair campaigns watch CAMPAIGN_ID --timeout 1800

`avair campaigns create`

Create a campaign from a website; it stops when its targets are ready

Options:

--input <file>: complete JSON request file
--website <url>: the website of the company to sell for
--location <location>: one place to target, for example a state
--size <size>: one company size to target, for example 51-200
--industry <industry>: one industry to target
--channels <channels>: comma-separated: email, manual_call, ai_call, linkedin
--content-style <style>: campaign style, lower case with hyphens: standard, competitor-replacement, single-competitor-takeout, event-outreach, local-market-push, list-standard, event-list-follow-up, win-back, customer-expansion, partner-recruitment
--assess <steps>: steps the build checks and improves by itself: all (default), none or a comma list of messaging, content and targets
--idempotency-key <key>: a retry with the same key and the same request returns the same campaign, not a second one; a different request with that key is refused (409); default: a new random key each run
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair campaigns create --website example.com --location "Texas"
avair campaigns create --website https://example.com --industry "Software" --size "51-200" --channels email,linkedin --wait
avair campaigns create --input request.json --idempotency-key my-first-campaign
avair campaigns create --website example.com --assess messaging

`avair campaigns build [id]`

Build a campaign on the server up to a review stop; never launches. With --website it first creates the campaign (as campaigns create) and waits for its targets, then continues

Options:

--stop-at <stage>: where to stop: targets, contacts, ready or launchable (launchable also confirms the overview and runs contact verification and phone checks, which cost nothing)
--website <url>: create a new campaign from this website first (instead of giving an id)
--location <location>: one place to target, for example a state; only with --website
--size <size>: one company size to target, for example 51-200; only with --website
--industry <industry>: one industry to target; only with --website
--channels <channels>: comma-separated: email, manual_call, ai_call, linkedin; only with --website
--content-style <style>: campaign style, lower case with hyphens: standard, competitor-replacement, single-competitor-takeout, event-outreach, local-market-push, list-standard, event-list-follow-up, win-back, customer-expansion, partner-recruitment; only with --website
--idempotency-key <key>: with --website, protects the create step as on create (same key and request returns the same campaign; a different request is refused with 409); not needed for an existing campaign, where the server already returns the build in progress; default: a new random key each run
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair campaigns build --website example.com --location "Texas" --stop-at targets
avair campaigns build CAMPAIGN_ID --stop-at launchable --wait
avair campaigns build --website example.com --content-style win-back --stop-at contacts --wait

`avair campaigns dispatch-status <id>`

Show the progress of a launch or a test start

Options:

--kind <kind>: start or test (default: whichever is newest)

Examples:

avair campaigns dispatch-status CAMPAIGN_ID
avair campaigns dispatch-status CAMPAIGN_ID --kind test

`avair campaigns rename <id>`

Rename a campaign

Options:

--name <name>: the new campaign name
--campaign-version <n>: the campaign version you read

Examples:

avair campaigns rename CAMPAIGN_ID --name "Texas software buyers"

`avair campaigns inputs show <id>`

Show the Step 1 inputs

Examples:

avair campaigns inputs show CAMPAIGN_ID

`avair campaigns inputs edit <id>`

Replace the Step 1 inputs from a JSON file

Options:

--input <file>: JSON with company_profile_json, case_study_json, call_agent_info …

Examples:

avair campaigns inputs edit CAMPAIGN_ID --input inputs.json

`avair campaigns inputs approve <id>`

Generate content (legacy wizard campaigns only)

Options:

--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair campaigns inputs approve CAMPAIGN_ID --wait

`avair campaigns content show <id>`

Show the email templates and call scripts

Examples:

avair campaigns content show CAMPAIGN_ID

`avair campaigns content keep <id>`

Keep a template as it is after the content review flagged it (answers the review note; not an edit)

Options:

--template <templateId>: an email template or call script id from content show
--kind <kind>: email or call (default: "email")
--content-version <n>: content_version from content show

Examples:

avair campaigns content keep CAMPAIGN_ID --template TEMPLATE_ID --content-version 3
avair campaigns content keep CAMPAIGN_ID --template TEMPLATE_ID --kind call --content-version 3

`avair campaigns content edit <id>`

Change one email template or call script

Options:

--template <templateId>: an email template or call script id from content show
--kind <kind>: email or call (default: "email")
--content-version <n>: content_version from content show
--subject <text>: new email subject
--body <text>: new email body
--script <text>: new call script text

Examples:

avair campaigns content edit CAMPAIGN_ID --template TEMPLATE_ID --content-version 3 --subject "A quick question"
avair campaigns content edit CAMPAIGN_ID --template TEMPLATE_ID --kind call --content-version 3 --script "Hello, this is Jane."

`avair campaigns content approve <id>`

Generate targets (legacy wizard campaigns only)

Options:

--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair campaigns content approve CAMPAIGN_ID --wait

`avair campaigns content regenerate <id>`

Draft new content as a preview

Options:

--instructions <text>: what to change or focus on in the new draft
--style <style>: content style for the draft
--language <language>: language for the draft
--channels <csv>: comma-separated: all (default), email, call, linkedin, whatsapp
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair campaigns content regenerate CAMPAIGN_ID --instructions "Shorter and more direct" --wait
avair campaigns content regenerate CAMPAIGN_ID --style standard --language English

`avair campaigns content preview <id>`

Show the draft made by content regenerate

Examples:

avair campaigns content preview CAMPAIGN_ID

`avair campaigns content apply <id>`

Replace the campaign content with the draft

Examples:

avair campaigns content apply CAMPAIGN_ID

`avair campaigns content discard <id>`

Throw away the draft (needs --yes)

Examples:

avair campaigns content discard CAMPAIGN_ID --yes

`avair campaigns targets show <id>`

Show the target accounts and titles

Examples:

avair campaigns targets show CAMPAIGN_ID

`avair campaigns targets edit <id>`

Replace the target accounts and titles from a JSON file

Options:

--input <file>: JSON with accounts_json and titles_json

Examples:

avair campaigns targets edit CAMPAIGN_ID --input targets.json

`avair campaigns targets find-more <id>`

Look for more target accounts

Examples:

avair campaigns targets find-more CAMPAIGN_ID

`avair campaigns targets approve <id>`

Approve targets and generate contacts

Options:

--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair campaigns targets approve CAMPAIGN_ID --wait

`avair campaigns assess run <id>`

Score one step, or every step that has data, and list what to fix

Options:

--step <step>: messaging, content, targets or contacts; default: every step that has data

Examples:

avair campaigns assess run CAMPAIGN_ID
avair campaigns assess run CAMPAIGN_ID --step content --json

`avair campaigns assess apply <id>`

Apply the fixes: all of a step (assessed now), or the ones named from a saved result. Asks first when a fix redoes later steps (needs --yes without a terminal)

Options:

--step <step>: messaging, content, targets or contacts
--input <file>: a result saved from avair campaigns assess --json, with --finding
--finding <ids>: comma-separated suggestion ids from --input; default: apply all

Examples:

avair campaigns assess apply CAMPAIGN_ID --step content
avair campaigns assess apply CAMPAIGN_ID --step content --input assessment.json --finding P11-1 --yes

`avair campaigns contacts show <id>`

List the contacts of the campaign

Options:

--limit <n>: how many rows to return (default: "100")
--skip <n>: rows to skip (default: "0")

Examples:

avair campaigns contacts show CAMPAIGN_ID
avair campaigns contacts show CAMPAIGN_ID --limit 100 --skip 100

`avair campaigns contacts list <id>`

List the contacts of the campaign

Options:

--limit <n>: how many rows to return (default: "100")
--skip <n>: rows to skip (default: "0")

Examples:

avair campaigns contacts list CAMPAIGN_ID
avair campaigns contacts list CAMPAIGN_ID --limit 100

`avair campaigns contacts import-preview <id>`

Show the columns and row count of a CSV; nothing is sent, so it cannot see Do Not Contact rows or the contact limit (contacts add --wait reports those)

Options:

--file <csv>: a CSV with a header row. Needs an email column; optional: first name, last name (or one name column), phone, title, company, LinkedIn URL, website, industry. Header names are matched loosely, ignoring case

Examples:

avair campaigns contacts import-preview CAMPAIGN_ID --file contacts.csv

`avair campaigns contacts add <id>`

Upload a CSV of contacts into the campaign. With --wait, prints how many were added and which rows were left out, and why

Options:

--file <csv>: a CSV with a header row. Needs an email column; optional: first name, last name (or one name column), phone, title, company, LinkedIn URL, website, industry. Header names are matched loosely, ignoring case; rows without a valid email are skipped
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair campaigns contacts add CAMPAIGN_ID --file contacts.csv
avair campaigns contacts add CAMPAIGN_ID --file contacts.csv --wait

`avair campaigns contacts remove <id>`

Remove contacts from the campaign (needs --yes)

Options:

--contact <ids>: comma-separated contact ids

Examples:

avair campaigns contacts remove CAMPAIGN_ID --contact CONTACT_ID --yes
avair campaigns contacts remove CAMPAIGN_ID --contact CONTACT_ID,CONTACT_ID --yes

`avair campaigns contacts find-more <id>`

Look for more contacts

Examples:

avair campaigns contacts find-more CAMPAIGN_ID

`avair campaigns contacts approve <id>`

Finalize contacts (alias of campaigns finalize)

Examples:

avair campaigns contacts approve CAMPAIGN_ID

`avair campaigns contacts verify <id>`

Check the contact emails before launch

Options:

--all: verify every contact, not only unverified ones
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair campaigns contacts verify CAMPAIGN_ID --wait
avair campaigns contacts verify CAMPAIGN_ID --all

`avair campaigns contacts remove-unverified <id>`

Remove contacts that failed the email check (needs --yes)

Options:

--no-red: keep RED contacts
--yellow: also remove YELLOW contacts

Examples:

avair campaigns contacts remove-unverified CAMPAIGN_ID --yes
avair campaigns contacts remove-unverified CAMPAIGN_ID --yellow --yes

`avair campaigns contacts skip-verify <id>`

Attest that contacts need no verification (needs --yes)

Examples:

avair campaigns contacts skip-verify CAMPAIGN_ID --yes

`avair campaigns phones classify <id>`

Classify each phone number from its TCPA checks

Examples:

avair campaigns phones classify CAMPAIGN_ID

`avair campaigns phones status <id>`

Show the phone check results

Examples:

avair campaigns phones status CAMPAIGN_ID

`avair campaigns finalize <id>`

Finalize the contacts step

Examples:

avair campaigns finalize CAMPAIGN_ID

`avair campaigns overview confirm <id>`

Confirm the campaign overview

Examples:

avair campaigns overview confirm CAMPAIGN_ID

`avair campaigns mailboxes list <id>`

List the mailboxes for this campaign

Examples:

avair campaigns mailboxes list CAMPAIGN_ID

`avair campaigns mailboxes set <id>`

Choose the mailboxes for this campaign

Options:

--mailbox <ids>: comma-separated mailbox ids
--warmup: enable warmup on these mailboxes
--campaign-version <n>: the campaign version you read

Examples:

avair campaigns mailboxes set CAMPAIGN_ID --mailbox MAILBOX_ID
avair campaigns mailboxes set CAMPAIGN_ID --mailbox MAILBOX_ID,MAILBOX_ID --warmup

`avair campaigns whatsapp-numbers set <id>`

Set the WhatsApp numbers from a JSON file

Options:

--input <file>: JSON body for the WhatsApp numbers

Examples:

avair campaigns whatsapp-numbers set CAMPAIGN_ID --input whatsapp-numbers.json

`avair campaigns prepare <id>`

Build the campaign up to launchable (same as build --stop-at launchable)

Examples:

avair campaigns prepare CAMPAIGN_ID

`avair campaigns readiness <id>`

Show what blocks launch, with the launch score verdict and its must-fix items

Examples:

avair campaigns readiness CAMPAIGN_ID

`avair campaigns launch <id>`

Start sending the campaign (needs --yes). Lists open must-fix items first

Examples:

avair campaigns launch CAMPAIGN_ID --yes

`avair campaigns test <id>`

Run a test of the campaign (needs --yes)

Options:

--quick: quick test, 2 touches (default)
--full: full test: every step of the sequence, 5 minutes apart
--type <type>: quick or full

Examples:

avair campaigns test CAMPAIGN_ID --quick --yes
avair campaigns test CAMPAIGN_ID --full --yes

`avair campaigns pause <id>`

Pause a running campaign

Examples:

avair campaigns pause CAMPAIGN_ID

`avair campaigns resume <id>`

Resume a paused campaign (needs --yes)

Examples:

avair campaigns resume CAMPAIGN_ID --yes

`avair campaigns cancel <id>`

Cancel the campaign (needs --yes)

Examples:

avair campaigns cancel CAMPAIGN_ID --yes

`avair campaigns copy <id>`

Copy the campaign as a new draft, without its contacts

Examples:

avair campaigns copy CAMPAIGN_ID

`avair campaigns delete <id>`

Delete a draft (needs --yes)

Examples:

avair campaigns delete CAMPAIGN_ID --yes

`avair campaigns retry <id>`

Retry a failed generation

Options:

--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair campaigns retry CAMPAIGN_ID --wait

`avair campaigns share enable <id>`

Turn on the share page

Examples:

avair campaigns share enable CAMPAIGN_ID

`avair campaigns share status <id>`

Show the share page status

Examples:

avair campaigns share status CAMPAIGN_ID

`avair campaigns download <id>`

Download the campaign as a ZIP file

Options:

-o, --output <file>: where to write the ZIP
--platforms <csv>: comma-separated platform folders to include

Examples:

avair campaigns download CAMPAIGN_ID --output campaign.zip

`avair campaigns activity <id>`

Show recent campaign activity and agent actions

Options:

--limit <n>: how many rows to return (default: "50")

Examples:

avair campaigns activity CAMPAIGN_ID
avair campaigns activity CAMPAIGN_ID --limit 20

contacts

Show and update one contact

`avair contacts show <id>`

Show one contact

Examples:

avair contacts show CONTACT_ID

`avair contacts update <id>`

Change a contact status or notes (other fields are refused for agents)

Options:

--status <status>: the new contact status
--notes <text>: notes to save on the contact

Examples:

avair contacts update CONTACT_ID --notes "Asked for a call next week"
avair contacts update CONTACT_ID --status INTERESTED

`avair contacts persona <id>`

Set which version of the content the contact gets: leadership, operational or auto (from the title)

Options:

--persona <persona>: leadership, operational or auto

Examples:

avair contacts persona CONTACT_ID --persona leadership
avair contacts persona CONTACT_ID --persona auto

`avair contacts personalization show <id>`

Show the facts and opener lines

Examples:

avair contacts personalization show CONTACT_ID --json

`avair contacts personalization set <id>`

Replace the opener lines with your own, and/or turn the referral ask on or off (before launch only)

Options:

--line <text>: an opener line; repeat for up to 3 lines
--clear-lines: remove all opener lines
--referral <onOff>: on or off: whether email 1 asks this contact for a referral

Examples:

avair contacts personalization set CONTACT_ID --line "Saw your post on scaling field service."
avair contacts personalization set CONTACT_ID --referral on

`avair contacts preview <id>`

Show every step of the campaign as this contact will receive it

Examples:

avair contacts preview CONTACT_ID
avair contacts preview CONTACT_ID --json

`avair contacts activity <id>`

Show the outreach activity for a contact

Examples:

avair contacts activity CONTACT_ID

tasks

Work the manual task queue

`avair tasks list`

List your manual tasks

Options:

--limit <n>: page size (default: "50")
--page <n>: page number, starting at 1 (default: "1")
--completed: completed tasks instead of open ones
--channel <channel>: only tasks of this channel
--campaign-id <id>: only tasks of this campaign

Examples:

avair tasks list
avair tasks list --channel EMAIL --limit 20
avair tasks list --completed --page 2

`avair tasks show <id>`

Show one task

Examples:

avair tasks show TASK_ID

`avair tasks start <id>`

Claim a task and start working on it

Examples:

avair tasks start TASK_ID

`avair tasks complete <id>`

Mark a task done with its outcome

Options:

--outcome <outcome>: the result of the task
--notes <notes>: notes to save on the task

Examples:

avair tasks complete TASK_ID --outcome COMPLETED --notes "Left a voicemail"

`avair tasks skip <id>`

Skip a task

Options:

--reason <reason>: why the task is skipped

Examples:

avair tasks skip TASK_ID --reason "Wrong person"

`avair tasks reply <id>`

Decide on a drafted reply (sending it needs --yes)

Options:

--decision <decision>: APPROVE, REJECT, EDIT or SEND_TEMPLATE
--draft-version <n>: the version from reply-draft
--subject <subject>: the new subject, for EDIT
--body <body>: the new body, for EDIT

Examples:

avair tasks reply TASK_ID --decision REJECT --draft-version 1
avair tasks reply TASK_ID --decision APPROVE --draft-version 1 --yes

`avair tasks reply-draft <id>`

Show the drafted reply for a task

Examples:

avair tasks reply-draft TASK_ID

`avair tasks reply-decide <id>`

Send or discard a drafted reply (--send needs --yes)

Options:

--send: send the drafted reply (needs --yes)
--discard: discard the draft
--draft-version <n>: the version from reply-draft
--subject <subject>: send this subject instead
--body <body>: send this body instead

Examples:

avair tasks reply-decide TASK_ID --send --draft-version 1 --yes
avair tasks reply-decide TASK_ID --discard --draft-version 1

events

Campaign, contact or activity changes

`avair events list`

Read changes from the feed, page by page

Options:

--type <type>: campaigns, contacts or activities
--cursor <cursor>: continue after this position
--status <status>: only changes with this status
--campaign-id <id>: only changes of this campaign
--limit <n>: page size (default: "50")
--follow: keep reading new changes until stopped

Examples:

avair events list --type campaigns
avair events list --type activities --campaign-id CAMPAIGN_ID --limit 100
avair events list --type contacts --follow

companies

Company Knowledge: profile, defaults, use cases, documents, messaging

`avair companies list`

List your companies

Options:

--include-archived: also list archived companies

Examples:

avair companies list
avair companies list --include-archived

`avair companies show <id>`

Show one company

Examples:

avair companies show COMPANY_ID

`avair companies fill <id>`

Read the company's website into its profile

Options:

--website <url>: the company website to read
--overwrite-edited: also replace fields a person edited
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair companies fill COMPANY_ID --website https://example.com --wait
avair companies fill COMPANY_ID --website example.com --overwrite-edited

`avair companies profile edit <id>`

Replace the company profile from a JSON file

Options:

--input <file>: JSON profile (or {"profile": …, "website_url": …})

Examples:

avair companies profile edit COMPANY_ID --input profile.json

`avair companies defaults show <id>`

Show the default campaign settings

Examples:

avair companies defaults show COMPANY_ID

`avair companies defaults edit <id>`

Replace the default campaign settings from a JSON file (not the standard sequence: use defaults sequence set)

Options:

--input <file>: JSON defaults (or {"defaults": …})

Examples:

avair companies defaults edit COMPANY_ID --input defaults.json

`avair companies defaults sequence set <id>`

Set the standard sequence from a JSON file of steps, or go back to the app standard

Options:

--input <file>: JSON array of steps (or {"steps": […]})
--app-default: use the app's standard sequence again

Examples:

avair companies defaults sequence set COMPANY_ID --input steps.json
avair companies defaults sequence set COMPANY_ID --app-default

`avair companies use-cases list <id>`

List the use cases

Options:

--include-archived: also list archived use cases

Examples:

avair companies use-cases list COMPANY_ID
avair companies use-cases list COMPANY_ID --include-archived

`avair companies use-cases add <id>`

Add a use case from text or from a file

Options:

--title <title>: the use case title
--text <text>: the use case story as text (or use --file)
--file <path>: a document to read the story from (or use --text)

Examples:

avair companies use-cases add COMPANY_ID --title "Faster onboarding" --text "A customer cut onboarding time in half."
avair companies use-cases add COMPANY_ID --title "Faster onboarding" --file story.docx

`avair companies use-cases edit <id> <useCaseId>`

Change the title or text of a use case

Options:

--title <title>: the new title
--text <text>: the new story text

Examples:

avair companies use-cases edit COMPANY_ID USE_CASE_ID --title "Faster onboarding"

`avair companies use-cases archive <id> <useCaseId>`

Archive a use case

Examples:

avair companies use-cases archive COMPANY_ID USE_CASE_ID

`avair companies documents list <id>`

List the documents

Examples:

avair companies documents list COMPANY_ID

`avair companies documents show <id> <documentId>`

Show one document

Examples:

avair companies documents show COMPANY_ID DOCUMENT_ID

`avair companies documents upload <id>`

Upload a document for the company

Options:

--file <path>: the file to upload
--title <title>: the document title (default: the file name)
--kind <kind>: document kind, e.g. PRICING or MESSAGING
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair companies documents upload COMPANY_ID --file pricing.pdf --kind PRICING --wait
avair companies documents upload COMPANY_ID --file brochure.pdf --title "Product brochure"

`avair companies documents retry <id> <documentId>`

Read a document again after it failed

Examples:

avair companies documents retry COMPANY_ID DOCUMENT_ID

`avair companies messaging show <id>`

Show the messaging framework

Examples:

avair companies messaging show COMPANY_ID

`avair companies messaging build <id>`

Build the messaging framework from the website and documents

Options:

--overwrite-edited: also replace sections a person edited
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair companies messaging build COMPANY_ID --wait
avair companies messaging build COMPANY_ID --overwrite-edited

`avair companies messaging export <id>`

Download the messaging framework as a .docx file

Options:

-o, --output <file>: where to write the .docx

Examples:

avair companies messaging export COMPANY_ID --output messaging.docx

playbooks

Plan, build and run playbooks

`avair playbooks list`

List playbooks

Examples:

avair playbooks list

`avair playbooks show <id>`

Show one playbook

Examples:

avair playbooks show PLAYBOOK_ID

`avair playbooks status <id>`

Show the analysis status of a playbook

Examples:

avair playbooks status PLAYBOOK_ID

`avair playbooks create`

Create a playbook from a website

Options:

--website <url>: the company website to plan from
--revenue <amount>: annual revenue goal
--deal-size <amount>: average deal size
--icp-notes <text>: notes about the ideal customer
--no-analyze: create without starting the analysis
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair playbooks create --website https://example.com --wait
avair playbooks create --website example.com --revenue 1000000 --deal-size 25000 --icp-notes "Mid-size software firms in Texas"

`avair playbooks analyze <id>`

Start the analysis of a playbook

Options:

--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair playbooks analyze PLAYBOOK_ID --wait

`avair playbooks refine <id>`

Change the plan with written instructions

Options:

--text <instructions>: what to change in the plan
--size-to-goal: size the plan to the goal
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair playbooks refine PLAYBOOK_ID --text "Focus on the United States" --wait
avair playbooks refine PLAYBOOK_ID --text "Fit the plan to the goal" --size-to-goal

`avair playbooks goal show <id>`

Show the revenue goal

Examples:

avair playbooks goal show PLAYBOOK_ID

`avair playbooks goal set <id>`

Set the revenue goal and the funnel it needs

Options:

--revenue <amount>: annual revenue goal
--deal-size <amount>: average deal size
--rates <mql,opportunity,proposal>: your own funnel rates, as three percentages

Examples:

avair playbooks goal set PLAYBOOK_ID --revenue 1000000 --deal-size 25000
avair playbooks goal set PLAYBOOK_ID --revenue 1000000 --deal-size 25000 --rates 20,30,25

`avair playbooks pace set <id>`

Set the pace for the team

Options:

--per-person <n>: campaigns per person per period
--auto: let the plan set each person's pace

Examples:

avair playbooks pace set PLAYBOOK_ID --per-person 3
avair playbooks pace set PLAYBOOK_ID --auto

`avair playbooks team list <id>`

List the people

Examples:

avair playbooks team list PLAYBOOK_ID

`avair playbooks team add <id>`

Add a person

Options:

--name <name>: the name of the person

Examples:

avair playbooks team add PLAYBOOK_ID --name "Jane Doe"

`avair playbooks team rename <id> <participantId>`

Rename a person

Options:

--name <name>: the new name

Examples:

avair playbooks team rename PLAYBOOK_ID PARTICIPANT_ID --name "Jane Doe"

`avair playbooks team runs <id> <participantId>`

Set whether this person runs campaigns

Options:

--on: this person runs campaigns
--off: this person does not run campaigns
--check: show the effect without saving

Examples:

avair playbooks team runs PLAYBOOK_ID PARTICIPANT_ID --on
avair playbooks team runs PLAYBOOK_ID PARTICIPANT_ID --off --check

`avair playbooks items list <id>`

List the items

Examples:

avair playbooks items list PLAYBOOK_ID

`avair playbooks items set <id> <itemId>`

Change the state, priority or owner of an item

Options:

--state <state>: the new state
--priority <n>: the new priority number
--assign <participantId>: the person who owns the item

Examples:

avair playbooks items set PLAYBOOK_ID ITEM_ID --state ACCEPTED
avair playbooks items set PLAYBOOK_ID ITEM_ID --priority 1 --assign PARTICIPANT_ID

`avair playbooks items bulk-state <id>`

Set the same state on several items

Options:

--items <ids>: comma-separated item ids
--state <state>: the new state

Examples:

avair playbooks items bulk-state PLAYBOOK_ID --items ITEM_ID,ITEM_ID --state ACCEPTED

`avair playbooks items build <id> <itemId>`

Build one campaign from the plan (needs --yes)

Examples:

avair playbooks items build PLAYBOOK_ID ITEM_ID --yes

`avair playbooks items cancel <id> <itemId>`

Cancel an item

Examples:

avair playbooks items cancel PLAYBOOK_ID ITEM_ID

`avair playbooks build-all <id>`

Build every proposed or accepted item (needs --yes)

Examples:

avair playbooks build-all PLAYBOOK_ID --yes

`avair playbooks versions list <id>`

List the versions

Examples:

avair playbooks versions list PLAYBOOK_ID

`avair playbooks versions restore <id> <versionId>`

Restore an earlier version of the plan

Examples:

avair playbooks versions restore PLAYBOOK_ID VERSION_ID

`avair playbooks automation on <id>`

Turn automation on (needs --yes)

Options:

--execute: build and launch (default: build only)

Examples:

avair playbooks automation on PLAYBOOK_ID --yes
avair playbooks automation on PLAYBOOK_ID --execute --yes

`avair playbooks automation off <id>`

Turn automation off (no --yes needed)

Examples:

avair playbooks automation off PLAYBOOK_ID

`avair playbooks automation check <id>`

What would block automation

Options:

--execute: check build and launch, not only build

Examples:

avair playbooks automation check PLAYBOOK_ID
avair playbooks automation check PLAYBOOK_ID --execute

tools

Quote and run Avair data tools

`avair tools credits`

Show your Tools credit balance

Examples:

avair tools credits

`avair tools balance`

Show your Tools credit balance

Examples:

avair tools balance

`avair tools runs list`

List Tools runs

Options:

--tool-type <type>: only runs of this tool
--status <status>: only runs with this status
--mine: only your own runs
--limit <n>: page size (default: "20")

Examples:

avair tools runs list
avair tools runs list --mine --status COMPLETED --limit 10

`avair tools runs show <runId>`

Show one Tools run

Examples:

avair tools runs show RUN_ID

`avair tools runs export <runId>`

Download the results of a run as a CSV file

Options:

-o, --output <file>: where to write the CSV

Examples:

avair tools runs export RUN_ID --output results.csv

`avair tools runs cancel <runId>`

Stop future work of a Tools run

Examples:

avair tools runs cancel RUN_ID

`avair tools list`

List Tools runs

Options:

--tool-type <type>: only runs of this tool
--status <status>: only runs with this status
--mine: only your own runs
--limit <n>: page size (default: "20")

Examples:

avair tools list
avair tools list --tool-type find-accounts --mine

`avair tools status <runId>`

Show one Tools run

Examples:

avair tools status RUN_ID

`avair tools results <runId>`

Show the results of a Tools run

Examples:

avair tools results RUN_ID

`avair tools cancel <runId>`

Stop future work of a Tools run

Examples:

avair tools cancel RUN_ID

`avair tools find-accounts quote`

Show the credit cost without starting a run

Options:

--idempotency-key <key>: a retry with the same key and the same request returns the same run, not a second one; default: a new random key each run
--website <url>: your company website, used to find matching accounts
--cap <n>: most accounts to find (up to 40; 5 on a trial) (default: "10")
--industries <csv>: comma-separated industries to look in
--sizes <csv>: comma-separated company sizes
--locations <csv>: comma-separated places

Examples:

avair tools find-accounts quote --website example.com
avair tools find-accounts quote --website example.com --cap 20 --industries "Software,Fintech" --locations "Texas,Ohio"

`avair tools find-accounts start`

Start a run and reserve its credits (needs --yes)

Options:

--idempotency-key <key>: a retry with the same key and the same request returns the same run, not a second one; default: a new random key each run
--website <url>: your company website, used to find matching accounts
--cap <n>: most accounts to find (up to 40; 5 on a trial) (default: "10")
--industries <csv>: comma-separated industries to look in
--sizes <csv>: comma-separated company sizes
--locations <csv>: comma-separated places
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair tools find-accounts start --website example.com --yes
avair tools find-accounts start --website example.com --cap 20 --sizes "51-200" --wait --yes

`avair tools find-contacts quote`

Show the credit cost without starting a run

Options:

--idempotency-key <key>: a retry with the same key and the same request returns the same run, not a second one; default: a new random key each run
--account <name>: the company name
--titles <csv>: comma-separated job titles to look for
--domain <domain>: the company web domain
--depth <n>: most contacts to find for the account (up to 15; 5 on a trial) (default: "15")

Examples:

avair tools find-contacts quote --account "Example Inc" --titles "VP Sales,Head of Marketing"

`avair tools find-contacts start`

Start a run and reserve its credits (needs --yes)

Options:

--idempotency-key <key>: a retry with the same key and the same request returns the same run, not a second one; default: a new random key each run
--account <name>: the company name
--titles <csv>: comma-separated job titles to look for
--domain <domain>: the company web domain
--depth <n>: most contacts to find for the account (up to 15; 5 on a trial) (default: "15")
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair tools find-contacts start --account "Example Inc" --titles "VP Sales" --yes
avair tools find-contacts start --account "Example Inc" --titles "VP Sales,Head of Marketing" --domain example.com --depth 10 --wait --yes

`avair tools enrich-contacts quote`

Show the credit cost without starting a run

Options:

--idempotency-key <key>: a retry with the same key and the same request returns the same run, not a second one; default: a new random key each run
--company <name>: the company name
--first-name <name>: the contact first name
--last-name <name>: the contact last name
--email <email>: the contact email
--domain <domain>: the company web domain
--linkedin <url>: the contact LinkedIn profile URL

Examples:

avair tools enrich-contacts quote --company "Example Inc" --email jane@example.com

`avair tools enrich-contacts start`

Start a run and reserve its credits (needs --yes)

Options:

--idempotency-key <key>: a retry with the same key and the same request returns the same run, not a second one; default: a new random key each run
--company <name>: the company name
--first-name <name>: the contact first name
--last-name <name>: the contact last name
--email <email>: the contact email
--domain <domain>: the company web domain
--linkedin <url>: the contact LinkedIn profile URL
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair tools enrich-contacts start --company "Example Inc" --email jane@example.com --yes
avair tools enrich-contacts start --company "Example Inc" --first-name Jane --last-name Doe --linkedin https://www.linkedin.com/in/example --wait --yes

`avair tools phone-tcpa-check quote`

Show the credit cost without starting a run

Options:

--idempotency-key <key>: a retry with the same key and the same request returns the same run, not a second one; default: a new random key each run
--phone <number>: the phone number to check

Examples:

avair tools phone-tcpa-check quote --phone "+1 555 010 0100"

`avair tools phone-tcpa-check start`

Start a run and reserve its credits (needs --yes)

Options:

--idempotency-key <key>: a retry with the same key and the same request returns the same run, not a second one; default: a new random key each run
--phone <number>: the phone number to check
--wait: wait until the server finishes this step
--timeout <seconds>: give up waiting after this many seconds (default: "900")

Examples:

avair tools phone-tcpa-check start --phone "+1 555 010 0100" --yes

api

Call an agent API route directly (unsupported contract: routes and fields may change without a CLI release); api list [--filter] and api describe METHOD PATH read the runtime spec

`avair api <method> [path] [routePath]`

Call an agent API route directly (unsupported contract: routes and fields may change without a CLI release); api list [--filter] and api describe METHOD PATH read the runtime spec

Options:

--body <json>: JSON body as text
--input <file>: JSON body from a file
--filter <text>: for api list: only routes that match this text

Examples:

avair api GET /users/me
avair api list --filter campaigns
avair api describe GET /campaigns/

mcp

Connect an AI app to Avair over MCP

`avair mcp setup`

Add Avair to the MCP settings of an AI app

Options:

--client <name>: claude-code, cursor, codex, claude-desktop, claude-ai or chatgpt (cursor and codex: writes a config file; claude-code: runs claude mcp add when claude is installed; the others: prints instructions)
--print: show the change and write nothing
--force: replace an existing Avair entry

Examples:

avair mcp setup --client claude-code
avair mcp setup --client cursor --print
avair mcp setup --client codex --force

skill

Agent skills for Avair

`avair skill install`

Copy the Avair skills into the skills folder of an agent

Options:

--agent <agent>: claude-code or codex
--dir <path>: install into this folder instead
--force: replace skill folders that already exist

Examples:

avair skill install --agent claude-code
avair skill install --dir ./skills --force