@wavyx/pdcli 0.1.0 → 0.3.0

package/CHANGELOG.md

@@ -4,7 +4,42 @@ All notable changes to `pdcli` are documented here. Format follows
 [Keep a Changelog](https://keepachangelog.com/); versions follow
 [SemVer](https://semver.org/).
 
-## [Unreleased]
+## [0.3.0] - 2026-06-04
+
+### Added
+
+- Full entity surface: `lead` (v1, UUID ids), `note`, `file`
+  (list/get/download/upload), `filter`, `webhook` (defaults to v2 payloads),
+  `goal`, `pipeline`/`stage`, and `project` (v2) topics.
+- Output formats everywhere: `--output yaml|csv` join `table|json`; `--jq`
+  expression filtering (lazy-loaded native jq); `--fields` column selection.
+- `pdcli backup` — full-account export to a JSON tree (18 resources), with a
+  manifest checkpoint after every resource and `--resume` to continue
+  interrupted runs.
+- Client: binary downloads and multipart uploads (files API), host-locked
+  like every other request.
+
+## [0.2.0] - 2026-06-04
+
+### Added
+
+- Write paths for core CRM: `deal|person|org|activity create/update/delete`
+  (v2 PATCH semantics — only provided fields change). Destructive deletes
+  prompt unless `--yes`.
+- Custom-field input resolution: repeatable `--field "Name=Value"` resolves
+  human field names to hash keys and option labels to IDs (enum, set, and
+  numeric coercion); `--body` accepts raw JSON (typed flags win).
+- `product` topic: `list/get/create/update/delete` with `--price`/`--currency`
+  pairs.
+- OAuth 2.0: `auth login --oauth` (browser authorization-code flow against
+  your own Developer Hub app). Access/refresh tokens, `api_domain`, and the
+  client secret are stored only in the OS keychain; access tokens refresh
+  automatically on expiry and on 401. `auth status` shows mode and expiry;
+  `auth logout` clears both auth modes.
+- `activity create/update --person` maps to a primary participant
+  (`person_id` is read-only on v2 activity writes).
+
+## [0.1.0] - 2026-06-03
 
 ### Added
 

package/README.md

@@ -2,7 +2,7 @@
 
 Command-line interface for [Pipedrive](https://www.pipedrive.com/) — fast, scriptable, built for terminals, CI pipelines, and AI agents.
 
-> **Status: pre-release (v0.1 in development).** Not affiliated with or endorsed by Pipedrive.
+> Not affiliated with or endorsed by Pipedrive.
 
 ## Install
 
@@ -10,22 +10,71 @@ Command-line interface for [Pipedrive](https://www.pipedrive.com/) — fast, scr
 npm install -g @wavyx/pdcli
 ```
 
-## Quick start
+## Authenticate
 
 ```bash
-pdcli auth login          # company domain + API token (stored in your OS keychain)
-pdcli user me
-pdcli deal list --limit 10
-pdcli deal list --output json | jq '.[].id'
-pdcli field list deal     # custom fields with their hash keys
+pdcli auth login            # personal API token (app.pipedrive.com/settings/api)
+pdcli auth login --oauth    # OAuth 2.0 via your own Developer Hub app
+pdcli auth status
+```
+
+Credentials live **only in your OS keychain** — never in plaintext on disk. OAuth
+access tokens refresh automatically. CI/scripts can use env vars instead:
+`PDCLI_COMPANY_DOMAIN=acme PDCLI_API_TOKEN=... pdcli deal list`
+
+## Read
+
+```bash
+pdcli deal list --status open --limit 20
+pdcli deal get 42
+pdcli person list --org 7 --jq '.[].id'
+pdcli activity list --todo
+pdcli lead list
+pdcli note list --deal 42
+pdcli pipeline list && pdcli stage list --pipeline 1
 pdcli search "acme"
-pdcli api GET /api/v1/currencies   # raw, host-locked escape hatch
+pdcli field list deal           # custom fields with their hash keys
+```
+
+Output everywhere: `--output table|json|yaml|csv`, `--jq '<expr>'`, `--fields id,name`.
+
+## Write
+
+```bash
+pdcli deal create --title "Acme renewal" --value 5000 --currency EUR --stage 3
+pdcli deal update 42 --status won
+pdcli activity create --subject "Follow up" --type call --due-date 2026-06-10 --deal 42
+pdcli product create --name "Consulting" --price 150 --currency EUR
+pdcli deal delete 42            # asks first; --yes to skip
+```
+
+Custom fields by **human name** — labels and option IDs resolve automatically:
+
+```bash
+pdcli deal create --title "Sized" --field "Deal Size=Large" --field "Score=4.5"
+pdcli deal update 42 --body '{"probability":75}'   # raw JSON escape hatch
+```
+
+## Files, webhooks, backup
+
+```bash
+pdcli file upload ./contract.pdf --deal 42
+pdcli file download 15 --out ./contract.pdf
+pdcli webhook create --url https://ci.example.com/hook --event-action create --event-object deal
+pdcli backup --dir ./pipedrive-backup    # full account → JSON tree, --resume to continue
+```
+
+## Anything else
+
+```bash
+pdcli api GET /api/v2/pipelines          # raw, host-locked to YOUR domain
+pdcli api POST /api/v2/deals --body '{"title":"Raw deal"}'
+pdcli doctor                             # diagnose auth/keychain/connectivity
 ```
 
-- Token lives **only** in the OS keychain — never in plaintext on disk.
-- `--output table|json` on every command; table in a TTY, JSON when piped.
+- `--output table|json|yaml|csv` everywhere; table in a TTY, JSON when piped.
 - Deterministic [sysexits](https://man.freebsd.org/cgi/man.cgi?query=sysexits) exit codes for scripting.
-- CI: `PDCLI_COMPANY_DOMAIN=acme PDCLI_API_TOKEN=... pdcli deal list`
+- Full reference: [docs/commands.md](docs/commands.md) (generated from the CLI manifest).
 
 ## License