From 143186e9728d47a6f7566d380920d17a1905e238 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 4 Sep 2026 12:27:47 +0000 Subject: [PATCH] docs: generate a full command reference into the README The README showed a handful of hand-picked examples, so the only way to discover the other two dozen commands and their flags was `--help` on a guess. Add a Commands section generated by `oclif readme` from the command classes, and run it from `prepack` so a publish cannot ship a reference that has drifted from the code. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_018KocZzBsaC3JNDSFU2QvD6 --- README.md | 882 +++++++++++++++++++++++++++++++++++++++++++++++++++ package.json | 3 +- 2 files changed, 884 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f73e15..4703181 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,888 @@ pipecorn config get base_url Config lives at the platform's standard XDG location (`~/.config/pipecorn/config.json` on Linux/macOS). +## Commands + +Every command, argument and flag. Generated from the command classes by +`npm run docs` — edit the command, not this section. + + +* [`pipecorn accounts enrich`](#pipecorn-accounts-enrich) +* [`pipecorn accounts search`](#pipecorn-accounts-search) +* [`pipecorn accounts stack`](#pipecorn-accounts-stack) +* [`pipecorn autocomplete [SHELL]`](#pipecorn-autocomplete-shell) +* [`pipecorn config get KEY`](#pipecorn-config-get-key) +* [`pipecorn config list`](#pipecorn-config-list) +* [`pipecorn config set KEY VALUE`](#pipecorn-config-set-key-value) +* [`pipecorn contacts enrich`](#pipecorn-contacts-enrich) +* [`pipecorn contacts get ID`](#pipecorn-contacts-get-id) +* [`pipecorn credits`](#pipecorn-credits) +* [`pipecorn help [COMMAND]`](#pipecorn-help-command) +* [`pipecorn jobs`](#pipecorn-jobs) +* [`pipecorn jobs delete ID`](#pipecorn-jobs-delete-id) +* [`pipecorn jobs status ID`](#pipecorn-jobs-status-id) +* [`pipecorn leads enrich`](#pipecorn-leads-enrich) +* [`pipecorn leads search`](#pipecorn-leads-search) +* [`pipecorn lists`](#pipecorn-lists) +* [`pipecorn lists create NAME`](#pipecorn-lists-create-name) +* [`pipecorn lists export ID`](#pipecorn-lists-export-id) +* [`pipecorn lists show ID`](#pipecorn-lists-show-id) +* [`pipecorn lists update ID`](#pipecorn-lists-update-id) +* [`pipecorn locations QUERY`](#pipecorn-locations-query) +* [`pipecorn login [KEY]`](#pipecorn-login-key) +* [`pipecorn logout`](#pipecorn-logout) +* [`pipecorn personas`](#pipecorn-personas) +* [`pipecorn personas show UUID`](#pipecorn-personas-show-uuid) +* [`pipecorn signals growth`](#pipecorn-signals-growth) +* [`pipecorn signals hiring`](#pipecorn-signals-hiring) +* [`pipecorn signals job-changes`](#pipecorn-signals-job-changes) +* [`pipecorn signals track-job-changes`](#pipecorn-signals-track-job-changes) +* [`pipecorn whoami`](#pipecorn-whoami) + +## `pipecorn accounts enrich` + +Enrich a single company by domain, name, or LinkedIn URL. + +``` +USAGE + $ pipecorn accounts enrich [--api-key ] [--format json|csv|table] [--quiet] [-o ] [--domain ] + [--name ] [--linkedin-url ] [--country ] + +FLAGS + --country= Two-letter ISO country code + --domain= Company website domain + --linkedin-url= LinkedIn company profile URL + --name= Company name + +GLOBAL FLAGS + -o, --output= Write output to a file instead of stdout + --api-key= [env: PIPECORN_API_KEY] Pipecorn API key (overrides env + saved credentials) + --format=