Fxiaoke CRM CLI
Treat Fxiaoke CRM as the fact source and use the official sharecrm CLI. Results are limited to the authenticated user's CRM permissions. Never ask for tokens, secrets, cookies, credentials, or manual token paste.
Workflow
- Check authentication:
sharecrm auth status
- Verify the current remote command surface with
sharecrm --help and the relevant subcommand --help before relying on syntax.
- Inspect the live object schema before querying:
sharecrm data describe get -d '{"apiName":"ContractObj"}'
The following legacy form is incomplete and must not be run because it omits the required payload:
sharecrm data describe get
- Query records using the live object, field names, and options. Default to read-only work. Page with
LIMIT 50 OFFSET n until .queryMeta.returnedCount and .queryMeta.totalNumber show the result set is complete.
- Before any CRM create, update, delete, follow-up, or other write, show the exact intended change and obtain explicit confirmation immediately before executing it.
Tenant schemas and CLI commands can change. Never guess fields, option values, or write syntax. For every metric, disclose the date range and timezone, source object, date field, metric field, status field and filter, included records, formula, and numerator/denominator when applicable.
See CLI reference for commands, metric recipes, examples, and troubleshooting.
1---2name: fxiaoke-crm-cli3description: Use for Fxiaoke or 纷享销客 CRM tasks, including records, customers, contacts, opportunities, contracts, deal cycles, conversion, sales orders, delivery, payments, receivables, follow-ups, statistics, and writes through the official sharecrm CLI.4---56# Fxiaoke CRM CLI78Treat Fxiaoke CRM as the fact source and use the official `sharecrm` CLI. Results are limited to the authenticated user's CRM permissions. Never ask for tokens, secrets, cookies, credentials, or manual token paste.910## Workflow11121. Check authentication:1314```bash15sharecrm auth status16```17182. Verify the current remote command surface with `sharecrm --help` and the relevant subcommand `--help` before relying on syntax.193. Inspect the live object schema before querying:2021```bash22sharecrm data describe get -d '{"apiName":"ContractObj"}'23```2425The following legacy form is incomplete and must not be run because it omits the required payload:2627```text28sharecrm data describe get29```30314. Query records using the live object, field names, and options. Default to read-only work. Page with `LIMIT 50 OFFSET n` until `.queryMeta.returnedCount` and `.queryMeta.totalNumber` show the result set is complete.325. Before any CRM create, update, delete, follow-up, or other write, show the exact intended change and obtain explicit confirmation immediately before executing it.3334Tenant schemas and CLI commands can change. Never guess fields, option values, or write syntax. For every metric, disclose the date range and timezone, source object, date field, metric field, status field and filter, included records, formula, and numerator/denominator when applicable.3536See [CLI reference](references/cli-reference.md) for commands, metric recipes, examples, and troubleshooting.
stardustai