terminal

cmdhub adapter

Hubspot CLI
for cmdhub.

Hubspot resources through the cmdhub CLI.

lock Auth: oauth

Quick Install cmdhub get hubspot

data_object Agent Contract

Agents should start with auth/status and discovery commands, inspect schemas before composition, and treat commands marked as mutating as state-changing operations.

catalog.json Markdown

Output

Use human output for normal reads, `--json` for scripting or complete structured fields, and `--jsonl` for upstream pipe inputs.

Auth

oauth

Refs

Prefer list/search, then short refs or piped JSONL. Use `resolve` to inspect cached refs.

Schemas

Use `hubspot schema` and `catalog.json` to inspect fields, flags, examples, and side effects.

terminal Command Reference

Generated from source. Global flags apply to all commands.

Global Flags

--json bool Emit JSON machine output

--jsonl bool Emit JSONL records for piping

--output, -o string Compatibility output mode: json|jsonl. Prefer --json or --jsonl

--view string = summary View mode: summary|full

--profile string = default Config/auth profile

--config string Config path override

--quiet, -q bool Suppress non-essential diagnostics

--debug bool Enable debug diagnostics

--limit int = 50 Maximum items to emit

--page-size int = 50 Requested upstream page size

--cursor string Continuation cursor

--no-paginate bool Fetch only one page

--version, -v bool Print version information

hubspot association Manage exact HubSpot CRM associations

#cmd-hubspot-association discovery safe

$ hubspot association --help

hubspot association add Associate two exact HubSpot CRM records

#cmd-hubspot-association-add mutates state

--from string Source object type or object:ref, such as contact or contact:ct1

--label string Association type ID from association types; omitted uses HubSpot default for the pair

--to string Target object type or object:ref, such as company or company:co1

$ hubspot association add --from contact:ct1 --to company:co1

$ hubspot association add --help

$ hubspot association types --from contact --to company

hubspot association list List HubSpot associations from an exact record

#cmd-hubspot-association-list discovery safe

--from string Source object type or object:ref, such as contact or contact:ct1

--to string Target object type or object:ref, such as company or company:co1

$ hubspot association list

$ hubspot association list --from contact:ct1 --to company

$ hubspot contact search --query ada

hubspot association remove Remove an exact HubSpot CRM association

#cmd-hubspot-association-remove mutates state dry-run

--dry-run bool Preview the exact association removal without mutating HubSpot

--from string Source object type or object:ref, such as contact or contact:ct1

--to string Target object type or object:ref, such as company or company:co1

--yes bool Confirm removal of the exact association

$ hubspot association remove --from contact:ct1 --to company:co1 --dry-run

$ hubspot association remove --from contact:ct1 --to company:co1 --yes

$ hubspot association remove --help

hubspot association types List HubSpot association labels

#cmd-hubspot-association-types discovery safe

--from string Source object type or object:ref, such as contact or contact:ct1

--to string Target object type or object:ref, such as company or company:co1

$ hubspot association types

$ hubspot association types --from contact --to company

hubspot auth Manage HubSpot authentication

#cmd-hubspot-auth discovery safe

$ hubspot auth --help

hubspot auth login Authenticate with a HubSpot OAuth grant

#cmd-hubspot-auth-login mutates state

Starts HubSpot OAuth login for a HubSpot OAuth access token and refresh token through the cmdhub website broker. Normal users do not need a HubSpot OAuth client ID or client secret.

$ hubspot auth login

$ hubspot auth login --help

$ hubspot auth status

hubspot auth logout Remove stored HubSpot OAuth credentials

#cmd-hubspot-auth-logout mutates state

Deletes the selected profile’s HubSpot OAuth access token and refresh token from the shared credential backend.

$ hubspot auth login

$ hubspot auth logout

$ hubspot auth logout --help

hubspot auth refresh Refresh the stored HubSpot OAuth access token

#cmd-hubspot-auth-refresh mutates state

Refreshes the selected profile’s HubSpot OAuth access token using maintainer OAuth app credentials when configured; otherwise rerun hubspot auth login to renew through the broker.

$ hubspot auth refresh

$ hubspot auth refresh --help

$ hubspot auth status

hubspot auth status Show HubSpot OAuth auth status

#cmd-hubspot-auth-status discovery safe

Reports whether the selected profile has a stored HubSpot OAuth access token and refresh token, whether the access token is valid, and whether required HubSpot OAuth scopes are present.

$ hubspot auth status

$ hubspot auth status --help

$ hubspot auth status --json

hubspot auth whoami Show the current HubSpot user and portal

#cmd-hubspot-auth-whoami discovery safe

Verifies the stored HubSpot OAuth access token and shows the configured HubSpot user and portal.

$ hubspot auth whoami

$ hubspot auth whoami --help

$ hubspot auth whoami --json

hubspot capabilities Describe capabilities

#cmd-hubspot-capabilities discovery safe

$ hubspot capabilities --help

hubspot cleanup Plan, run, and verify bounded cleanup of disposable HubSpot CRM data

#cmd-hubspot-cleanup discovery safe

$ hubspot cleanup --help

hubspot cleanup plan Preview disposable cmdhub CRM records and write a cleanup manifest

#cmd-hubspot-cleanup-plan discovery safe

--manifest string Cleanup manifest path; defaults under apps/hubspot-cli/lifecycle/live

--objects string Comma-separated object set: contacts, companies, deals, tickets, notes

--token string Disposable cmdhub-* token to search for

$ hubspot cleanup plan

$ hubspot cleanup plan --token cmdhub-eval-20260607 --objects contacts,companies

hubspot cleanup run Delete only records listed in a cleanup manifest

#cmd-hubspot-cleanup-run discovery safe

--manifest string Cleanup manifest path from cleanup plan

--yes bool Confirm deletion of only records listed in the manifest

$ hubspot cleanup run --help

$ hubspot cleanup run --manifest apps/hubspot-cli/lifecycle/live/cleanup-cmdhub-eval-20260607.json --yes

hubspot cleanup verify Verify disposable cmdhub CRM records are gone

#cmd-hubspot-cleanup-verify discovery safe

--manifest string Cleanup manifest path to verify

--objects string Comma-separated object set: contacts, companies, deals, tickets, notes

--token string Disposable cmdhub-* token to search for

$ hubspot cleanup verify

$ hubspot cleanup verify --token cmdhub-eval-20260607 --objects contacts,companies

hubspot company Work with HubSpot company records

#cmd-hubspot-company discovery safe

$ hubspot company --help

hubspot company create Create a HubSpot company

#cmd-hubspot-company-create mutates state

--domain string Company domain

--lifecycle-stage string Company lifecycle stage

--name string Company name

--owner string HubSpot owner ID or ref

--property stringArray = [] Additional HubSpot property as name=value

$ hubspot company create --help

$ hubspot company create --name "Cmdhub Eval" --domain example.invalid

hubspot company delete Delete an exact HubSpot company

#cmd-hubspot-company-delete mutates state

--yes bool Confirm deletion of the exact displayed record

$ hubspot company delete --help

$ hubspot company delete co1 --yes

$ hubspot company search --query cmdhub-eval --limit 5

hubspot company get Inspect a HubSpot company

#cmd-hubspot-company-get discovery safe

$ hubspot company get

$ hubspot company get co1 --view full

$ hubspot company search --query cmdhub --limit 5

hubspot company list List HubSpot companies

#cmd-hubspot-company-list discovery safe

--filter stringArray = [] Property filter as name=value or name:OP:value

$ hubspot company get co1 --view full

$ hubspot company list

$ hubspot company list --limit 10

hubspot company search Search HubSpot companies

#cmd-hubspot-company-search discovery safe

--filter stringArray = [] Property filter as name=value or name:OP:value

--query string Text to search across HubSpot default searchable properties

$ hubspot company get co1 --view full

$ hubspot company search

$ hubspot company search --query cmdhub --limit 5

$ hubspot company search --query example --limit 5

hubspot company update Update an exact HubSpot company

#cmd-hubspot-company-update mutates state

--domain string Company domain

--lifecycle-stage string Company lifecycle stage

--name string Company name

--owner string HubSpot owner ID or ref

--property stringArray = [] HubSpot property update as name=value

$ hubspot company search --query cmdhub --limit 5

$ hubspot company update --help

$ hubspot company update co1 --property lifecyclestage=customer

hubspot config Inspect local configuration

#cmd-hubspot-config discovery safe

$ hubspot config --help

hubspot config explain Explain resolved configuration

#cmd-hubspot-config-explain discovery safe

$ hubspot config explain --help

hubspot contact Work with HubSpot contact records

#cmd-hubspot-contact discovery safe

$ hubspot contact --help

hubspot contact create Create a HubSpot contact

#cmd-hubspot-contact-create mutates state

--email string Contact email

--first-name string Contact first name

--last-name string Contact last name

--lifecycle-stage string Contact lifecycle stage

--owner string HubSpot owner ID or ref

--property stringArray = [] Additional HubSpot property as name=value

$ hubspot contact create --email cmdhub-eval@example.com --first-name Cmdhub

$ hubspot contact create --email cmdhub-eval@example.com --first-name Cmdhub --last-name Eval

$ hubspot contact create --help

hubspot contact delete Delete an exact HubSpot contact

#cmd-hubspot-contact-delete mutates state

--yes bool Confirm deletion of the exact displayed record

$ hubspot contact delete --help

$ hubspot contact delete ct1 --yes

$ hubspot contact search --query cmdhub-eval --limit 5

hubspot contact get Inspect a HubSpot contact

#cmd-hubspot-contact-get discovery safe

$ hubspot contact get

$ hubspot contact get ct1 --view full

$ hubspot contact search --query cmdhub --limit 5

hubspot contact list List HubSpot contacts

#cmd-hubspot-contact-list discovery safe

--filter stringArray = [] Property filter as name=value or name:OP:value

$ hubspot contact get ct1 --view full

$ hubspot contact list

$ hubspot contact list --limit 10

hubspot contact search Search HubSpot contacts

#cmd-hubspot-contact-search discovery safe

--filter stringArray = [] Property filter as name=value or name:OP:value

--query string Text to search across HubSpot default searchable properties

$ hubspot contact get ct1 --view full

$ hubspot contact search

$ hubspot contact search --query alice --limit 5

$ hubspot contact search --query cmdhub --limit 5

hubspot contact update Update an exact HubSpot contact

#cmd-hubspot-contact-update mutates state

--email string Contact email

--first-name string Contact first name

--last-name string Contact last name

--lifecycle-stage string Contact lifecycle stage

--owner string HubSpot owner ID or ref

--property stringArray = [] HubSpot property update as name=value

$ hubspot contact search --query cmdhub --limit 5

$ hubspot contact update --help

$ hubspot contact update ct1 --lifecycle-stage customer

hubspot deal Work with HubSpot deal records

#cmd-hubspot-deal discovery safe

$ hubspot deal --help

hubspot deal create Create a HubSpot deal

#cmd-hubspot-deal-create mutates state

--amount string Deal amount

--close-date string Deal close date

--name string Deal name

--owner string HubSpot owner ID or ref

--pipeline string Deal pipeline ID or ref

--property stringArray = [] Additional HubSpot property as name=value

--stage string Deal stage ID or ref

$ hubspot deal create --help

$ hubspot deal create --name "Cmdhub Eval Renewal" --amount 1000 --stage appointmentscheduled

hubspot deal delete Delete an exact HubSpot deal

#cmd-hubspot-deal-delete mutates state

--yes bool Confirm deletion of the exact displayed record

$ hubspot deal delete --help

$ hubspot deal delete d1 --yes

$ hubspot deal search --query cmdhub-eval --limit 5

hubspot deal get Inspect a HubSpot deal

#cmd-hubspot-deal-get discovery safe

$ hubspot deal get

$ hubspot deal get d1 --view full

$ hubspot deal search --query cmdhub --limit 5

hubspot deal list List HubSpot deals

#cmd-hubspot-deal-list discovery safe

--filter stringArray = [] Property filter as name=value or name:OP:value

$ hubspot deal get d1 --view full

$ hubspot deal list

$ hubspot deal list --limit 10

hubspot deal move Move a HubSpot deal to another stage

#cmd-hubspot-deal-move discovery safe

--pipeline string Pipeline ref or pipeline ID

--stage string Stage ref, stage ID, or stage label

$ hubspot deal move --help

$ hubspot deal move d1 --stage s2

$ hubspot pipeline list --object deal

hubspot deal search Search HubSpot deals

#cmd-hubspot-deal-search discovery safe

--filter stringArray = [] Property filter as name=value or name:OP:value

--query string Text to search across HubSpot default searchable properties

$ hubspot deal get d1 --view full

$ hubspot deal search

$ hubspot deal search --query cmdhub --limit 5

hubspot deal update Update an exact HubSpot deal

#cmd-hubspot-deal-update mutates state

--amount string Deal amount

--close-date string Deal close date

--name string Deal name

--owner string HubSpot owner ID or ref

--pipeline string Deal pipeline ID or ref

--property stringArray = [] HubSpot property update as name=value

--stage string Deal stage ID or ref

$ hubspot deal search --query cmdhub --limit 5

$ hubspot deal update --help

$ hubspot deal update d1 --amount 2500

hubspot doctor Run diagnostics

#cmd-hubspot-doctor discovery safe

$ hubspot doctor --help

hubspot login Authenticate with a HubSpot OAuth grant

#cmd-hubspot-login mutates state

Starts HubSpot OAuth login for a HubSpot OAuth access token and refresh token through the cmdhub website broker. Normal users do not need a HubSpot OAuth client ID or client secret.

$ hubspot auth status

$ hubspot login

hubspot logout Remove stored HubSpot OAuth credentials

#cmd-hubspot-logout mutates state

Deletes the selected profile’s HubSpot OAuth access token and refresh token from the shared credential backend.

$ hubspot auth login

$ hubspot logout

hubspot note Work with HubSpot CRM notes

#cmd-hubspot-note discovery safe

$ hubspot note --help

hubspot note create Create a HubSpot CRM note

#cmd-hubspot-note-create mutates state

--body string Note body

--company string Company ref or ID to associate

--contact string Contact ref or ID to associate

--deal string Deal ref or ID to associate

--ticket string Ticket ref or ID to associate

$ hubspot contact search --query cmdhub --limit 5

$ hubspot note create --contact ct1 --body "Left voicemail."

$ hubspot note create --help

hubspot note delete Delete an exact HubSpot CRM note

#cmd-hubspot-note-delete mutates state

--yes bool Confirm deletion of the exact displayed note

$ hubspot note delete --help

$ hubspot note delete n1 --yes

hubspot note get Inspect a HubSpot CRM note

#cmd-hubspot-note-get discovery safe

$ hubspot note get

$ hubspot note get n1 --view full

hubspot note update Update an exact HubSpot CRM note

#cmd-hubspot-note-update mutates state

--body string Updated note body

--property stringArray = [] HubSpot note property update as name=value

$ hubspot note update --help

$ hubspot note update n1 --body "Updated context."

hubspot owner Discover HubSpot owners

#cmd-hubspot-owner discovery safe

$ hubspot owner --help

hubspot owner list List HubSpot owners

#cmd-hubspot-owner-list discovery safe

$ hubspot owner list

$ hubspot owner list --json

hubspot pipeline Discover HubSpot deal and ticket pipelines

#cmd-hubspot-pipeline discovery safe

$ hubspot pipeline --help

hubspot pipeline get Inspect a HubSpot pipeline and cache stages

#cmd-hubspot-pipeline-get discovery safe

--object string = deal Pipeline object: deal or ticket

$ hubspot pipeline get

$ hubspot pipeline get p1 --view full

$ hubspot pipeline list --object deal

hubspot pipeline list List HubSpot pipelines

#cmd-hubspot-pipeline-list discovery safe

--object string = deal Pipeline object: deal or ticket

$ hubspot pipeline get p1

$ hubspot pipeline list

$ hubspot pipeline list --object deal

hubspot profile Manage provider profiles

#cmd-hubspot-profile discovery safe

$ hubspot profile --help

hubspot profile create Create an unauthenticated provider profile

#cmd-hubspot-profile-create mutates state

$ hubspot profile create --help

hubspot profile delete Delete a local provider profile

#cmd-hubspot-profile-delete mutates state

$ hubspot profile delete --help

hubspot profile list List provider profiles

#cmd-hubspot-profile-list discovery safe

$ hubspot profile list --help

hubspot profile rename Rename a local provider profile

#cmd-hubspot-profile-rename discovery safe

$ hubspot profile rename --help

hubspot profile use Set the default provider profile

#cmd-hubspot-profile-use mutates state

$ hubspot profile use --help

hubspot property Discover HubSpot CRM properties

#cmd-hubspot-property discovery safe

$ hubspot property --help

hubspot property get Inspect a HubSpot property

#cmd-hubspot-property-get discovery safe

--object string = contact CRM object: contact, company, deal, or ticket

$ hubspot property get

$ hubspot property get pr1 --view full

$ hubspot property search --object contact --query lifecycle

hubspot property list List HubSpot properties

#cmd-hubspot-property-list discovery safe

--object string = contact CRM object: contact, company, deal, or ticket

$ hubspot property get pr1 --object contact

$ hubspot property list

$ hubspot property list --object contact

hubspot property search Search HubSpot properties

#cmd-hubspot-property-search discovery safe

--object string = contact CRM object: contact, company, deal, or ticket

--query string Text to match against property label, name, or description

$ hubspot property get pr1 --object contact

$ hubspot property search

$ hubspot property search --object contact --query lifecycle

hubspot resolve Resolve a local ref, short id, or URL alias

#cmd-hubspot-resolve discovery safe

$ hubspot resolve --help

$ hubspot resolve <ref>

hubspot schema Emit schema hints

#cmd-hubspot-schema discovery safe

--in bool Show input schema

--out bool Show output schema

$ hubspot schema --help

hubspot ticket Work with HubSpot ticket records

#cmd-hubspot-ticket discovery safe

$ hubspot ticket --help

hubspot ticket create Create a HubSpot ticket

#cmd-hubspot-ticket-create mutates state

--content string Ticket content

--owner string HubSpot owner ID or ref

--pipeline string Ticket pipeline ID or ref

--priority string Ticket priority

--property stringArray = [] Additional HubSpot property as name=value

--stage string Ticket stage ID or ref

--subject string Ticket subject

$ hubspot ticket create --help

$ hubspot ticket create --subject "Cmdhub Eval Ticket" --priority LOW

hubspot ticket delete Delete an exact HubSpot ticket

#cmd-hubspot-ticket-delete mutates state

--yes bool Confirm deletion of the exact displayed record

$ hubspot ticket delete --help

$ hubspot ticket delete tk1 --yes

$ hubspot ticket search --query cmdhub-eval --limit 5

hubspot ticket get Inspect a HubSpot ticket

#cmd-hubspot-ticket-get discovery safe

$ hubspot ticket get

$ hubspot ticket get tk1 --view full

$ hubspot ticket search --query cmdhub --limit 5

hubspot ticket list List HubSpot tickets

#cmd-hubspot-ticket-list discovery safe

--filter stringArray = [] Property filter as name=value or name:OP:value

$ hubspot ticket get tk1 --view full

$ hubspot ticket list

$ hubspot ticket list --limit 10

hubspot ticket move Move a HubSpot ticket to another stage

#cmd-hubspot-ticket-move discovery safe

--pipeline string Pipeline ref or pipeline ID

--stage string Stage ref, stage ID, or stage label

$ hubspot pipeline list --object ticket

$ hubspot ticket move --help

$ hubspot ticket move tk1 --stage s2

hubspot ticket search Search HubSpot tickets

#cmd-hubspot-ticket-search discovery safe

--filter stringArray = [] Property filter as name=value or name:OP:value

--query string Text to search across HubSpot default searchable properties

$ hubspot ticket get tk1 --view full

$ hubspot ticket search

$ hubspot ticket search --query cmdhub --limit 5

hubspot ticket update Update an exact HubSpot ticket

#cmd-hubspot-ticket-update mutates state

--content string Ticket content

--owner string HubSpot owner ID or ref

--pipeline string Ticket pipeline ID or ref

--priority string Ticket priority

--property stringArray = [] HubSpot property update as name=value

--stage string Ticket stage ID or ref

--subject string Ticket subject

$ hubspot ticket search --query cmdhub --limit 5

$ hubspot ticket update --help

$ hubspot ticket update tk1 --priority HIGH

hubspot version Show version information

#cmd-hubspot-version discovery safe

$ hubspot version --help

play_circle Live Examples

Output captured from a real workspace. Regenerate with scripts/gen-docs.sh --update.

auth

Show auth status Shows the current auth state and next step.

$ hubspot auth status

Authenticated as kestrelphilip@gmail.com
Profile: kestrelphilip@gmail.com

Next steps:
- Find contacts:      hubspot contact search --query <text> --limit 5
- Find companies:     hubspot company search --query <text> --limit 5
- Discover pipelines: hubspot pipeline list --object deal
- Plan cleanup:       hubspot cleanup plan --token cmdhub-eval-<run> --objects contacts

lifecycle

Show capabilities Lists command surfaces and output modes.

$ hubspot capabilities

hubspot capabilities
Resources: association, auth, capabilities, cleanup, company, config, contact, deal, doctor, note, owner, pipeline, profile, property, resolve, schema, ticket, version
Machine output: --json, --jsonl

Next steps:
- Schema:        hubspot schema
- Contract:      hubspot capabilities --json
- Help:          hubspot --help
- Find contacts: hubspot contact search --query <text> --limit 5

schemas

Show schema overview Lists available schemas.

$ hubspot schema

hubspot schemas
COMMAND                DIR
association.add        input
association.add        output
association.list       input
association.list       output
association.remove     input
association.remove     output
association.types      input
association.types      output
auth.status            output
auth.whoami            output
capabilities.describe  output
cleanup.plan           input
cleanup.plan           output
cleanup.run            input
cleanup.run            output
cleanup.verify         input
cleanup.verify         output
company.create         input
company.create         output
company.delete         input
company.delete         output
company.get            input
company.get            output
company.list           input
company.list           output
company.search         input
company.search         output
company.update         input
company.update         output
contact.create         input
contact.create         output
contact.delete         input
contact.delete         output
contact.get            input
contact.get            output
contact.list           input
contact.list           output
contact.search         input
contact.search         output
contact.update         input
contact.update         output
deal.create            input
deal.create            output
deal.delete            input
deal.delete            output
deal.get               input
deal.get               output
deal.list              input
deal.list              output
deal.move              input
deal.move              output
deal.search            input
deal.search            output
deal.update            input
deal.update            output
doctor.run             output
note.create            input
note.create            output
note.delete            input
note.delete            output
note.get               input
note.get               output
note.update            input
note.update            output
owner.list             output
pipeline.get           input
pipeline.get           output
pipeline.list          input
pipeline.list          output
property.get           input
property.get           output
property.list          input
property.list          output
property.search        input
property.search        output
resolve.get            output
ticket.create          input
ticket.create          output
ticket.delete          input
ticket.delete          output
ticket.get             input
ticket.get             output
ticket.list            input
ticket.list            output
ticket.move            input
ticket.move            output
ticket.search          input
ticket.search          output
ticket.update          input
ticket.update          output
version.get            output

Next steps:
- Find contacts:      hubspot contact search --query <text> --limit 5
- Find companies:     hubspot company search --query <text> --limit 5
- Discover pipelines: hubspot pipeline list --object deal
- Plan cleanup:       hubspot cleanup plan --token cmdhub-eval-<run> --objects contacts

alt_route Composition Patterns

Bridge your ecosystem with zero middleware.

# Inspect auth state and available command schemas
hubspot auth status --json
hubspot schema

Hubspot CLIfor cmdhub.

data_object Agent Contract

Output

Auth

Refs

Schemas

terminal Command Reference

Global Flags

play_circle Live Examples

auth

lifecycle

schemas

alt_route Composition Patterns

Hubspot CLI
for cmdhub.