diff --git a/.gitleaks.toml b/.gitleaks.toml
index b4b4c28..840d854 100644
--- a/.gitleaks.toml
+++ b/.gitleaks.toml
@@ -21,3 +21,41 @@ regex = '''(?:^|[^A-Za-z0-9/])(1//[A-Za-z0-9_-]{30,})'''
secretGroup = 1
entropy = 3.5
keywords = ["1//"]
+
+# A HubSpot private app token or service key: `pat-`, the account's data region (any of them), a UUID (HubSpot's
+# private apps guide shows `pat-na1-…`). The tests' fake is no UUID, and an all-zero first group is kept for made-up
+# keys.
+[[rules]]
+id = "hubspot-key"
+description = "HubSpot private app token or service key"
+regex = '''\b(pat-[a-z]{2}\d+-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})\b'''
+secretGroup = 1
+keywords = ["pat-"]
+
+[[rules.allowlists]]
+regexes = ['''^pat-[a-z]{2}\d+-0{8}-''']
+
+# A CRM holds its clients' phone numbers and e-mail addresses; neither may reach a fixture, a doc or a capture.
+[[rules]]
+id = "phone-number-e164"
+description = "A phone number of a contact, a company or an owner"
+regex = '''(?i)(?:phone|msisdn|number)["'\s:=]{1,10}\+?[1-9]\d{9,14}'''
+tags = ["pii"]
+
+[[rules]]
+id = "email-address"
+description = "An e-mail address of a contact, a company or an owner"
+regex = '''\b[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+(?:\.[A-Za-z0-9-]+)*\.[A-Za-z]{2,}\b'''
+tags = ["pii"]
+
+[[rules.allowlists]]
+regexTarget = "match"
+regexes = [
+ # The domains RFC 2606 and RFC 6761 keep for examples, and the addresses of tools that commit here.
+ '''@(?:[A-Za-z0-9-]+\.)*(?:example\.(?:com|org|net)|example|test|invalid|localhost)$''',
+ '''@wirecat\.dev$''',
+ '''^noreply@anthropic\.com$''',
+ '''@users\.noreply\.github\.com$''',
+ # The example contact in HubSpot's own contacts spec, copied into the generated manifest.
+ '''^jon@website\.com$''',
+]
diff --git a/README.md b/README.md
index 2f30004..dcaf4af 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,257 @@
-# hubspot
+
+
+
-`hubspot` is a WireCat command-line tool, started from
-[cli-template](https://github.com/WireCatLabs/cli-template). Its design is in
-[docs/dev/DESIGN.md](docs/dev/DESIGN.md).
+# hubspot: HubSpot CRM CLI for AI agents
+
+
+ Know where every deal stands and what changed overnight, without opening HubSpot. Ask your AI agent, and it answers
+ from a copy of your deals, contacts and companies on your computer, even offline.
+
+
+- **Ask instead of clicking.** "Which deals are stuck in Contract sent?" gets an answer in a second, in Claude Code,
+ Codex or any app that speaks MCP.
+- **The morning starts with what changed.** `changes list` shows what each sync saw change, and a schedule sends it to
+ you.
+- **Read only.** This release changes nothing in HubSpot. The key it signs in with needs read scopes only.
+
+```text
+You: What changed in the CRM since yesterday?
+Agent: (runs hubspot work changes list "at>=1d")
+ · New deal "Example kitchen", 15 000 EUR, in Appointment scheduled
+ · "Example office" moved to Closed won, 8 200 EUR
+You: Who is the contact on Example kitchen?
+Agent: (runs hubspot work deals show deal:12)
+ Anna Example, anna@example.com, at Example LLC.
+```
+
+*Invented deals, illustrative output.*
## Quick start
+A super admin of the HubSpot account makes one key first: a **service key** (Development → Keys → Service keys) or
+the access token of a legacy **private app**. Give it these read scopes:
+
+```text
+crm.objects.contacts.read crm.objects.companies.read crm.objects.deals.read
+crm.objects.owners.read crm.schemas.contacts.read crm.schemas.companies.read
+crm.schemas.deals.read sales-email-read
+```
+
+Add `crm.objects.leads.read` on Sales Hub Professional or Enterprise to read leads, and `tickets` to read tickets
+through `api`. A scope you leave out fails only the commands that need it.
+
+```sh
+npm install -g @wirecat/hubspot-cli
+hubspot skill install # the agent skill, for Claude Code, Codex and Gemini CLI
+hubspot work session start # paste the key when asked, it goes to the keyring
+hubspot work sync # copy your deals, contacts and companies
+hubspot work deals list status:open
+```
+
+`work` is a profile, a name you choose for this account. It is the first word of every command that uses the
+account. You need Node.js 22.16 or a later 22.x, or Node.js 24 or later. `hubspot doctor` shows what is set up and
+needs no network.
+
+More: [install and connect](docs/installation.md)
+
+## What you can do
+
+- **Know the pipeline.** Open deals with their stage, amount and owner, the board of each pipeline and how many deals
+ stand in each stage.
+- **See what changed.** Deals made, moved, won and lost, given another owner, and new activities, since any time you
+ name.
+- **Find a client.** Any contact or company in the account, read live, with its phones and e-mails.
+- **Follow the work on a deal.** Notes, calls, e-mails, meetings and tasks, copied with the deals.
+- **Reach past the copy.** Every read operation of HubSpot's CRM API is a command of its own, tickets included.
+- **Search across your work.** A deal turns up next to the chat where you agreed on it and the meeting where you
+ discussed it, if you use the other WireCat tools.
+
+## For AI agents
+
+Ask in plain words. The agent picks the commands.
+
+> *"Use hubspot. Which deals are waiting in Contract sent, and for how much?"*
+> *"Use hubspot. What changed in the CRM since yesterday?"*
+
+- **Claude Code, Codex, Gemini CLI, OpenClaw** and other agents with a terminal run `hubspot` themselves.
+ `hubspot skill install` teaches them how.
+- **Claude Desktop, Cursor** and other MCP apps connect to `hubspot work mcp serve`.
+
+```sh
+hubspot work mcp add claude-code --allow-writes # or: codex
+hubspot work mcp config # the entry for Claude Desktop, Cursor and others
+```
+
+`--allow-writes` confirms you saw that the server offers commands that change something on this computer, such as
+`sync` and schedules. None of them changes anything in HubSpot. Text from the account reaches the agent marked as
+untrusted, so the agent reads it as data, never as instructions. The sign-in commands are not offered over MCP.
+
+More: [agents and MCP](docs/usage.md#agents)
+
+## Why hubspot
+
+- **A copy of your CRM on your computer.** `sync` copies your deals with their contacts and companies, and the next
+ sync takes only the changes. Lists, the pipeline and search then answer with no request to HubSpot, also offline.
+- **The key stays in the system keyring.** It never appears in output, errors or run records, and no command takes it
+ as an argument.
+- **A permission on every command.** Each command and each read operation of HubSpot's API has its own level, so
+ you decide what an agent may read.
+- **Your CRM beside your other context.** Deals sit in the same local store as your messages, notes and meetings from
+ the other WireCat tools, and `search all` finds them together.
+- **As many accounts as you need.** Each HubSpot account is a profile you name in the command, and none is ever picked
+ for you.
+- **Free and open source.** Apache 2.0.
+
+## Main features
+
+### Deals and the pipeline
+
+```sh
+hubspot work deals list stage:"Contract sent" # from the copy, offline too
+hubspot work deals show deal:12 # one deal with its stage, amount and the people on it
+hubspot work pipelines list # the deal pipelines and their stages
+hubspot work leads list # leads, on Sales Hub Professional or Enterprise
+```
+
+### Contacts, companies and owners
+
+```sh
+hubspot work people list "Anna" # any contact in the account, read live
+hubspot work organizations list "Example LLC" # any company, read live
+hubspot work users list # the account's owners
+```
+
+### Activities and what changed
+
+```sh
+hubspot work activities list # notes, calls, e-mails, meetings and tasks
+hubspot work changes list "at>=1d" # what changed in the last day
+```
+
+Activities are copied once you turn on the activities setting. `activities list` names the setting.
+
+### Any read of the API
+
+```sh
+hubspot work api list # every read operation, without calling HubSpot
+hubspot work api deals-list --limit 5 # one of them
+```
+
+`api` offers every read operation of HubSpot's CRM API version 2026-03, from its 15 specs, each with its own
+permission. Tickets are read here.
+
+### With your other sources
+
+```sh
+hubspot work search all "Example LLC" # the deal beside your other WireCat data
+```
+
+More: [use it](docs/usage.md) · [command reference](docs/commands.md)
+
+### How it works
+
+- **A key, not a user.** A service key or a private app token belongs to the account, not to a person. `hubspot`
+ copies the whole account, and `owner:me` names nobody: filter by `owner:` from `users list`.
+- **Polite to HubSpot.** `hubspot` sends at most 4 requests a second for each profile, under HubSpot's limits on
+ every plan. When the account has spent its daily allowance, it says when the allowance comes back.
+- **Made for scripts.** `--json` prints one JSON value, and every error has a code to branch on.
+
+## Sign-in and profiles
+
+A profile is a name you choose for one HubSpot account, such as `work`. It is the first word of every command that
+uses the account, and none is ever assumed: a command without one stops and names the choices.
+`WCHUBSPOT_PROFILE=work` sets it for one shell session.
+
+`hubspot work session start` asks for the key without showing it, or reads it from stdin. It checks the key against
+the account and keeps it in the system keyring. `--credential-storage file` keeps it in a private file instead.
+`session status --check` names the account the key reads, `session end` forgets the key on this computer, and
+`session list` lists the profiles. `account remove --keep-data` or `--delete-data` forgets a profile, keeping or
+deleting its copy of the CRM.
+
+A second profile that signs in to the same HubSpot account is refused, so one copy is never synced twice.
+
+More: [sign in](docs/installation.md#sign-in) · [profiles](docs/usage.md#the-profile-comes-first)
+
+## Settings and permissions
+
+Each profile has a permission level for every command and every API operation: `allow`, `ask`, `readonly` or `deny`.
+A command's key is its name, such as `deals.list`. An API operation's key is `api.`, such as
+`api.deals-search`, and `api` covers them all.
+
```sh
-pnpm install
-pnpm build
-node dist/bin/hubspot.js doctor
+hubspot work config set permissions.people deny # this profile reads no contacts
```
-`doctor` needs no profile. Every command that uses an account starts with one, a name you choose: `hubspot personal config show`.
+Over MCP nobody is there to answer, so `ask` lets the command run. Set a key to `readonly` or `deny` to stop an
+agent. `hubspot work mcp serve --permission people.list=deny` makes a key stricter for one server only, never looser.
+`WCHUBSPOT_READ_ONLY=1` refuses every write.
+
+More: [settings and permissions](docs/configuration.md#permissions)
+
+## Limits
+
+- `hubspot` is tested against a fake account built from HubSpot's API reference, not yet against a live account.
+- Read only: no command changes deals, contacts or companies in this release, `api` included.
+- Tickets are read only through `api`, not copied.
+- Leads need Sales Hub Professional or Enterprise.
+- Before 1.0, a minor version may change commands, `--json` fields and MCP tools. The changelog marks each such
+ change.
+
+## Security
+
+The key works like a password: anyone who has it can read what its scopes allow. `hubspot` keeps it in the system
+keyring and never prints it. `hubspot` cannot revoke a key, so after a leak delete or rotate it in HubSpot.
+
+More: [security](docs/security.md) · Report a vulnerability: [SECURITY.md](SECURITY.md)
+
+## When something goes wrong
+
+```sh
+hubspot doctor # what is set up, without connecting
+hubspot work session status --check # whether the key works, and for which account
+```
+
+More: [troubleshooting](docs/troubleshooting.md) · Ask on [Discord](https://discord.gg/DebENqbRrJ) · Bugs go to this
+repository's [issues](https://github.com/WireCatLabs/hubspot-cli/issues).
+
+## Documentation
+
+Every page is in [docs/](docs/index.md): [install](docs/installation.md), [use it](docs/usage.md),
+[commands](docs/commands.md), [settings](docs/configuration.md), [troubleshooting](docs/troubleshooting.md) and
+[security](docs/security.md).
+
+## Development
+
+```sh
+pnpm install && pnpm build
+node dist/bin/hubspot.js --help
+pnpm test
+```
+
+Tests run against a fake account built from HubSpot's API reference, with invented records and an injected keyring.
+Nothing reaches a real account. `pnpm release:check` runs every check a release needs.
+
+More: [testing](docs/dev/TESTING.md) · [design](docs/dev/DESIGN.md)
+
+Pull requests, bug reports and ideas go to [issues](https://github.com/WireCatLabs/hubspot-cli/issues).
+
+## Part of WireCat
+
+`hubspot` is one of the [WireCat](https://wirecat.dev) tools: open-source, local-first command-line tools that give AI
+agents your context from messengers, mail, calendars, documents and CRMs. Each one works on its own.
+
+## License
+
+[Apache 2.0](LICENSE)
diff --git a/changes/feat-first-release.md b/changes/feat-first-release.md
new file mode 100644
index 0000000..b2594f4
--- /dev/null
+++ b/changes/feat-first-release.md
@@ -0,0 +1,22 @@
+### Added
+
+- **`session start` signs a profile in with a HubSpot service key or a private app token.** The key is read hidden or
+ from stdin, never as an argument, checked against the account, and kept in the keyring with the account's id. A
+ second profile on the same account is refused. `WCHUBSPOT_TOKEN` works in CI beside `WCHUBSPOT_ACCOUNT`, the
+ account's id. See [installation](../docs/installation.md).
+- **`sync` copies the account's CRM into WireCat's shared store.** Deals, contacts, companies, leads (Sales Hub
+ Professional or Enterprise), owners, pipelines and properties, and the notes, calls, e-mails, meetings and tasks
+ once the activities setting is on. `deals list`, `pipelines`, `changes list` and `search all` then answer offline. A
+ key names no user, so every profile reads the whole copy: filter by `owner:`, not `owner:me`.
+- **`people`, `organizations` and `users` read contacts, companies and owners live from the account.**
+- **`api` offers every read operation of HubSpot's CRM API, version 2026-03, from its 15 specs.** One command per
+ operation, each with its own permission key. This release only reads: the API's writes are not offered, and
+ `api show` on one says so.
+- **A spent daily allowance ends the request at once and says when it comes back.** HubSpot shares one daily
+ allowance among every app on the account. `hubspot` reports `hubspot.daily-limit` with the wait to the account's
+ midnight, and stops every process on the account from asking again before then. The ten-second limit is waited
+ out.
+- **`WCHUBSPOT_ACCOUNT` is checked against `WCHUBSPOT_TOKEN` before anything is written.** A `sync` with an id of
+ another account stops with `account.mismatch`, naming both ids, so one account's CRM is never filed under another's.
+ `session status --check` with the token alone prints the id to set. See
+ [troubleshooting](../docs/troubleshooting.md).
diff --git a/contracts/help.snap b/contracts/help.snap
index 6df28a7..1f72d57 100644
--- a/contracts/help.snap
+++ b/contracts/help.snap
@@ -1,21 +1,30 @@
-hubspot — a new WireCat CLI, started from cli-template
+hubspot — a HubSpot account's CRM for scripts and agents, read into one local store.
Usage: hubspot [options]
Account commands start with your profile, a name you choose; none is ever assumed.
+What you can do:
+ sync copy your deals, contacts and companies; the next sync takes the changes
+ deals list status:open open deals with stage, amount and owner, from the store, offline
+ search all "kitchen" stored deals beside your other WireCat tools' data
+ people list "Anna" any contact, read live from the account
+ activities list notes, calls, e-mails, meetings and tasks on your deals
+ api deals-list --limit 5 any CRM read of HubSpot's API, one command per operation
+
Works with:
- tg Telegram in the same local store: search, review and tasks offline
- max MAX in the same local store: search, review and tasks offline
- wa WhatsApp in the same local store: search, review and tasks offline
- zm Zoom meetings: transcripts and summaries, searchable with your other WireCat data
- drive Google Drive and Docs as local text, searchable with your other WireCat data
- gcal Google Calendar events, searchable with your other WireCat data
- memo context one person across messengers, mail, notes and meetings
- mail IMAP mail in the same local store: search your mailbox offline, next to your other WireCat data
- b24 Bitrix24 CRM: deals, leads and pipelines, searchable with your other WireCat data
- pbx Asterisk PBX calls and recordings, searchable with your other WireCat data
- notion Notion pages and databases as local text, searchable with your other WireCat data
+ tg Telegram in the same local store: search, review and tasks offline
+ max MAX in the same local store: search, review and tasks offline
+ wa WhatsApp in the same local store: search, review and tasks offline
+ zm Zoom meetings: transcripts and summaries, searchable with your other WireCat data
+ drive Google Drive and Docs as local text, searchable with your other WireCat data
+ gcal Google Calendar events, searchable with your other WireCat data
+ memo context one person across messengers, mail, notes and meetings
+ mail IMAP mail in the same local store: search your mailbox offline, next to your other WireCat data
+ b24 Bitrix24 CRM: deals, leads and pipelines, searchable with your other WireCat data
+ pbx Asterisk PBX calls and recordings, searchable with your other WireCat data
+ notion Notion pages and databases as local text, searchable with your other WireCat data
-Next: hubspot commands every command, by section
- hubspot help options output, offline, timeouts, dry run
-For agents: hubspot skill show rules and the discovery loop
+Start here: hubspot work session start (any profile name works)
+Next: hubspot commands every command, by section
+ hubspot help options output, offline, timeouts, dry run
+For agents: hubspot skill show rules and the discovery loop
diff --git a/contracts/mcp-catalogue.json b/contracts/mcp-catalogue.json
index c5022e7..b2bd8e5 100644
--- a/contracts/mcp-catalogue.json
+++ b/contracts/mcp-catalogue.json
@@ -1,13 +1,62 @@
{
"session status": "read",
"session list": "read",
- "api comments-list": "read",
- "api comments-create": "write",
- "api comments-get": "read",
- "api comments-update": "write",
- "api comments-delete": "write",
- "comments list": "read",
- "comments show": "read",
- "comments create": "write",
- "comments update": "write"
+ "api contacts-list": "read",
+ "api contacts-batch-read": "read",
+ "api contacts-search": "read",
+ "api contacts-get": "read",
+ "api companies-list": "read",
+ "api companies-batch-read": "read",
+ "api companies-search": "read",
+ "api companies-get": "read",
+ "api deals-list": "read",
+ "api deals-batch-read": "read",
+ "api deals-search": "read",
+ "api deals-get": "read",
+ "api tickets-list": "read",
+ "api tickets-batch-read": "read",
+ "api tickets-search": "read",
+ "api tickets-get": "read",
+ "api leads-list": "read",
+ "api leads-batch-read": "read",
+ "api leads-search": "read",
+ "api leads-get": "read",
+ "api notes-list": "read",
+ "api notes-batch-read": "read",
+ "api notes-search": "read",
+ "api notes-get": "read",
+ "api calls-list": "read",
+ "api calls-batch-read": "read",
+ "api calls-search": "read",
+ "api calls-get": "read",
+ "api emails-list": "read",
+ "api emails-batch-read": "read",
+ "api emails-search": "read",
+ "api emails-get": "read",
+ "api meetings-list": "read",
+ "api meetings-batch-read": "read",
+ "api meetings-search": "read",
+ "api meetings-get": "read",
+ "api tasks-list": "read",
+ "api tasks-batch-read": "read",
+ "api tasks-search": "read",
+ "api tasks-get": "read",
+ "api owners-list": "read",
+ "api owners-get": "read",
+ "api pipelines-list": "read",
+ "api pipelines-get": "read",
+ "api pipelines-audit-list": "read",
+ "api pipelines-stages-list": "read",
+ "api pipelines-stages-get": "read",
+ "api pipelines-stages-audit-list": "read",
+ "api properties-list": "read",
+ "api properties-batch-read": "read",
+ "api properties-groups-list": "read",
+ "api properties-groups-get": "read",
+ "api properties-get": "read",
+ "api associations-batch-read": "read",
+ "api search": "read",
+ "api associations-get": "read",
+ "api account-info-api-usage-daily-private-apps-list": "read",
+ "api account-info-details-list": "read"
}
diff --git a/contracts/wirecat.json b/contracts/wirecat.json
index a45f901..3e89c3e 100644
--- a/contracts/wirecat.json
+++ b/contracts/wirecat.json
@@ -1,7 +1,7 @@
{
"wcat_manifest": 2,
"name": "hubspot",
- "description": "a new WireCat CLI, started from cli-template",
+ "description": "read a HubSpot account's CRM",
"docs_url": "https://github.com/WireCatLabs/hubspot-cli#readme",
"package": "@wirecat/hubspot-cli",
"bin": "wcat-hubspot",
@@ -32,7 +32,7 @@
"session",
"start"
],
- "summary": "sign in to Example Comments with an API token",
+ "summary": "sign in to HubSpot with a service key or a private app token",
"effects": {
"remote": "read",
"local": "write"
@@ -43,7 +43,7 @@
"session",
"status"
],
- "summary": "show where this profile's token comes from; never the token",
+ "summary": "show where this profile's key comes from; --check names the account it reads",
"effects": {
"remote": "read",
"local": "read"
@@ -54,7 +54,7 @@
"session",
"end"
],
- "summary": "forget this profile's token on this computer",
+ "summary": "forget this profile's key on this computer",
"effects": {
"remote": "none",
"local": "write"
@@ -71,140 +71,1277 @@
"local": "read"
}
},
+ {
+ "path": [
+ "account",
+ "remove"
+ ],
+ "summary": "sign this profile out and forget it, keeping or deleting its data",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "account.remove",
+ "entity": "account_removal"
+ },
+ {
+ "path": [
+ "sync"
+ ],
+ "summary": "bring the CRM's copy in the local store up to date: pipelines, companies,…",
+ "effects": {
+ "remote": "read",
+ "local": "write"
+ },
+ "permission": "sync",
+ "entity": "crm_sync"
+ },
+ {
+ "path": [
+ "store",
+ "status"
+ ],
+ "summary": "how far each kind's sync is: rows saved, partial or complete, when it last…",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "store.status",
+ "entity": "crm_sync_progress"
+ },
+ {
+ "path": [
+ "store",
+ "apply"
+ ],
+ "summary": "apply scope mine to the contacts already stored: remove those no deal or…",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "store.apply",
+ "entity": "crm_contacts_removed"
+ },
+ {
+ "path": [
+ "store",
+ "info"
+ ],
+ "summary": "the shared store's format, size and contents, and whether this tool can read it",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "store.info",
+ "entity": "store_info"
+ },
+ {
+ "path": [
+ "store",
+ "check"
+ ],
+ "summary": "check the local store for problems",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "store.check",
+ "entity": "store_check"
+ },
+ {
+ "path": [
+ "store",
+ "migrate"
+ ],
+ "summary": "migrate an older local store",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "store.migrate",
+ "entity": "store_migration"
+ },
+ {
+ "path": [
+ "store",
+ "rebuild"
+ ],
+ "summary": "rebuild the local store's search indexes",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "store.rebuild",
+ "entity": "store_reindex"
+ },
+ {
+ "path": [
+ "store",
+ "backup"
+ ],
+ "summary": "copy the store into a new file, while it is in use; never overwrites a file",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "store.backup",
+ "entity": "store_backup"
+ },
+ {
+ "path": [
+ "store",
+ "restore"
+ ],
+ "summary": "restore a backup and keep the current store, or roll back a breaking upgrade",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "store.restore",
+ "entity": "store_restore"
+ },
+ {
+ "path": [
+ "store",
+ "decrypt"
+ ],
+ "summary": "open a file written with --encrypt into a new file; asks for its password",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "store.decrypt",
+ "entity": "store_decrypt"
+ },
+ {
+ "path": [
+ "store",
+ "repair"
+ ],
+ "summary": "repair table shapes while keeping the old tables",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "store.repair",
+ "entity": "store_repair"
+ },
+ {
+ "path": [
+ "store",
+ "reset"
+ ],
+ "summary": "back up the local store and replace it with an empty one",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "store.reset",
+ "entity": "store_reset"
+ },
+ {
+ "path": [
+ "store",
+ "copies",
+ "delete"
+ ],
+ "summary": "delete one copy `store repair` kept, named exactly; refuses any other table",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "store.copies.delete",
+ "entity": "store_copy_removal"
+ },
+ {
+ "path": [
+ "store",
+ "tables",
+ "list"
+ ],
+ "summary": "every table of the local archive, with its kind and row count",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "store.tables.list",
+ "entity": "store_table"
+ },
+ {
+ "path": [
+ "store",
+ "recover"
+ ],
+ "summary": "what is damaged in the store and how to recover it",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "store.recover"
+ },
+ {
+ "path": [
+ "store",
+ "recover",
+ "run"
+ ],
+ "summary": "rebuild a damaged store from every row it can read",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "store.recover.run"
+ },
+ {
+ "path": [
+ "deals",
+ "list"
+ ],
+ "summary": "deals copied from the CRM, newest first; run sync to bring them up to date",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "deals.list",
+ "entity": "deal"
+ },
+ {
+ "path": [
+ "deals",
+ "show"
+ ],
+ "summary": "one deal with its pipeline, stage, status, amount and the people on it, and…",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "deals.show",
+ "entity": "deal"
+ },
+ {
+ "path": [
+ "leads",
+ "list"
+ ],
+ "summary": "leads copied from the CRM, newest first; run sync to bring them up to date",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "leads.list",
+ "entity": "lead"
+ },
+ {
+ "path": [
+ "leads",
+ "show"
+ ],
+ "summary": "one lead with its pipeline, stage, status, amount and the people on it, and…",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "leads.show",
+ "entity": "lead"
+ },
+ {
+ "path": [
+ "pipelines",
+ "list"
+ ],
+ "summary": "pipelines copied from the CRM, with their stages in order and how many are…",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "pipelines.list",
+ "entity": "pipeline"
+ },
+ {
+ "path": [
+ "pipelines",
+ "show"
+ ],
+ "summary": "one pipeline as a board and a funnel: how many stand in each stage and their…",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "pipelines.show",
+ "entity": "pipeline"
+ },
+ {
+ "path": [
+ "stages",
+ "list"
+ ],
+ "summary": "every stage of the CRM's pipelines in order, with its outcome and how many…",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "stages.list",
+ "entity": "stage"
+ },
+ {
+ "path": [
+ "people",
+ "list"
+ ],
+ "summary": "contacts in the CRM, newest first; another client is found here, never in…",
+ "effects": {
+ "remote": "read",
+ "local": "read"
+ },
+ "permission": "people.list",
+ "entity": "crm_person"
+ },
+ {
+ "path": [
+ "people",
+ "show"
+ ],
+ "summary": "one of the CRM's contacts, read live, with its phones and e-mails; one that…",
+ "effects": {
+ "remote": "read",
+ "local": "read"
+ },
+ "permission": "people.show",
+ "entity": "crm_person"
+ },
+ {
+ "path": [
+ "organizations",
+ "list"
+ ],
+ "summary": "companies in the CRM, newest first; another client is found here, never in…",
+ "effects": {
+ "remote": "read",
+ "local": "read"
+ },
+ "permission": "organizations.list",
+ "entity": "crm_organization"
+ },
+ {
+ "path": [
+ "organizations",
+ "show"
+ ],
+ "summary": "one of the CRM's companies, read live, with its phones and e-mails; one that…",
+ "effects": {
+ "remote": "read",
+ "local": "read"
+ },
+ "permission": "organizations.show",
+ "entity": "crm_organization"
+ },
+ {
+ "path": [
+ "users",
+ "list"
+ ],
+ "summary": "the CRM's users, read live, in the CRM's order",
+ "effects": {
+ "remote": "read",
+ "local": "read"
+ },
+ "permission": "users.list",
+ "entity": "crm_user"
+ },
+ {
+ "path": [
+ "users",
+ "show"
+ ],
+ "summary": "one of the CRM's users, read live",
+ "effects": {
+ "remote": "read",
+ "local": "read"
+ },
+ "permission": "users.show",
+ "entity": "crm_user"
+ },
+ {
+ "path": [
+ "activities",
+ "list"
+ ],
+ "summary": "activities copied from the CRM, open ones first by due time, then the rest…",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "activities.list",
+ "entity": "crm_activity"
+ },
+ {
+ "path": [
+ "changes",
+ "list"
+ ],
+ "summary": "deals and leads made, moved, won, lost and given another owner, activities…",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "changes.list",
+ "entity": "crm_change"
+ },
+ {
+ "path": [
+ "fields",
+ "list"
+ ],
+ "summary": "the CRM's custom fields of one kind, in its order, with a list field's options",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "fields.list",
+ "entity": "crm_field"
+ },
+ {
+ "path": [
+ "search",
+ "all"
+ ],
+ "summary": "search stored deals and leads, messages, notes, calendar events and meetings",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "search.all",
+ "entity": "hit"
+ },
+ {
+ "path": [
+ "api",
+ "list"
+ ],
+ "summary": "list every HubSpot API operation this CLI offers, without calling HubSpot",
+ "effects": {
+ "remote": "none",
+ "local": "none"
+ },
+ "entity": "api_operation"
+ },
+ {
+ "path": [
+ "api",
+ "show"
+ ],
+ "summary": "show one operation's parameters and request schema, without calling HubSpot",
+ "effects": {
+ "remote": "none",
+ "local": "none"
+ }
+ },
+ {
+ "path": [
+ "api",
+ "contacts-list"
+ ],
+ "summary": "Retrieve contacts — read (GET /crm/objects/2026-03/contacts)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.contacts-list"
+ },
+ {
+ "path": [
+ "api",
+ "contacts-batch-read"
+ ],
+ "summary": "Retrieve a batch of contacts — read (POST…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.contacts-batch-read"
+ },
+ {
+ "path": [
+ "api",
+ "contacts-search"
+ ],
+ "summary": "Search for contacts — read (POST /crm/objects/2026-03/contacts/search)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.contacts-search"
+ },
+ {
+ "path": [
+ "api",
+ "contacts-get"
+ ],
+ "summary": "Retrieve a contact — read (GET /crm/objects/2026-03/contacts/{contactId})",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.contacts-get"
+ },
+ {
+ "path": [
+ "api",
+ "companies-list"
+ ],
+ "summary": "Retrieve companies — read (GET /crm/objects/2026-03/companies)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.companies-list"
+ },
+ {
+ "path": [
+ "api",
+ "companies-batch-read"
+ ],
+ "summary": "Retrieve a batch of companies — read (POST…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.companies-batch-read"
+ },
+ {
+ "path": [
+ "api",
+ "companies-search"
+ ],
+ "summary": "Search for companies — read (POST /crm/objects/2026-03/companies/search)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.companies-search"
+ },
+ {
+ "path": [
+ "api",
+ "companies-get"
+ ],
+ "summary": "Retrieve a company — read (GET /crm/objects/2026-03/companies/{companyId})",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.companies-get"
+ },
+ {
+ "path": [
+ "api",
+ "deals-list"
+ ],
+ "summary": "List — read (GET /crm/objects/2026-03/0-3)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.deals-list"
+ },
+ {
+ "path": [
+ "api",
+ "deals-batch-read"
+ ],
+ "summary": "Read a batch of deals by internal ID, or unique property values — read (POST…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.deals-batch-read"
+ },
+ {
+ "path": [
+ "api",
+ "deals-search"
+ ],
+ "summary": "Search for deals using various filters and criteria to retrieve specific…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.deals-search"
+ },
+ {
+ "path": [
+ "api",
+ "deals-get"
+ ],
+ "summary": "Read — read (GET /crm/objects/2026-03/0-3/{dealId})",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.deals-get"
+ },
+ {
+ "path": [
+ "api",
+ "tickets-list"
+ ],
+ "summary": "List — read (GET /crm/objects/2026-03/tickets)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.tickets-list"
+ },
+ {
+ "path": [
+ "api",
+ "tickets-batch-read"
+ ],
+ "summary": "Read a batch of tickets by internal ID, or unique property values — read…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.tickets-batch-read"
+ },
+ {
+ "path": [
+ "api",
+ "tickets-search"
+ ],
+ "summary": "Search for tickets — read (POST /crm/objects/2026-03/tickets/search)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.tickets-search"
+ },
+ {
+ "path": [
+ "api",
+ "tickets-get"
+ ],
+ "summary": "Read — read (GET /crm/objects/2026-03/tickets/{ticketId})",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.tickets-get"
+ },
+ {
+ "path": [
+ "api",
+ "leads-list"
+ ],
+ "summary": "List — read (GET /crm/objects/2026-03/leads)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.leads-list"
+ },
+ {
+ "path": [
+ "api",
+ "leads-batch-read"
+ ],
+ "summary": "Read a batch of leads by internal ID, or unique property values — read (POST…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.leads-batch-read"
+ },
+ {
+ "path": [
+ "api",
+ "leads-search"
+ ],
+ "summary": "Search for leads using specified criteria. — read (POST…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.leads-search"
+ },
+ {
+ "path": [
+ "api",
+ "leads-get"
+ ],
+ "summary": "Read — read (GET /crm/objects/2026-03/leads/{leadsId})",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.leads-get"
+ },
+ {
+ "path": [
+ "api",
+ "notes-list"
+ ],
+ "summary": "List — read (GET /crm/objects/2026-03/notes)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.notes-list"
+ },
+ {
+ "path": [
+ "api",
+ "notes-batch-read"
+ ],
+ "summary": "Read a batch of notes by internal ID, or unique property values — read (POST…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.notes-batch-read"
+ },
+ {
+ "path": [
+ "api",
+ "notes-search"
+ ],
+ "summary": "Search for notes based on specified criteria. — read (POST…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.notes-search"
+ },
+ {
+ "path": [
+ "api",
+ "notes-get"
+ ],
+ "summary": "Read — read (GET /crm/objects/2026-03/notes/{noteId})",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.notes-get"
+ },
+ {
+ "path": [
+ "api",
+ "calls-list"
+ ],
+ "summary": "List — read (GET /crm/objects/2026-03/calls)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.calls-list"
+ },
+ {
+ "path": [
+ "api",
+ "calls-batch-read"
+ ],
+ "summary": "Read a batch of calls by internal ID, or unique property values — read (POST…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.calls-batch-read"
+ },
+ {
+ "path": [
+ "api",
+ "calls-search"
+ ],
+ "summary": "Search for calls — read (POST /crm/objects/2026-03/calls/search)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.calls-search"
+ },
+ {
+ "path": [
+ "api",
+ "calls-get"
+ ],
+ "summary": "Read — read (GET /crm/objects/2026-03/calls/{callId})",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.calls-get"
+ },
+ {
+ "path": [
+ "api",
+ "emails-list"
+ ],
+ "summary": "List — read (GET /crm/objects/2026-03/emails)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.emails-list"
+ },
+ {
+ "path": [
+ "api",
+ "emails-batch-read"
+ ],
+ "summary": "Read a batch of emails by internal ID, or unique property values — read…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.emails-batch-read"
+ },
+ {
+ "path": [
+ "api",
+ "emails-search"
+ ],
+ "summary": "Search for emails using specified criteria and filters. — read (POST…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.emails-search"
+ },
+ {
+ "path": [
+ "api",
+ "emails-get"
+ ],
+ "summary": "Read — read (GET /crm/objects/2026-03/emails/{emailId})",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.emails-get"
+ },
+ {
+ "path": [
+ "api",
+ "meetings-list"
+ ],
+ "summary": "List — read (GET /crm/objects/2026-03/meetings)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.meetings-list"
+ },
+ {
+ "path": [
+ "api",
+ "meetings-batch-read"
+ ],
+ "summary": "Read a batch of meetings by internal ID, or unique property values — read…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.meetings-batch-read"
+ },
+ {
+ "path": [
+ "api",
+ "meetings-search"
+ ],
+ "summary": "Search for meetings — read (POST /crm/objects/2026-03/meetings/search)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.meetings-search"
+ },
+ {
+ "path": [
+ "api",
+ "meetings-get"
+ ],
+ "summary": "Read — read (GET /crm/objects/2026-03/meetings/{meetingId})",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.meetings-get"
+ },
+ {
+ "path": [
+ "api",
+ "tasks-list"
+ ],
+ "summary": "List — read (GET /crm/objects/2026-03/tasks)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.tasks-list"
+ },
+ {
+ "path": [
+ "api",
+ "tasks-batch-read"
+ ],
+ "summary": "Read a batch of tasks by internal ID, or unique property values — read (POST…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.tasks-batch-read"
+ },
+ {
+ "path": [
+ "api",
+ "tasks-search"
+ ],
+ "summary": "Search for tasks using specified criteria. — read (POST…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.tasks-search"
+ },
{
"path": [
"api",
- "list"
+ "tasks-get"
],
- "summary": "list every Example Comments API operation this CLI offers, without calling…",
+ "summary": "Read — read (GET /crm/objects/2026-03/tasks/{taskId})",
"effects": {
- "remote": "none",
+ "remote": "read",
"local": "none"
},
- "permission": "api.list",
- "entity": "api_operation"
+ "permission": "api.tasks-get"
},
{
"path": [
"api",
- "show"
+ "owners-list"
],
- "summary": "show one operation's parameters and request schema, without calling Example…",
+ "summary": "List owners — read (GET /crm/owners/2026-03)",
"effects": {
- "remote": "none",
+ "remote": "read",
"local": "none"
},
- "permission": "api.show"
+ "permission": "api.owners-list"
},
{
"path": [
"api",
- "comments-list"
+ "owners-get"
],
- "summary": "List comments, newest first — read (GET /comments)",
+ "summary": "Retrieve a specific owner by ID — read (GET /crm/owners/2026-03/{ownerId})",
"effects": {
"remote": "read",
"local": "none"
},
- "permission": "api.comments-list"
+ "permission": "api.owners-get"
},
{
"path": [
"api",
- "comments-create"
+ "pipelines-list"
],
- "summary": "Create a comment — write (POST /comments)",
+ "summary": "Retrieve all pipelines — read (GET /crm/pipelines/2026-03/{objectType})",
"effects": {
- "remote": "write",
+ "remote": "read",
"local": "none"
},
- "permission": "api.comments-create"
+ "permission": "api.pipelines-list"
},
{
"path": [
"api",
- "comments-get"
+ "pipelines-get"
],
- "summary": "Show one comment — read (GET /comments/{comment_id})",
+ "summary": "Return a pipeline by ID — read (GET…",
"effects": {
"remote": "read",
"local": "none"
},
- "permission": "api.comments-get"
+ "permission": "api.pipelines-get"
},
{
"path": [
"api",
- "comments-update"
+ "pipelines-audit-list"
],
- "summary": "Change a comment's text — write (PATCH /comments/{comment_id})",
+ "summary": "Return an audit of all changes to the pipeline — read (GET…",
"effects": {
- "remote": "write",
+ "remote": "read",
"local": "none"
},
- "permission": "api.comments-update"
+ "permission": "api.pipelines-audit-list"
},
{
"path": [
"api",
- "comments-delete"
+ "pipelines-stages-list"
],
- "summary": "Delete a comment — destructive (DELETE /comments/{comment_id})",
+ "summary": "Return all stages of a pipeline — read (GET…",
"effects": {
- "remote": "write",
+ "remote": "read",
"local": "none"
},
- "permission": "api.comments-delete"
+ "permission": "api.pipelines-stages-list"
},
{
"path": [
- "comments",
- "list"
+ "api",
+ "pipelines-stages-get"
],
- "summary": "list the comments in Example Comments, newest first",
+ "summary": "Return a pipeline stage by ID — read (GET…",
"effects": {
"remote": "read",
- "local": "read"
+ "local": "none"
},
- "permission": "comments.list",
- "entity": "comment"
+ "permission": "api.pipelines-stages-get"
},
{
"path": [
- "comments",
- "show"
+ "api",
+ "pipelines-stages-audit-list"
+ ],
+ "summary": "Retrieve a reverse chronological list of all changes made to a specific…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.pipelines-stages-audit-list"
+ },
+ {
+ "path": [
+ "api",
+ "properties-list"
+ ],
+ "summary": "Read all properties — read (GET /crm/properties/2026-03/{objectType})",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.properties-list"
+ },
+ {
+ "path": [
+ "api",
+ "properties-batch-read"
+ ],
+ "summary": "Read a batch of properties — read (POST…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.properties-batch-read"
+ },
+ {
+ "path": [
+ "api",
+ "properties-groups-list"
+ ],
+ "summary": "Read all property groups — read (GET…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.properties-groups-list"
+ },
+ {
+ "path": [
+ "api",
+ "properties-groups-get"
+ ],
+ "summary": "Read a property group — read (GET…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.properties-groups-get"
+ },
+ {
+ "path": [
+ "api",
+ "properties-get"
+ ],
+ "summary": "Read a property — read (GET /crm/properties/2026-03/{objectType}/{propertyName})",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.properties-get"
+ },
+ {
+ "path": [
+ "api",
+ "associations-batch-read"
+ ],
+ "summary": "Retrieve associations — read (POST…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.associations-batch-read"
+ },
+ {
+ "path": [
+ "api",
+ "search"
+ ],
+ "summary": "— read (POST /crm/objects/2026-03/{objectType}/search)",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.search"
+ },
+ {
+ "path": [
+ "api",
+ "associations-get"
+ ],
+ "summary": "Retrieve all associations by object type — read (GET…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.associations-get"
+ },
+ {
+ "path": [
+ "api",
+ "account-info-api-usage-daily-private-apps-list"
+ ],
+ "summary": "Retrieve private app daily API usage — read (GET…",
+ "effects": {
+ "remote": "read",
+ "local": "none"
+ },
+ "permission": "api.account-info-api-usage-daily-private-apps-list"
+ },
+ {
+ "path": [
+ "api",
+ "account-info-details-list"
],
- "summary": "show one comment in Example Comments",
+ "summary": "Retrieve account details — read (GET /account-info/2026-03/details)",
"effects": {
"remote": "read",
+ "local": "none"
+ },
+ "permission": "api.account-info-details-list"
+ },
+ {
+ "path": [
+ "schedule",
+ "command"
+ ],
+ "summary": "run hubspot on a timer — reads save what they read, so this is how a…",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "schedule.command"
+ },
+ {
+ "path": [
+ "schedule",
+ "agent"
+ ],
+ "summary": "start an agent (claude, codex, gemini, cursor, opencode, openclaw, hermes,…",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "schedule.agent"
+ },
+ {
+ "path": [
+ "schedule",
+ "list"
+ ],
+ "summary": "the schedules, when they run and how their last run went",
+ "effects": {
+ "remote": "none",
"local": "read"
},
- "permission": "comments.show",
- "entity": "comment"
+ "permission": "schedule.list",
+ "entity": "scheduled_job"
},
{
"path": [
- "comments",
- "create"
+ "schedule",
+ "agents",
+ "list"
+ ],
+ "summary": "the agents a schedule may start, and which are on PATH here",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "schedule.agents.list",
+ "entity": "schedule_harness"
+ },
+ {
+ "path": [
+ "schedule",
+ "run"
],
- "summary": "post a comment in Example Comments",
+ "summary": "run a schedule now, as its timer would, and wait for it; a paused one runs too",
"effects": {
"remote": "write",
"local": "write"
},
- "permission": "comments.create"
+ "permission": "schedule.run"
+ },
+ {
+ "path": [
+ "schedule",
+ "remove"
+ ],
+ "summary": "stop a schedule and remove its timer; its past output stays",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "schedule.remove"
+ },
+ {
+ "path": [
+ "schedule",
+ "pause"
+ ],
+ "summary": "take a schedule off its timer and keep it; run runs it, resume puts it back",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "schedule.pause"
+ },
+ {
+ "path": [
+ "schedule",
+ "resume"
+ ],
+ "summary": "put a paused schedule back on its timer",
+ "effects": {
+ "remote": "none",
+ "local": "write"
+ },
+ "permission": "schedule.resume"
},
{
"path": [
- "comments",
- "update"
+ "schedule",
+ "exec"
],
- "summary": "change the text of your comment in Example Comments",
+ "summary": "what a timer runs, given the schedule's file; to run one by hand, use run",
"effects": {
"remote": "write",
"local": "write"
},
- "permission": "comments.update"
+ "permission": "schedule.exec"
},
{
"path": [
@@ -430,6 +1567,53 @@
"local": "write"
}
},
+ {
+ "path": [
+ "setup"
+ ],
+ "summary": "connect this profile, question by question",
+ "effects": {
+ "remote": "read",
+ "local": "write"
+ },
+ "permission": "setup"
+ },
+ {
+ "path": [
+ "setup",
+ "show"
+ ],
+ "summary": "print the connection flow as JSON, for WireCat Desktop",
+ "effects": {
+ "remote": "none",
+ "local": "read"
+ },
+ "permission": "setup.show"
+ },
+ {
+ "path": [
+ "setup",
+ "apply"
+ ],
+ "summary": "check the answers on stdin against the flow, and save them",
+ "effects": {
+ "remote": "read",
+ "local": "write"
+ },
+ "permission": "setup.apply"
+ },
+ {
+ "path": [
+ "setup",
+ "run"
+ ],
+ "summary": "run one step of the flow, as WireCat Desktop does",
+ "effects": {
+ "remote": "read",
+ "local": "write"
+ },
+ "permission": "setup.run"
+ },
{
"path": [
"runs",
@@ -468,15 +1652,123 @@
}
],
"entities": {
+ "store_table": {
+ "fields": [
+ "name",
+ "kind",
+ "rows",
+ "bytes"
+ ]
+ },
+ "deal": {
+ "fields": [
+ "status",
+ "organization"
+ ]
+ },
+ "lead": {
+ "fields": [
+ "status",
+ "organization"
+ ]
+ },
+ "pipeline": {
+ "fields": [
+ "kind"
+ ]
+ },
+ "stage": {
+ "fields": [
+ "kind"
+ ]
+ },
+ "crm_person": {
+ "fields": [
+ "id",
+ "name",
+ "first_name",
+ "last_name",
+ "position",
+ "organization_ids",
+ "assigned_to",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "crm_organization": {
+ "fields": [
+ "id",
+ "name",
+ "type",
+ "own",
+ "person_ids",
+ "assigned_to",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "crm_user": {
+ "fields": [
+ "id",
+ "name",
+ "email",
+ "position",
+ "active",
+ "department_ids"
+ ]
+ },
+ "crm_activity": {
+ "fields": [
+ "status",
+ "kind"
+ ]
+ },
+ "crm_change": {
+ "fields": [
+ "change"
+ ]
+ },
+ "crm_field": {
+ "fields": [
+ "code",
+ "label",
+ "type",
+ "multiple",
+ "filterable",
+ "untrusted"
+ ]
+ },
"api_operation": {
"fields": [
"effect",
"tag"
]
},
- "comment": {
+ "scheduled_job": {
+ "fields": [
+ "name",
+ "kind",
+ "when",
+ "notify",
+ "deliver_to",
+ "harness",
+ "reports_cost",
+ "spent_today_usd",
+ "max_cost_usd",
+ "max_cost_per_day_usd"
+ ]
+ },
+ "schedule_harness": {
"fields": [
- "author"
+ "id",
+ "name",
+ "programs",
+ "reports_cost",
+ "restricted",
+ "restricted_reason",
+ "allowed_with_ack",
+ "installed",
+ "path"
]
},
"run": {
@@ -512,7 +1804,7 @@
},
"network": {
"hosts": [
- "comments.example.invalid",
+ "api.hubapi.com",
"registry.npmjs.org",
"huggingface.co",
"*.huggingface.co",
@@ -522,7 +1814,7 @@
]
},
"desktop": {
- "tagline": "HubSpot CRM for scripts and agents",
+ "tagline": "HubSpot CRM: deals, contacts and companies",
"profiles": {
"args": [
"session",
@@ -561,12 +1853,11 @@
"search": null,
"setup": [
"{profile}",
- "session",
- "start"
+ "setup"
],
"signIn": {
- "gives": "Lets your agent read and change your account through hubspot.",
- "asks": "An API token or key from the service."
+ "gives": "Lets your agent read the account's CRM with the scopes you give the key; this release changes nothing.",
+ "asks": "A service key or a legacy private app's access token from your HubSpot account, with read scopes."
},
"skill": {
"status": [
@@ -636,7 +1927,27 @@
]
},
"tasks": null,
- "sync": null,
+ "sync": {
+ "run": [
+ "{profile}",
+ "sync",
+ "--record",
+ "--json"
+ ],
+ "last": [
+ "runs",
+ "list",
+ "command:sync",
+ "status:success",
+ "--limit",
+ "50",
+ "--no-record",
+ "--json"
+ ],
+ "lastShape": "runs",
+ "what": "your deals, contacts and companies",
+ "note": null
+ },
"storeInfo": null,
"storeTables": null,
"storeTableSizes": null,
@@ -647,7 +1958,7 @@
"storeReset": null,
"storage": {
"app": "hubspot-cli",
- "env": "HUBSPOT"
+ "env": "WCHUBSPOT"
},
"settings": null
}
diff --git a/docs/commands.md b/docs/commands.md
index dd42e99..16f3531 100644
--- a/docs/commands.md
+++ b/docs/commands.md
@@ -5,7 +5,7 @@
Every command, option and exit code, generated from the program itself. For the same list as JSON, run
`hubspot commands --json`.
-**The first word is the profile**, a name you choose: `hubspot personal config show`. `HUBSPOT_PROFILE`
+**The first word is the profile**, a name you choose: `hubspot personal config show`. `WCHUBSPOT_PROFILE`
does the same for a whole shell session. No profile is assumed: a command that uses an account stops without one and
lists the profiles on this computer.
@@ -53,11 +53,11 @@ hubspot commands info [path]
## `hubspot session`
-keep this profile's Example Comments token in the OS keyring
+keep this profile's HubSpot key and account id in the OS keyring
### `hubspot session start`
-sign this profile in: the Example Comments API token is asked hidden or read from stdin, never taken as an argument, checked against the service, and only then kept in the keyring, or in a private file
+sign this profile in: a service key (Development → Keys → Service keys) or a legacy private app's access token is asked hidden or read from stdin, never taken as an argument, checked against the account, and only then kept in the keyring with the account's id, or in a private file. The key reads what its scopes allow; hubspot changes nothing in this release
**Changes something on this computer only.**
@@ -67,13 +67,13 @@ hubspot session start [options]
| Option | What it does |
|---|---|
-| `--credential-storage ` | where the token is kept: keyring, which falls back to a private file by itself, or file. Default: `keyring`. |
+| `--credential-storage ` | where the key is kept: keyring, which falls back to a private file by itself, or file. Default: `keyring`. |
-**Example:** `hubspot personal session start`, `hubspot personal session start --credential-storage file`
+**Example:** `hubspot work session start`, `hubspot work session start --json`, `hubspot work session start --credential-storage file`
### `hubspot session status`
-show where this profile's token comes from: HUBSPOT_TOKEN, the keyring or a file, never the token; --check asks Example Comments whose token it is
+show which account this profile signs in to and where its key comes from: WCHUBSPOT_TOKEN, the keyring or a file; never the key
```sh
hubspot session status [options]
@@ -81,13 +81,13 @@ hubspot session status [options]
| Option | What it does |
|---|---|
-| `--check` | ask Example Comments whether the token still works, and whose it is. |
+| `--check` | ask HubSpot whether the key still works and which account it reads. |
-**Example:** `hubspot personal session status`, `hubspot personal session status --check --json`
+**Example:** `hubspot work session status`, `hubspot work session status --check --json`
### `hubspot session end`
-forget this profile's token on this computer; the token itself stays valid in Example Comments
+forget this profile's key and account id on this computer; the key itself stays valid in HubSpot: delete or rotate it where it was made
**Changes something on this computer only.**
@@ -95,11 +95,11 @@ forget this profile's token on this computer; the token itself stays valid in Ex
hubspot session end
```
-**Example:** `hubspot personal session end`
+**Example:** `hubspot work session end`
### `hubspot session list`
-list the profiles on this computer and whether each has a token; picks none
+list the profiles on this computer, whether each has a key and for which account; picks none
```sh
hubspot session list
@@ -107,196 +107,1874 @@ hubspot session list
**Example:** `hubspot session list`, `hubspot session list --json`
+## `hubspot account`
+
+this profile on this computer
+
+### `hubspot account remove`
+
+sign the profile out, then forget it on this computer: its settings, its saved sign-in and its files; --keep-data leaves its messages in the store, where search still finds them, --delete-data deletes them; asks first, or --yes
+
+**Changes something on this computer only.**
+
+```sh
+hubspot account remove [options]
+```
+
+| Option | What it does |
+|---|---|
+| `--keep-data` | leave what the store holds of this account, still searchable. |
+| `--delete-data` | delete what the store and the tool's own files hold of this account. |
+| `--dry-run` | list what it would remove and keep, and change nothing. |
+
+**Returns:** account removal — profile, data, dry_run, account, revoked, config_file, removed, kept; every field: hubspot commands info account remove
+
+**Example:** `hubspot personal account remove --keep-data --dry-run`, `hubspot personal account remove --delete-data --yes`
+
+## `hubspot sync`
+
+bring the CRM's copy in the local store up to date: pipelines, companies, contacts, deals and leads that changed since the last sync, or everything with --rescan; a run stops before its deadline or --max-pages and the next one goes on from there. With the activities setting on, also the activities and tasks on the deals and leads it keeps. Then each deal or lead that moved into a stage the stage-tasks setting names opens a local task, once per move
+
+**Changes something on this computer only.**
+
+```sh
+hubspot sync [options]
+```
+
+| Option | What it does |
+|---|---|
+| `--rescan` | list everything again, every id too, dropping a round in progress. |
+| `--max-pages ` | at most this many requests to the CRM in this run. |
+
+**Returns:** crm sync — provider, account, scope, pipelines, skipped_owner_rejected, stage_tasks, synced, issues, and 9 more; every field: hubspot commands info sync
+
+**Example:** `hubspot work sync`, `hubspot work sync --rescan`, `hubspot work sync --max-pages 20`
+
+## `hubspot store`
+
+the local copy of the CRM, and the shared store file it lives in
+
+### `hubspot store status`
+
+how far each kind's sync is: rows saved, partial or complete, when it last moved, how many are stored
+
+```sh
+hubspot store status
+```
+
+**Returns:** crm sync progress — kind, round, id_pass, stored, job, profile, done, total, and 6 more; every field: hubspot commands info store status
+
+**Example:** `hubspot work store status --json`
+
+### `hubspot store apply`
+
+apply scope mine to the contacts already stored: remove those no deal or lead of the chosen users and no kept company names, and the people they leave empty; counts only unless --yes, under scope all too. A sync that narrows the scope, or sync --rescan under mine, does this itself
+
+**Changes something on this computer only.**
+
+```sh
+hubspot store apply [options]
+```
+
+| Option | What it does |
+|---|---|
+| `--yes` | remove the contacts it counts; otherwise only count them. |
+
+**Returns:** crm contacts removed — contacts, persons, persons_kept, names, applied; every field: hubspot commands info store apply
+
+**Example:** `hubspot work store apply`, `hubspot work store apply --yes`
+
+### `hubspot store info`
+
+the store file: where it is, its size, its schema against the one this tool speaks, which tools used it and how many rows it holds, by provider, chat kind, account, year (UTC) and attachment kind, over every account; changes nothing
+
+```sh
+hubspot store info
+```
+
+**Returns:** store info — path, exists, schema, opens, error, bytes, journal_mode, pages, and 12 more; every field: hubspot commands info store info
+
+**Example:** `hubspot work store info`
+
+### `hubspot store check`
+
+whether the store is healthy — integrity, search indexes, disk
+
+```sh
+hubspot store check
+```
+
+**Returns:** store check — path, exists, ok, opens, error, checks, schema, integrity, and 11 more; every field: hubspot commands info store check
+
+**Example:** `hubspot work store check`
+
+### `hubspot store migrate`
+
+bring the store up to this build's schema, then normalize, index and stem the messages and notes stored before it
+
+**Changes something on this computer only.**
+
+```sh
+hubspot store migrate
+```
+
+**Returns:** store migration — path, exists, from, to, normalized, indexed, terms, stemmed, and 1 more; every field: hubspot commands info store migrate
+
+**Example:** `hubspot work store migrate`
+
+### `hubspot store rebuild`
+
+rebuild the word index, its typo vocabulary, the stems, the files' word index, the notes' indexes and who took part in what, from what is stored, and drop the vectors no stored text uses; loses nothing
+
+**Changes something on this computer only.**
+
+```sh
+hubspot store rebuild
+```
+
+**Returns:** store reindex — path, exists, normalized, indexed, terms, stemmed, notes_indexed, file_texts, and 2 more; every field: hubspot commands info store rebuild
+
+**Example:** `hubspot work store rebuild`
+
+### `hubspot store backup`
+
+copy the store into a new file, while it is in use; never overwrites a file
+
+**Changes something on this computer only.**
+
+```sh
+hubspot store backup [options]
+```
+
+| Argument | | What it is |
+|---|---|---|
+| `file` | required | the new file. |
+
+| Option | What it does |
+|---|---|
+| `--encrypt` | compress and encrypt with a password, typed at a hidden prompt or piped on stdin; it is never kept — lose it and the file cannot be opened. |
+
+**Returns:** store backup — path, from, bytes, schema, rows, encrypted; every field: hubspot commands info store backup
+
+**Example:** `hubspot work store backup ./backup.db`
+
+### `hubspot store restore`
+
+put a backup in place of the store; the store it replaces is kept beside it, never deleted. Given a rollback copy (backups/-rollback-schema--