CLI reference
This page is generated from the crm command tree.
crm
Stateful CLI for Microsoft Dynamics 365 CE — on-prem v9.x (NTLM) or Dataverse online (OAuth), over the Web API.
Usage:
crm [OPTIONS] [COMMAND] [ARGS]...
Options:
--json Emit machine-readable JSON output.
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys (JSON: per
row/record; human: table columns). Applied
after curation; the ok/error/meta envelope
is untouched.
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data in the
envelope. Implies --json. Mutually exclusive
with --fields. An invalid program is a usage
error (exit 2).
--dry-run Preview writes without issuing them; reads
run normally.
--profile TEXT Connection profile name (from the profiles/
dir under CRM_HOME; default ~/.crm).
--password TEXT Secret for this run (overrides the profile's
stored secret).
--log-level [debug|info|warning|error]
Log level (env: CRM_LOG_LEVEL). Default:
warning.
--verbose Alias for --log-level debug.
--log-format [text|json-line] Log output format (env: CRM_LOG_FORMAT).
Default: text.
--auth-scheme [ntlm|kerberos|negotiate|oauth]
Override the active profile's auth scheme
for this run. ntlm/kerberos/negotiate = on-
prem; oauth = cloud.
--stage-only Stage metadata changes without publishing
(env: CRM_STAGE_ONLY). Forces every
create/update command to --no-publish.
--retry-on-ambiguous Re-enable auto-retry of non-idempotent POST
creates on transport error / 429 / 503 (env:
CRM_RETRY_ON_AMBIGUOUS). Off by default: a
lost POST response may have committed.
--cache-metadata Read entity definitions from the persistent
on-disk cache (env: CRM_CACHE_METADATA).
Default off.
--refresh-metadata Force-refresh the on-disk metadata cache on
this call (one-shot; no env override).
--session TEXT Session name.
--version Show the version and exit.
-h, --help Show this message and exit.
crm action
Invoke OData functions and actions (unbound or bound).
Usage:
crm action [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm action function
Call an OData function — unbound by default, bound when --bind-set is given.
Functions issue a GET. Scalar params are encoded inline per OData v4; a
record-reference param ({"@odata.id": "
Usage:
crm action function [OPTIONS] NAME
Options:
--params TEXT JSON dict of function parameters.
--bind-set TEXT Entity set to bind the function to (e.g.
'systemusers'). Alone → collection-bound; with
--bind-id → record-bound.
--bind-id TEXT Record id to bind the function to. Requires --bind-
set.
--cast TEXT Namespace for the function when bound. Override only
for custom namespaces. [default:
Microsoft.Dynamics.CRM]
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm action invoke
POST an OData action — unbound by default, bound when --bind-set/--bind-id given.
Usage:
crm action invoke [OPTIONS] NAME
Options:
--body TEXT JSON body for the action.
--body-file FILE
--bind-set TEXT Entity set name to bind the action to (e.g.
'workflows'). Requires --bind-id.
--bind-id TEXT Record id to bind the action to. Requires --bind-set.
--cast TEXT Namespace for the action when bound. Override only
for custom namespaces. [default:
Microsoft.Dynamics.CRM]
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm app
Create and manage model-driven apps (appmodule).
Usage:
crm app [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm app add-components
Bind components to an app (AddAppComponents).
Usage:
crm app add-components [OPTIONS] APP_ID
Options:
--component TEXT Repeatable 'kind:guid' (kind:
view|chart|form|dashboard|sitemap|bpf). [required]
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm app build-sitemap
Build a SiteMapXml from areas/groups/subareas and create the sitemap.
Usage:
crm app build-sitemap [OPTIONS] SITEMAP_NAME
Options:
--area TEXT Repeatable 'id[:Title]'. [required]
--group TEXT Repeatable 'areaId/groupId[:Title]'.
--subarea TEXT Repeatable
'areaId/groupId:entity=<logical>[:Title]'. Binds a
table via Entity=.
--unique-name TEXT App uniquename to link the sitemap to (sets
sitemapnameunique).
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm app create
Create a model-driven app.
Usage:
crm app create [OPTIONS]
Options:
--name TEXT App display name. [required]
--unique-name TEXT Publisher-prefixed unique name, e.g.
'cwx_crmworx'. [required]
--description TEXT
--if-exists [error|skip]
--icon-webresource TEXT Web resource (name or GUID) for the app icon.
Defaults to the platform icon when omitted.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm app delete
Delete a model-driven app, sweeping FK-blocking dependent rows first.
Resolves NAME_OR_ID as an appmoduleid (GUID), else its uniquename, else its display name. Removes the dependent data rows that hold a record-level FK to the app (e.g. appsetting on on-prem) before deleting the app, and lists every record it removed. Refuses a managed app.
Usage:
crm app delete [OPTIONS] NAME_OR_ID
Options:
--yes Skip interactive confirmation.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm app remove-components
Unbind components from an app (RemoveAppComponents).
Usage:
crm app remove-components [OPTIONS] APP_ID
Options:
--component TEXT Repeatable 'kind:guid' (kind:
view|chart|form|dashboard|sitemap|bpf). [required]
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm app set-sitemap
Create a sitemap from a SiteMapXml file.
Usage:
crm app set-sitemap [OPTIONS] SITEMAP_NAME
Options:
--xml-file FILE Path to a file containing the SiteMapXml.
[required]
--unique-name TEXT App uniquename to link the sitemap to (sets
sitemapnameunique).
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm apply
Apply a declarative desired-state spec.
The spec declares a publisher, solution, entities (with attributes, option
sets, relationships, and views), web resources, security roles, and plug-ins
(assembly + types + steps + images), driven in dependency order with
PublishAllXml once at the end (web resources are published with everything
else; security roles and plug-in registration are not publishable). A web
resource's or plug-in assembly's file path is resolved relative to the spec
file. apply is convergent: a component that already
exists is reconciled against the spec — left untouched when it matches,
updated in place when an allowed field drifts, or refused (no write) when the
divergence would need a destructive drop-and-recreate (see ADR 0014). Emits
{ok, data:{applied, updated, skipped, replace_blocked, pruned, planned,
failed}, meta:{staged}}; a replace-blocked component makes ok=false (exit 1).
With the global --dry-run flag the same reconcile runs read-only and the
result is a full drift report — planned (would create), updated (would
update), replace_blocked, and pruned (solution components absent from the
spec, each {kind, name, deleted: false}) — assembled from live reads with no
write issued (#550). --prune opts in to deleting those extras (#553): schema-
only kinds under a confirmation, data-bearing kinds only with --allow-data-loss.
Usage:
crm apply [OPTIONS]
Options:
-f, --file FILE Path to the YAML or JSON desired-state spec.
Exactly one of -f/--file or --from-plan is
required.
--from-plan FILE Execute a saved plan (from `--dry-run apply
-o`) only if it is still exactly true.
Mutually exclusive with -f; its intent
(prune / allow-data-loss / stage-only) is
replayed, not re-specified. With --dry-run,
re-verifies without executing.
--include-referenced-optionsets / --no-include-referenced-optionsets
Add a picklist's referenced global option
set to the target solution (covers pre-
existing globals the create step skips).
[default: include-referenced-optionsets]
--prune Delete components in the target solution
that the spec no longer declares (schema-
only kinds). Requires a target solution and
a confirmation; preview with --dry-run
first.
--allow-data-loss With --prune, also delete data-bearing
extras (entities, attributes) — this
destroys their row data.
-o, --plan-out FILE Serialize the --dry-run drift report to this
path as a plan artifact (JSON). Valid only
with the global --dry-run flag. The plan is
always written, including when the dry-run
exits 1.
--yes Skip interactive confirmation.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm async
List, inspect, and cancel asynchronous operations.
Usage:
crm async [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm async cancel
Cancel a pending or suspended asyncoperation.
Usage:
crm async cancel [OPTIONS] ASYNC_OPERATION_ID
Options:
--yes Skip interactive confirmation.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm async get
Get one asyncoperation row.
Usage:
crm async get [OPTIONS] ASYNC_OPERATION_ID
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm async list
List asyncoperation rows.
Usage:
crm async list [OPTIONS]
Options:
--state TEXT ready | suspended | locked | completed | <int>
--message TEXT Filter by messagename (e.g. ImportSolution).
--owner TEXT Filter by systemuser GUID.
--top INTEGER Page size per call (default 50).
--order-by TEXT OData $orderby expression (default: 'createdon
desc').
--filter TEXT Raw OData $filter expression to AND-join.
--all Follow @odata.nextLink until exhausted (caps at
--max-pages).
--max-pages INTEGER Safety cap on pagination depth when --all is set
(default 20).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm audit
Retrieve server-side audit change history (Web API audit functions).
Usage:
crm audit [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm audit detail
Retrieve the decoded AuditDetail for one audit row (RetrieveAuditDetails).
AUDIT_ID is the auditid GUID of a row in the audit table. The returned AuditDetail's concrete type is surfaced as AuditDetailType.
Usage:
crm audit detail [OPTIONS] AUDIT_ID
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm audit history
Retrieve a record's audited data changes (RetrieveRecordChangeHistory).
ENTITY_SET is the target entity set (e.g. 'accounts'); RECORD_ID its GUID. Returns an AuditDetailCollection whose MoreRecords/PagingCookie/TotalRecordCount drive paging — pass the returned PagingCookie via --paging-cookie for the next page.
Usage:
crm audit history [OPTIONS] ENTITY_SET RECORD_ID
Options:
--page INTEGER 1-based page number to retrieve. [default: 1]
--count INTEGER Page size — audit rows to return per page. [default:
50]
--paging-cookie TEXT PagingCookie from a prior page's
AuditDetailCollection, to fetch the next page.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm batch
Execute a $batch from a JSON file.
Usage:
crm batch [OPTIONS] FILE_PATH
Options:
--no-transaction Send each op as a top-level operation; no changeset
wrapping.
--continue-on-error Send Prefer: odata.continue-on-error (requires --no-
transaction).
-o, --output FILE Write BatchResult[] JSON to this path.
--timeout INTEGER Override request timeout (seconds) for the batch
call.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm chart
Author system and user charts (savedqueryvisualization / userqueryvisualization) headlessly, without the chart designer.
Usage:
crm chart [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm chart add-series
Add an aggregate series to a chart (fetch attribute + measure + presentation series).
Usage:
crm chart add-series [OPTIONS] CHART_ID
Options:
--column TEXT Logical name of the column to aggregate.
[required]
--aggregate [count|countcolumn|sum|avg|min|max]
Aggregate function applied to --column.
[required]
--alias TEXT Unique alias for the new series. [required]
--user-owned Edit a user chart (userqueryvisualization)
instead of a system chart. User charts are
never published.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm chart create
Create a chart on ENTITY.
Modes (mutually exclusive): --data-description FILE + --presentation-description FILE XML-based chart authored from files in source control. --web-resource NAME Script-based visualization backed by a web resource.
Usage:
crm chart create [OPTIONS] ENTITY
Options:
--name TEXT Chart display name. [required]
--data-description FILE Path to the datadescription XML file (use
with --presentation-description; not with
--web-resource).
--presentation-description FILE
Path to the presentationdescription XML file
(use with --data-description; not with
--web-resource).
--web-resource TEXT Web resource name or GUID for a script-based
visualization (not with --data-description /
--presentation-description).
--user-owned Create a user chart (userqueryvisualization)
instead of a system chart.
--description TEXT Chart description.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm chart delete
Delete a chart by CHART_ID.
Usage:
crm chart delete [OPTIONS] CHART_ID
Options:
--user-owned Delete a user chart instead of a system chart.
--yes Skip interactive confirmation.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm chart get
Get a single chart by CHART_ID (its XML included for --json export).
Usage:
crm chart get [OPTIONS] CHART_ID
Options:
--user-owned Look up a user chart instead of a system chart.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm chart list
List charts for ENTITY (system charts by default; --user-owned for user charts).
Usage:
crm chart list [OPTIONS] ENTITY
Options:
--user-owned List user charts instead of system charts.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm chart remove-series
Remove an aggregate series from a chart by its alias (refuses the last series).
Usage:
crm chart remove-series [OPTIONS] CHART_ID
Options:
--alias TEXT Alias of the series to remove. [required]
--user-owned Edit a user chart (userqueryvisualization) instead
of a system chart. User charts are never
published.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm chart set-fetch
Replace the inner
Usage:
crm chart set-fetch [OPTIONS] CHART_ID
Options:
--fetch FILE Path to a file with the replacement <fetch>
element. [required]
--user-owned Edit a user chart (userqueryvisualization) instead
of a system chart. User charts are never
published.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm chart set-groupby
Set a chart's grouping (category) column, optionally with a date grouping.
Usage:
crm chart set-groupby [OPTIONS] CHART_ID
Options:
--column TEXT Logical name of the grouping (category)
column. [required]
--dategrouping [day|week|month|quarter|year|fiscal-period|fiscal-year]
Date grouping interval (only for date
columns).
--user-owned Edit a user chart (userqueryvisualization)
instead of a system chart. User charts are
never published.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm chart update
Update a chart's XML, name/description, or series chart type.
On a partial XML update (only one of --data-description / --presentation-description) the other column is read live so the alias-coupling pair is validated together. The chart's host entity (primaryentitytypecode) is never changed.
Usage:
crm chart update [OPTIONS] CHART_ID
Options:
--data-description FILE Replace the datadescription XML from this
file.
--presentation-description FILE
Replace the presentationdescription XML from
this file.
--name TEXT New chart display name.
--description TEXT New chart description.
--type TEXT Set the chart type (ChartType) on every
series, e.g. Column, Bar, Line, Pie.
--user-owned Edit a user chart (userqueryvisualization)
instead of a system chart. User charts are
never published.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm completion
Print or install shell completion for bash, zsh, fish, or PowerShell.
Usage:
crm completion [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm completion install
Cache the completion script under CRM_HOME and print the rc line to source it.
Idempotent: re-running rewrites the same script + marker. Never edits a shell
rc file — it only prints the one source <path> line for you to add.
Usage:
crm completion install [OPTIONS]
Options:
--shell [zsh|bash|fish|powershell]
Target shell. Defaults to autodetecting
$SHELL.
--path FILE Where to write the script. Default:
${CRM_HOME}/completion/crm.<shell>.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm completion show
Print the completion source script to stdout (does not write anything).
Usage:
crm completion show [OPTIONS]
Options:
--shell [zsh|bash|fish|powershell]
Target shell. Defaults to autodetecting
$SHELL.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm connection
Diagnose the active connection (WhoAmI, reachability, doctor).
Profiles and stored secrets are managed under crm profile.
Usage:
crm connection [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm connection doctor
Diagnose the connection: DNS/TCP, TLS, api_version, auth, rate-limit.
Usage:
crm connection doctor [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm connection status
Show the active session + profile (no network call).
Usage:
crm connection status [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm connection test
Reachability check: WhoAmI + report API base.
Usage:
crm connection test [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm connection whoami
Issue WhoAmI() against the server, with the serving profile/org/URL.
Usage:
crm connection whoami [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm connectionrole
Define record-to-record connection roles (create / scope / match).
Usage:
crm connectionrole [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm connectionrole create
Create a connection role named NAME.
Usage:
crm connectionrole create [OPTIONS]
Options:
--name TEXT Connection role name. [required]
--category [business|family|other|sales|sales-team|service|social|stakeholder]
Connection role category.
--description TEXT Role description.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm connectionrole match
Pair ROLE_A and ROLE_B (each a name or id) as reciprocal roles.
Usage:
crm connectionrole match [OPTIONS] ROLE_A ROLE_B
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm connectionrole scope
Restrict ROLE (name or id) to records of ENTITY.
Call repeatedly to scope a role to several entity types.
Usage:
crm connectionrole scope [OPTIONS] ROLE
Options:
--entity TEXT Entity logical name the role applies to. [required]
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for a
deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dashboard
Author organization-owned system dashboards (systemform type=0) from FormXml headlessly, without the dashboard designer.
Usage:
crm dashboard [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm dashboard add-chart
Add a chart tile (ChartGrid) to dashboard DASHBOARD_ID's FormXml.
Usage:
crm dashboard add-chart [OPTIONS] DASHBOARD_ID
Options:
--view TEXT savedquery id (GUID) whose data the grid shows.
[required]
--chart TEXT savedqueryvisualization id (GUID) to render; its
primary entity must match the view's. [required]
--force Add beyond the default six-component cap.
--colspan INTEGER RANGE Cell colspan. [default: 1; x>=1]
--rowspan INTEGER RANGE Cell rowspan; the section is padded to match it.
[default: 1; x>=1]
--section TEXT Add to an existing section (name or id); default:
a new section per tile (one component per
section).
--tab TEXT Target tab (name or id; default: first tab).
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dashboard add-iframe
Add an IFRAME tile to dashboard DASHBOARD_ID's FormXml.
Usage:
crm dashboard add-iframe [OPTIONS] DASHBOARD_ID
Options:
--url TEXT The IFRAME URL (must be non-empty). [required]
--security Restrict cross-frame scripting (the FormXml
Security flag).
--scrolling Show IFRAME scrollbars.
--border Draw a border around the IFRAME.
--pass-parameters Pass record object-type code and id as URL
parameters.
--force Add beyond the default six-component cap.
--colspan INTEGER RANGE Cell colspan. [default: 1; x>=1]
--rowspan INTEGER RANGE Cell rowspan; the section is padded to match it.
[default: 1; x>=1]
--section TEXT Add to an existing section (name or id); default:
a new section per tile (one component per
section).
--tab TEXT Target tab (name or id; default: first tab).
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dashboard add-view
Add a view-only grid tile (ChartGrid) to dashboard DASHBOARD_ID's FormXml.
Usage:
crm dashboard add-view [OPTIONS] DASHBOARD_ID
Options:
--view TEXT savedquery id (GUID) whose data the grid
shows. [required]
--mode [list|all] Grid only (list) or grid with the chart
toggle (all). [default: list]
--records-per-page INTEGER RANGE
Rows shown per page in the grid. [default:
10; x>=1]
--force Add beyond the default six-component cap.
--colspan INTEGER RANGE Cell colspan. [default: 1; x>=1]
--rowspan INTEGER RANGE Cell rowspan; the section is padded to match
it. [default: 1; x>=1]
--section TEXT Add to an existing section (name or id);
default: a new section per tile (one
component per section).
--tab TEXT Target tab (name or id; default: first tab).
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm dashboard add-webresource
Add a web-resource tile to dashboard DASHBOARD_ID's FormXml.
Usage:
crm dashboard add-webresource [OPTIONS] DASHBOARD_ID
Options:
--webresource TEXT Web resource id (GUID) or unique name to embed.
[required]
--force Add beyond the default six-component cap.
--colspan INTEGER RANGE Cell colspan. [default: 1; x>=1]
--rowspan INTEGER RANGE Cell rowspan; the section is padded to match it.
[default: 1; x>=1]
--section TEXT Add to an existing section (name or id); default:
a new section per tile (one component per
section).
--tab TEXT Target tab (name or id; default: first tab).
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dashboard create
Create an organization-owned system dashboard from a FormXml file.
Usage:
crm dashboard create [OPTIONS]
Options:
--name TEXT Dashboard display name. [required]
--formxml FILE Path to the dashboard FormXml file. [required]
--description TEXT Dashboard description.
--interactive (Rejected) interactive-experience (type-10)
dashboards are not creatable over the Web API —
see the error for details.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dashboard delete
Delete a dashboard by DASHBOARD_ID.
Usage:
crm dashboard delete [OPTIONS] DASHBOARD_ID
Options:
--yes Skip interactive confirmation.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dashboard get
Get a single dashboard by DASHBOARD_ID (its FormXml included for export).
Usage:
crm dashboard get [OPTIONS] DASHBOARD_ID
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dashboard list
List organization-owned dashboards.
Usage:
crm dashboard list [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dashboard remove-component
Remove one component from dashboard DASHBOARD_ID, selected by exactly one of --cell-id / --index / --view / --chart / --url.
Usage:
crm dashboard remove-component [OPTIONS] DASHBOARD_ID
Options:
--cell-id TEXT Remove the component cell with this id.
--index INTEGER Remove the component at this 0-based position.
--view TEXT Remove the component whose ViewId is this
savedquery id.
--chart TEXT Remove the component whose VisualizationId is this
id.
--url TEXT Remove the IFRAME/web-resource component with this
Url.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm data
Bulk CSV/JSON dataset import/export.
Usage:
crm data [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm data delete
Submit a server-side BulkDelete job for records matching a FetchXML query.
The Web API's BulkDelete action takes a QueryExpression, so the FetchXML is converted server-side before submission (raw OData $filter is not accepted). Returns the job's async-operation id; pass --wait to poll to completion.
Usage:
crm data delete [OPTIONS] ENTITY_SET
Options:
--fetchxml TEXT FetchXML <fetch> document selecting the records to
delete.
--fetchxml-file FILENAME Read the FetchXML from a file instead of
--fetchxml.
--job-name TEXT Name for the bulk-delete system job (default
derived from the entity).
--wait Block until the job finishes, then report
succeeded/failed counts.
--timeout INTEGER Seconds to wait under --wait (default: the
profile's async timeout).
--yes Skip interactive confirmation.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm data export
Export records from an entity set to a CSV/JSON file.
Pages through the entity set (--page-size per request, capped by
--max-records), narrowing columns with --select and rows with an OData
--filter, and writes the result to --output. --format is optional —
when omitted it is inferred from the output file's suffix (.csv → csv, else
json).
Usage:
crm data export [OPTIONS] ENTITY_SET
Options:
-o, --output FILE [required]
--select TEXT
--filter TEXT OData $filter.
--page-size INTEGER
--max-records INTEGER
--format [csv|json]
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm data import
Bulk-import records from a JSONL/CSV file via $batch.
Usage:
crm data import [OPTIONS] ENTITY_SET INPUT_FILE
Options:
--format [jsonl|csv] Input format; inferred from suffix when
omitted (.csv→csv, else jsonl).
--mode [create|upsert|delete] create=POST new records; upsert=PATCH by GUID
(--id-column) or by alternate key (--key);
delete=DELETE by GUID (--id-column) or by
alternate key (--key).
--id-column TEXT Column/key holding the record GUID (for
--mode upsert/delete; mutually exclusive with
--key).
--key ATTR[,ATTR...] Upsert by an alternate key instead of the
primary GUID: one attribute, or a comma-
separated composite key. Values are read from
each row. Mutually exclusive with --id-
column.
--chunk-size INTEGER Records per $batch call (each chunk is one
transactional changeset by default).
--no-transaction Send each op as a top-level operation; no
changeset wrapping.
--continue-on-error Send Prefer: odata.continue-on-error
(requires --no-transaction).
--yes Skip interactive confirmation.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also
valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before the
command]
-h, --help Show this message and exit.
crm describe
Emit a machine-readable catalogue of all commands, options, and choices.
With no argument, walks the whole tree. With GROUP, walks only that command's subtree — importing just that one module (a lazy win over the full walk).
Usage:
crm describe [OPTIONS] [GROUP]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm doctor
Diagnose the connection: DNS/TCP, TLS, api_version, auth, rate-limit.
Usage:
crm doctor [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dup
Manage duplicate-detection rules (duplicaterule / duplicaterulecondition).
Usage:
crm dup [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm dup add-condition
Add a match condition to RULE (name or id).
--operator one of: exact, same-first, same-last, same-date, same-datetime, exact-picklist-label, exact-picklist-value. The same-first / same-last operators require --operator-param N (the character count); the others reject it.
Usage:
crm dup add-condition [OPTIONS] RULE
Options:
--attr TEXT Base column logical name to compare.
[required]
--operator [exact|same-first|same-last|same-date|same-datetime|exact-picklist-label|exact-picklist-value]
Match operator for the condition.
[required]
--matching-attr TEXT Matching column logical name (defaults to
--attr).
--operator-param INTEGER Character count N for same-first / same-last
operators.
--ignore-blank-values Treat blank values as non-duplicates (do not
match on null).
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm dup bulk-detect
Sweep ENTITY for duplicates via the async BulkDetectDuplicates job.
Detects duplicates among ENTITY rows according to the published duplicate rules for that table and logs them as duplicaterecord rows. Sweeps the whole table by default, or the records matched by --fetchxml. Returns the job id immediately; pass --wait to poll to completion and list the detected duplicates. Detection only — nothing is merged or deleted.
Usage:
crm dup bulk-detect [OPTIONS] ENTITY
Options:
--fetchxml TEXT FetchXML <fetch> narrowing the swept records (its
<entity> must be ENTITY). Omit to sweep the whole
table.
--fetchxml-file FILENAME Read the narrowing FetchXML from a file instead of
--fetchxml.
--job-name TEXT Name for the detection system job (default derived
from ENTITY).
--wait Block until the job finishes, then report the
detected duplicates.
--timeout INTEGER Seconds to wait under --wait (default: the
profile's async timeout).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dup check
Test a candidate ENTITY record against the published rules (RetrieveDuplicates).
Supply the candidate record's column values via --data-file or --data. Only published rules on a duplicate-detection-enabled entity match; with no published rule the result is always empty.
Usage:
crm dup check [OPTIONS] ENTITY
Options:
--data-file TEXT Path to a JSON file with the candidate record's
column values.
--data TEXT Inline JSON object of the candidate record's column
values.
--matching-entity TEXT Matching entity logical name (defaults to ENTITY).
--top INTEGER Maximum number of matches to return. [default: 50]
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dup create
Create an (unpublished) duplicate-detection rule on ENTITY.
The rule is created unpublished — add conditions with dup add-condition,
then activate it with dup publish.
Usage:
crm dup create [OPTIONS] ENTITY
Options:
--name TEXT Rule display name. [required]
--matching-entity TEXT Matching entity logical name (defaults to ENTITY).
--description TEXT Rule description.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for a
deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dup get
Show one rule (by name or id) and the conditions it carries.
Usage:
crm dup get [OPTIONS] RULE
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dup list
List duplicate-detection rules.
Usage:
crm dup list [OPTIONS]
Options:
--entity TEXT Filter to rules whose base entity is this logical
name.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dup publish
Publish RULE (name or id) — submits the async PublishDuplicateRule job.
The rule must carry at least one condition. Without --wait the command returns once the job is submitted; with --wait it polls to completion.
Usage:
crm dup publish [OPTIONS] RULE
Options:
--wait Block until the async publish job completes.
--timeout INTEGER Seconds to wait for the job (with --wait).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm dup unpublish
Unpublish RULE (name or id) — UnpublishDuplicateRule (synchronous).
Usage:
crm dup unpublish [OPTIONS] RULE
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm entity
Record CRUD against entity sets (accounts, contacts, ...).
Usage:
crm entity [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm entity associate
Associate two records via a collection-valued nav property (1:N from one-side or N:N).
Usage:
crm entity associate [OPTIONS] TARGET_SET TARGET_ID NAV RELATED_SET RELATED_ID
Options:
--as-user GUID Impersonate systemuser by GUID via MSCRMCallerID
header. Mutually exclusive with --as-user-object-
id.
--as-user-object-id GUID Impersonate by Entra ID object id (cloud) via
CallerObjectId header. Mutually exclusive with
--as-user.
--suppress-dup-detection Send MSCRM.SuppressDuplicateDetection: true.
--bypass-plugins Send MSCRM.BypassCustomPluginExecution: true
(requires prvBypassCustomPluginExecution).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm entity children
Per-relationship related-record counts for the 1:N relationships where
Each row: child entity logical name, referencing attribute, child entity set, and count. Read-only (composes with --dry-run).
Usage:
crm entity children [OPTIONS] ENTITY_SET RECORD_ID
Options:
--non-empty Drop relationships whose related-record count is 0.
--filter-entities REGEX Only count child entities whose logical name
matches REGEX. Applied before querying — fewer
requests, not a post-filter.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global;
also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm entity clear-lookup
Clear a single-valued lookup via DELETE /$ref.
Usage:
crm entity clear-lookup [OPTIONS] ENTITY_SET RECORD_ID NAV
Options:
--yes Skip interactive confirmation.
--as-user GUID Impersonate systemuser by GUID via MSCRMCallerID
header. Mutually exclusive with --as-user-object-
id.
--as-user-object-id GUID Impersonate by Entra ID object id (cloud) via
CallerObjectId header. Mutually exclusive with
--as-user.
--suppress-dup-detection Send MSCRM.SuppressDuplicateDetection: true.
--bypass-plugins Send MSCRM.BypassCustomPluginExecution: true
(requires prvBypassCustomPluginExecution).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm entity clone
Clone a single record, optionally its children.
Copies
--with-children also clones the direct child rows of every custom 1:N relationship where this record is the parent (one level — no recursion). A child create that fails does not roll back or abort: the rest continue and the envelope reports ok=false with meta.created (parent + per-entity child ids) and data.failures (entity, source id, reason). Recover by cloning the failed rows individually — never re-run the whole verb.
Usage:
crm entity clone [OPTIONS] ENTITY_SET RECORD_ID
Options:
--override FIELD=VALUE Repeatable. Set/replace a field on the clone.
VALUE is parsed as JSON, else taken as a
string. The key passes raw, so
'ownerid@odata.bind=/systemusers(<id>)' re-adds
a never-copy field.
--unset FIELD Repeatable. Drop a field (logical name) from
the clone; a lookup's logical name drops the
bind it produced.
--no-return Don't request the record back; return just the
new GUID.
--with-children Also clone the direct child rows of every
custom 1:N relationship where this record is
the parent (one level deep). --override/--unset
apply to the parent only.
--skip-child-entity LOGICAL Repeatable. With --with-children, exclude this
child entity (logical name) from cloning — e.g.
an org-specific plugin-derived table.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the
command]
-h, --help Show this message and exit.
crm entity create
POST a new record.
Usage:
crm entity create [OPTIONS] ENTITY_SET
Options:
--data TEXT JSON object as string.
--data-file FILE Path to a JSON file with the record body.
--no-return Don't request the record back; just GUID.
--return-record Ask server to return the created row (the default
for create).
--validate Pre-write field-name check (1-3 metadata GETs);
blocks unknown fields with did-you-mean.
Composable with --dry-run.
--full Human mode: show every field including nulls and
@odata.* plumbing. Default human output is concise
(populated fields only, new id first). No effect
in --json mode.
--as-user GUID Impersonate systemuser by GUID via MSCRMCallerID
header. Mutually exclusive with --as-user-object-
id.
--as-user-object-id GUID Impersonate by Entra ID object id (cloud) via
CallerObjectId header. Mutually exclusive with
--as-user.
--suppress-dup-detection Send MSCRM.SuppressDuplicateDetection: true.
--bypass-plugins Send MSCRM.BypassCustomPluginExecution: true
(requires prvBypassCustomPluginExecution).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm entity delete
DELETE a record.
Usage:
crm entity delete [OPTIONS] ENTITY_SET RECORD_ID
Options:
--if-match ETAG Optimistic concurrency etag.
--yes Skip interactive confirmation.
--as-user GUID Impersonate systemuser by GUID via MSCRMCallerID
header. Mutually exclusive with --as-user-object-
id.
--as-user-object-id GUID Impersonate by Entra ID object id (cloud) via
CallerObjectId header. Mutually exclusive with
--as-user.
--suppress-dup-detection Send MSCRM.SuppressDuplicateDetection: true.
--bypass-plugins Send MSCRM.BypassCustomPluginExecution: true
(requires prvBypassCustomPluginExecution).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm entity disassociate
Disassociate two records. Omit --related-* for single-valued lookups.
Usage:
crm entity disassociate [OPTIONS] TARGET_SET TARGET_ID NAV
Options:
--related-set TEXT Required for collection-valued nav properties.
--related-id TEXT Required for collection-valued nav properties.
--yes Skip interactive confirmation.
--as-user GUID Impersonate systemuser by GUID via MSCRMCallerID
header. Mutually exclusive with --as-user-object-
id.
--as-user-object-id GUID Impersonate by Entra ID object id (cloud) via
CallerObjectId header. Mutually exclusive with
--as-user.
--suppress-dup-detection Send MSCRM.SuppressDuplicateDetection: true.
--bypass-plugins Send MSCRM.BypassCustomPluginExecution: true
(requires prvBypassCustomPluginExecution).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm entity get
GET
Usage:
crm entity get [OPTIONS] ENTITY_SET RECORD_ID
Options:
--select TEXT Repeatable; column names.
--expand TEXT Repeatable; navigation properties.
--annotations / --no-annotations
Include formatted values.
--minimal JSON mode: drop every key containing '@'
(OData annotations like @odata.etag,
*@FormattedValue, *@lookuplogicalname);
keeps business fields, _*_value lookup
GUIDs, and the primary id.
--expect ATTR=VALUE Repeatable; assert str(record[ATTR]) ==
VALUE (an absent key never matches). Any
mismatch exits 1 (the --json envelope
carries meta {attr, expected, actual}; human
mode prints the error line); all match exits
0.
--full Human mode: show every field including nulls
and @odata.* plumbing. Default human output
is concise (populated fields only, id
first). No effect in --json mode.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm entity set-lookup
Set a single-valued lookup via @odata.bind PATCH.
Usage:
crm entity set-lookup [OPTIONS] ENTITY_SET RECORD_ID NAV RELATED_SET
RELATED_ID
Options:
--as-user GUID Impersonate systemuser by GUID via MSCRMCallerID
header. Mutually exclusive with --as-user-object-
id.
--as-user-object-id GUID Impersonate by Entra ID object id (cloud) via
CallerObjectId header. Mutually exclusive with
--as-user.
--suppress-dup-detection Send MSCRM.SuppressDuplicateDetection: true.
--bypass-plugins Send MSCRM.BypassCustomPluginExecution: true
(requires prvBypassCustomPluginExecution).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm entity update
PATCH an existing record.
Usage:
crm entity update [OPTIONS] ENTITY_SET RECORD_ID
Options:
--data TEXT JSON object as string.
--data-file FILE Path to a JSON file with the record body.
--allow-create Permit upsert (skip If-Match header).
--return-record Ask server to return the updated row (update is
silent by default).
--no-return Don't request the record back (the default for
update).
--if-match ETAG Optimistic concurrency etag. Example (POSIX):
--if-match 'W/"123"'. Use --if-match "*" to
require any current version.
--validate Pre-write field-name check (1-3 metadata GETs);
blocks unknown fields with did-you-mean.
Composable with --dry-run.
--as-user GUID Impersonate systemuser by GUID via MSCRMCallerID
header. Mutually exclusive with --as-user-object-
id.
--as-user-object-id GUID Impersonate by Entra ID object id (cloud) via
CallerObjectId header. Mutually exclusive with
--as-user.
--suppress-dup-detection Send MSCRM.SuppressDuplicateDetection: true.
--bypass-plugins Send MSCRM.BypassCustomPluginExecution: true
(requires prvBypassCustomPluginExecution).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm entity upsert
PATCH with create-if-missing semantics (by GUID, or --key alternate key).
Usage:
crm entity upsert [OPTIONS] ENTITY_SET [RECORD_ID]
Options:
--key ATTR[,ATTR...] Upsert by an alternate key instead of the primary
GUID: one attribute, or a comma-separated
composite key. Values are read from --data, so
omit the RECORD_ID. Mutually exclusive with it.
--data TEXT JSON object as string.
--data-file FILE Path to a JSON file with the record body.
--if-none-match Create-only: send If-None-Match: * so the write
succeeds only if the record does not already exist
(412 precondition error when it does). The
complement to update's --if-match.
--as-user GUID Impersonate systemuser by GUID via MSCRMCallerID
header. Mutually exclusive with --as-user-object-
id.
--as-user-object-id GUID Impersonate by Entra ID object id (cloud) via
CallerObjectId header. Mutually exclusive with
--as-user.
--suppress-dup-detection Send MSCRM.SuppressDuplicateDetection: true.
--bypass-plugins Send MSCRM.BypassCustomPluginExecution: true
(requires prvBypassCustomPluginExecution).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm examples
Browse a curated gallery of runnable example commands.
With no GROUP on a terminal, pick a group then an example; the chosen command is printed for you to copy and edit. With GROUP, jump straight to that group's examples. Under --json or when not on a terminal, prints the full listing.
Usage:
crm examples [OPTIONS] [GROUP]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm fieldsec
Manage field security profiles and column-level permissions.
Usage:
crm fieldsec [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm fieldsec add-permission
Grant column permissions on ENTITY.ATTRIBUTE for PROFILE (name or id).
Pass at least one of --read / --create / --update.
Usage:
crm fieldsec add-permission [OPTIONS] PROFILE ENTITY ATTRIBUTE
Options:
--read Grant read access to the column.
--create Grant create access to the column.
--update Grant update access to the column.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for a
deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm fieldsec assign
Assign PROFILE (name or id) to a user or a team.
Pass exactly one of --user-id / --team.
Usage:
crm fieldsec assign [OPTIONS] PROFILE
Options:
--user-id TEXT System user id to assign.
--team TEXT Team id to assign.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm fieldsec create-profile
Create a field security profile named NAME.
Usage:
crm fieldsec create-profile [OPTIONS] NAME
Options:
--description TEXT Profile description.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for a
deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm fieldsec get
Show one profile (by name or id) and the field permissions it grants.
Usage:
crm fieldsec get [OPTIONS] PROFILE
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm fieldsec list
List all field security profiles.
Usage:
crm fieldsec list [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form
Read and clone entity forms.
Usage:
crm form [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm form add-field
Add a field to an entity form (resolves the control type from metadata).
Usage:
crm form add-field [OPTIONS] ENTITY ATTRIBUTE
Options:
--form TEXT Target form by name or id (default: the sole main
form, or the primary form if the entity has
several).
--tab TEXT Target tab by name or id (default: the first tab).
--section TEXT Target section by name or id (default: the first
section).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form add-handler
Wire a JS event handler on an entity form (registering its library).
Usage:
crm form add-handler [OPTIONS] ENTITY
Options:
--event [onload|onsave|onchange]
Form event to wire the handler to.
[required]
--library TEXT Unique name of the JS web resource holding
the function (it must already exist).
[required]
--function TEXT JS function to call when the event fires
(e.g. App.onLoad). [required]
--field TEXT Attribute whose onchange fires the handler
(required for --event onchange; invalid
otherwise).
--param TEXT Parameter passed to the function
(repeatable; emitted as a comma-separated
list).
--pass-context / --no-pass-context
Pass the execution context as the function's
first parameter. Default: pass.
--enabled / --no-enabled Whether the handler is enabled. Default:
enabled.
--form TEXT Target form by name or id (default: the sole
main form, or the primary form if the entity
has several).
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm form add-library
Register a JS script library on an entity form (idempotent).
Usage:
crm form add-library [OPTIONS] ENTITY
Options:
--library TEXT Unique name of the JS web resource to register (it
must already exist — the editor never creates it).
[required]
--form TEXT Target form by name or id (default: the sole main
form, or the primary form if the entity has
several).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form add-section
Add a section to a tab of an entity form.
Usage:
crm form add-section [OPTIONS] ENTITY NAME
Options:
--tab TEXT Target tab by name or id (default: the first tab).
--label TEXT Display label for the new tab/section (default:
its name).
--columns INTEGER Layout columns (1-4): a new tab's layout columns,
or a new section's cell columns. [default: 1]
--after TEXT Place/move after this sibling tab or section (by
name or id). Add appends to the end by default;
move goes first.
--form TEXT Target form by name or id (default: the sole main
form, or the primary form if the entity has
several).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form add-tab
Add a tab (with a starter section) to an entity form.
Usage:
crm form add-tab [OPTIONS] ENTITY NAME
Options:
--label TEXT Display label for the new tab/section (default:
its name).
--columns INTEGER Layout columns (1-4): a new tab's layout columns,
or a new section's cell columns. [default: 1]
--after TEXT Place/move after this sibling tab or section (by
name or id). Add appends to the end by default;
move goes first.
--form TEXT Target form by name or id (default: the sole main
form, or the primary form if the entity has
several).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form clone
Clone a named form to another entity.
Usage:
crm form clone [OPTIONS] ENTITY FORM_NAME
Options:
--to TEXT Target entity logical name. [required]
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form export
Export a form's formxml.
Usage:
crm form export [OPTIONS] ENTITY FORM_NAME
Options:
-o, --output FILE Write the formxml to this file instead of stdout.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form list
List an entity's forms (main forms by default).
Usage:
crm form list [OPTIONS] ENTITY
Options:
--type [dashboard|main|quickview|quickcreate|dialog|card]
Form type to list (repeatable). Default:
main.
--all List every form type (cannot be combined
with --type).
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm form list-handlers
List the JS event handlers wired on an entity form.
Usage:
crm form list-handlers [OPTIONS] ENTITY
Options:
--form TEXT Target form by name or id (default: the sole main
form, or the primary form if the entity has several).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form move-section
Reorder a section within its tab on an entity form.
Usage:
crm form move-section [OPTIONS] ENTITY SECTION
Options:
--tab TEXT Target tab by name or id (default: the first tab).
--after TEXT Place/move after this sibling tab or section (by
name or id). Add appends to the end by default;
move goes first.
--form TEXT Target form by name or id (default: the sole main
form, or the primary form if the entity has
several).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form move-tab
Reorder a tab on an entity form (to the front, or after --after).
Usage:
crm form move-tab [OPTIONS] ENTITY TAB
Options:
--after TEXT Place/move after this sibling tab or section (by
name or id). Add appends to the end by default;
move goes first.
--form TEXT Target form by name or id (default: the sole main
form, or the primary form if the entity has
several).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form remove-field
Remove a field from an entity form.
Usage:
crm form remove-field [OPTIONS] ENTITY ATTRIBUTE
Options:
--form TEXT Target form by name or id (default: the sole main
form, or the primary form if the entity has
several).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form remove-handler
Remove a JS event handler from an entity form.
Usage:
crm form remove-handler [OPTIONS] ENTITY
Options:
--event [onload|onsave|onchange]
Form event to wire the handler to.
[required]
--function TEXT JS function name of the handler to remove.
[required]
--field TEXT Attribute whose onchange fires the handler
(required for --event onchange; invalid
otherwise).
--form TEXT Target form by name or id (default: the sole
main form, or the primary form if the entity
has several).
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm form remove-section
Remove a section from a tab of an entity form (refuses a section holding bound fields without --force).
Usage:
crm form remove-section [OPTIONS] ENTITY SECTION
Options:
--tab TEXT Target tab by name or id (default: the first tab).
--force Remove even if it still holds bound fields
(orphaning them; the orphaned fields are surfaced
in the output).
--form TEXT Target form by name or id (default: the sole main
form, or the primary form if the entity has
several).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form remove-tab
Remove a tab from an entity form (refuses the only tab, or a tab holding bound fields without --force).
Usage:
crm form remove-tab [OPTIONS] ENTITY TAB
Options:
--force Remove even if it still holds bound fields
(orphaning them; the orphaned fields are surfaced
in the output).
--form TEXT Target form by name or id (default: the sole main
form, or the primary form if the entity has
several).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form rename-section
Set a section's display label on an entity form.
Usage:
crm form rename-section [OPTIONS] ENTITY SECTION
Options:
--tab TEXT Target tab by name or id (default: the first tab).
--label TEXT New display label for the section. [required]
--form TEXT Target form by name or id (default: the sole main
form, or the primary form if the entity has
several).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form rename-tab
Set a tab's display label (its logical name is left intact).
Usage:
crm form rename-tab [OPTIONS] ENTITY TAB
Options:
--label TEXT New display label for the tab. [required]
--form TEXT Target form by name or id (default: the sole main
form, or the primary form if the entity has
several).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form set-field
Move an existing field to a different tab/section of an entity form.
Usage:
crm form set-field [OPTIONS] ENTITY ATTRIBUTE
Options:
--form TEXT Target form by name or id (default: the sole main
form, or the primary form if the entity has
several).
--tab TEXT Target tab by name or id (default: the first tab).
--section TEXT Target section by name or id (default: the first
section).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm form set-field-props
Toggle presentation properties of an existing field on an entity form.
Usage:
crm form set-field-props [OPTIONS] ENTITY ATTRIBUTE
Options:
--locked / --unlocked Lock the field against being moved/removed
on the form (cell locklevel).
--disabled / --enabled Make the field read-only (control disabled).
--show-label / --no-show-label Show the field's label (cell showlabel).
--visible / --hidden Show the field on the form (cell visible).
--required LEVEL Required-level is attribute metadata, not a
form property; passing it here routes you to
`crm metadata update-attribute --required`
instead of silently no-op'ing.
--form TEXT Target form by name or id (default: the sole
main form, or the primary form if the entity
has several).
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm metadata
Browse entity / attribute / relationship metadata.
Usage:
crm metadata [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm metadata add-attribute
Add an attribute (column) to an existing entity.
Usage:
crm metadata add-attribute [OPTIONS] ENTITY
Options:
--kind [string|memo|integer|bigint|decimal|double|money|boolean|datetime|picklist|multiselect|lookup|customer|image|file]
Attribute kind. [required]
--schema-name TEXT PascalCase with publisher prefix, e.g.
'new_Amount'. Defaults to
<publisher_prefix>_<Display> from the
profile.
--display TEXT UI label. [required]
--description TEXT
--required [None|Recommended|ApplicationRequired]
--max-length INTEGER String/memo: max characters (default
100/2000).
--format TEXT String: Text|Email|Url|Phone|TextArea.
Datetime: DateOnly|DateAndTime.
--auto-number-format TEXT String: Auto-number format pattern (e.g.
'INV-{SEQNUM:5}').
--behavior [UserLocal|DateOnly|TimeZoneIndependent]
Datetime: DateTimeBehavior. Omit for the
server default (UserLocal).
--min FLOAT Numeric kinds: minimum value.
--max FLOAT Numeric kinds: maximum value.
--precision INTEGER Decimal/double/money: precision (decimals).
--true-label TEXT Boolean: label for true.
--false-label TEXT Boolean: label for false.
--default-value TEXT Boolean: 'true'/'false'. Picklist: int
option value.
--optionset-name TEXT Picklist/multiselect: reference an existing
global option set.
--option TEXT Picklist/multiselect: inline option as
'value:label' or ':label' (auto value).
Repeatable.
--target-entity TEXT Lookup: referenced entity logical name.
--relationship-schema TEXT Lookup: override auto-generated relationship
name.
--max-size-kb INTEGER File: max attachment size in KB. Default
32768.
--type [simple|rollup|calculated]
Column source: simple (default), or
rollup/calculated — the latter two turn the
--kind column into a rollup/calculated field
and require --formula-file.
--formula-file FILE Rollup/calculated: path to the formula XAML
file. Sent verbatim — the formula body is
officially editor-authored, so hand-written
XAML is unsupported (not validated here).
--audit / --no-audit Enable/disable auditing (IsAuditEnabled).
Requires org-level auditing to be turned on
for audit records to be written; omit to
leave unchanged.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--if-exists [error|skip] If the attribute already exists: error
(default) or skip (no-op success).
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm metadata attribute
Show a single attribute definition.
Usage:
crm metadata attribute [OPTIONS] LOGICAL_NAME ATTRIBUTE_NAME
Options:
--expect ATTR=VALUE Repeatable; assert str(record[ATTR]) == VALUE (an
absent key never matches). Any mismatch exits 1 (the
--json envelope carries meta {attr, expected,
actual}; human mode prints the error line); all match
exits 0.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata attributes
List attributes for an entity.
Usage:
crm metadata attributes [OPTIONS] LOGICAL_NAME
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata cache-clear
Delete the active profile's on-disk metadata cache.
Usage:
crm metadata cache-clear [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata can-relate
Check whether ENTITY can take part in a relationship (read-only).
Without --valid-partners, answers the yes/no eligibility check for the role. With --valid-partners, lists the legal partner tables. Use this before create-one-to-many / create-many-to-many to avoid a server-side fault.
Usage:
crm metadata can-relate [OPTIONS] ENTITY
Options:
--as [referenced|referencing|many-to-many]
Role to test: referenced (1 side),
referencing (N side), or many-to-many.
[required]
--valid-partners List the tables ENTITY may legally pair with
(GetValid* functions) instead of the yes/no
eligibility check. Note: many-to-many lists
ALL N:N-capable tables org-wide, not
partners specific to ENTITY.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm metadata changes
Retrieve new/changed metadata since a version stamp (RetrieveMetadataChanges).
Save the returned server_version_stamp and pass it as --since next time to sync only what changed (plus a deleted_count). Omit --since for a baseline.
Usage:
crm metadata changes [OPTIONS]
Options:
--since TEXT Prior ServerVersionStamp; return only metadata
changed since it. Omit for a baseline snapshot that
returns a fresh stamp to save.
--entity TEXT Scope to an entity logical name (repeatable). Omit to
query every table — heavy on a baseline call.
--attributes Include attribute (column) definitions so column-
level changes show.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata clone-entity
Duplicate a custom entity (skeleton + opt-in forms/views/workflows/charts).
Pure Web API -- no XML. The ribbon is not cloned (no API write path; the result carries a ribbon_note saying so). N:N relationships and the source's parent-side relationships are not cloned.
Usage:
crm metadata clone-entity [OPTIONS] SOURCE NEW_SCHEMA_NAME
Options:
--display TEXT Display name for the clone. Default: '<source
display> (Clone)'.
--with-forms Clone the source's main forms onto the clone.
--with-views Clone the source's public views onto the clone.
--with-workflows Clone the source's classic workflows / business
rules onto the clone.
--with-charts Clone the source's public system charts onto the
clone.
--with-all Enable --with-forms, --with-views, --with-
workflows, and --with-charts.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata create-entity
Create a new custom entity (table).
Pass --external-name/--external-collection-name/--data-provider to create a VIRTUAL table instead, backed by an external data source. Virtual tables are read-only on v9.1 and require the data-provider/data-source records to exist first.
Usage:
crm metadata create-entity [OPTIONS]
Options:
--schema-name TEXT PascalCase with publisher prefix, e.g.
'new_Project'. Defaults to
<publisher_prefix>_<Display> from the
profile.
--display TEXT Singular UI label, e.g. 'Project'.
[required]
--display-collection TEXT Plural UI label. Defaults to <display>+'s'.
--primary-attr TEXT Schema name of the primary name attribute
(default '<prefix>_Name').
--primary-label TEXT UI label for primary attribute. Default
'Name'.
--primary-max-length INTEGER Max length for primary name string column.
Default 200.
--description TEXT
--ownership [UserOwned|OrganizationOwned]
--has-activities
--has-notes
--is-activity Create as an activity entity.
--audit / --no-audit Enable/disable auditing (IsAuditEnabled).
Requires org-level auditing to be turned on
for audit records to be written; omit to
leave unchanged.
--data-provider TEXT Virtual-table data-provider record GUID.
Setting any --external-* / --data-* option
creates a VIRTUAL table (rows live in an
external store). Virtual tables are READ-
ONLY on v9.1 and require the data-provider
(and optional data-source) records to exist
FIRST — configure those prerequisites before
running this.
--data-source TEXT Virtual-table data-source record GUID
(optional).
--external-name TEXT External table name a virtual table maps to
(required for virtual).
--external-collection-name TEXT
External collection/plural name (required
for virtual).
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--if-exists [error|skip] If the entity already exists: error
(default) or skip (no-op success).
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm metadata create-key
Create an alternate key on an entity.
Usage:
crm metadata create-key [OPTIONS] ENTITY
Options:
--name TEXT Alternate key schema name, PascalCase with
publisher prefix, e.g. 'new_Code'. Defaults to
<prefix>_<display> from the profile.
--key-attributes TEXT Comma-separated attribute logical names forming
the key, e.g. 'accountnumber' or
'firstname,emailaddress1'. [required]
--display TEXT UI label. Defaults to the schema name.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--if-exists [error|skip] If the key already exists: error (default) or skip
(no-op success).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata create-many-to-many
Create an N:N relationship via the dedicated action.
Usage:
crm metadata create-many-to-many [OPTIONS]
Options:
--schema-name TEXT [required]
--entity1 TEXT [required]
--entity2 TEXT [required]
--intersect-entity TEXT [required]
--entity1-menu-label TEXT
--entity1-menu-behavior [UseLabel|UseCollectionName|DoNotDisplay]
--entity1-menu-order INTEGER
--entity2-menu-label TEXT
--entity2-menu-behavior [UseLabel|UseCollectionName|DoNotDisplay]
--entity2-menu-order INTEGER
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--if-exists [error|skip] If the relationship already exists: error
(default) or skip (no-op success).
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm metadata create-mapping
Create a field mapping on a 1:N relationship, or --auto generate them.
Usage:
crm metadata create-mapping [OPTIONS] RELATIONSHIP
Options:
--from TEXT Source (parent) attribute logical name.
--to TEXT Target (child) attribute logical name.
--auto Bulk-generate likely mappings via AutoMapEntity
(replaces any existing maps for the pair).
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for a
deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata create-one-to-many
Create a 1:N relationship and its lookup attribute atomically.
Usage:
crm metadata create-one-to-many [OPTIONS]
Options:
--schema-name TEXT Relationship schema name with publisher
prefix. [required]
--referenced-entity TEXT "1" side logical name (e.g. account).
[required]
--referencing-entity TEXT "N" side logical name (e.g. new_project).
[required]
--lookup-schema TEXT Lookup attribute schema name on referencing
entity. [required]
--lookup-display TEXT UI label for the lookup attribute.
[required]
--lookup-required [None|Recommended|ApplicationRequired]
--lookup-description TEXT
--cascade-assign [NoCascade|Cascade|Active|UserOwned|RemoveLink|Restrict]
--cascade-delete [NoCascade|Cascade|Active|UserOwned|RemoveLink|Restrict]
--cascade-reparent [NoCascade|Cascade|Active|UserOwned|RemoveLink|Restrict]
--cascade-share [NoCascade|Cascade|Active|UserOwned|RemoveLink|Restrict]
--cascade-unshare [NoCascade|Cascade|Active|UserOwned|RemoveLink|Restrict]
--cascade-merge [NoCascade|Cascade|Active|UserOwned|RemoveLink|Restrict]
--menu-label TEXT
--menu-behavior [UseLabel|UseCollectionName|DoNotDisplay]
--menu-order INTEGER
--hierarchical Mark the 1:N as hierarchical
(IsHierarchical). Use with a self-
referencing relationship (referenced ==
referencing entity) to enable the
parent/child hierarchy and Above/Under
operators.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--if-exists [error|skip] If the relationship already exists: error
(default) or skip (no-op success).
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm metadata create-optionset
Create a global option set.
Usage:
crm metadata create-optionset [OPTIONS]
Options:
--name TEXT Fully prefixed option set name, e.g.
'new_priority'. Defaults to
<publisher_prefix>_<display> from the profile.
--display TEXT [required]
--description TEXT
--option TEXT Option as 'value:label' or ':label' (auto value).
Repeatable.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--if-exists [error|skip] If the option set already exists: error (default)
or skip (no-op success).
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata delete-attribute
Delete a custom attribute (column) from an entity.
Usage:
crm metadata delete-attribute [OPTIONS] ENTITY ATTRIBUTE
Options:
--yes Skip interactive confirmation.
--solution TEXT Optional. Forwarded as MSCRM.SolutionUniqueName; a
hard delete removes the component globally, so this
does not scope the delete.
--check-dependencies Preview blocking dependencies
(RetrieveDependenciesForDelete) in the result; pairs
with --dry-run.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata delete-entity
Permanently delete a custom entity (table) and ALL its rows.
Usage:
crm metadata delete-entity [OPTIONS] LOGICAL_NAME
Options:
--yes Skip interactive confirmation.
--solution TEXT Optional. Forwarded as MSCRM.SolutionUniqueName; a
hard delete removes the component globally, so this
does not scope the delete.
--check-dependencies Preview blocking dependencies
(RetrieveDependenciesForDelete) in the result; pairs
with --dry-run.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata delete-key
Delete an alternate key from an entity.
Usage:
crm metadata delete-key [OPTIONS] ENTITY KEY
Options:
--yes Skip interactive confirmation.
--solution TEXT Optional. Forwarded as MSCRM.SolutionUniqueName; a
hard delete removes the component globally, so this
does not scope the delete.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata delete-optionset
Delete a custom global option set.
Usage:
crm metadata delete-optionset [OPTIONS] NAME
Options:
--yes Skip interactive confirmation.
--solution TEXT Optional. Forwarded as MSCRM.SolutionUniqueName; a
hard delete removes the component globally, so this
does not scope the delete.
--check-dependencies Preview blocking dependencies
(RetrieveDependenciesForDelete) in the result; pairs
with --dry-run.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata delete-relationship
Delete a custom relationship (1:N or N:N) by schema name.
Usage:
crm metadata delete-relationship [OPTIONS] SCHEMA_NAME
Options:
--yes Skip interactive confirmation.
--solution TEXT Optional. Forwarded as MSCRM.SolutionUniqueName; a
hard delete removes the component globally, so this
does not scope the delete.
--check-dependencies Preview blocking dependencies
(RetrieveDependenciesForDelete) in the result; pairs
with --dry-run.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata dependencies
Show solution-component dependencies for a metadata target.
Read-only. --for delete returns components that block deletion (can_delete + blockers[]); --for dependents returns components that depend on the target; --for required returns the components the target itself depends on.
Usage:
crm metadata dependencies [OPTIONS] TARGET
Options:
--kind [entity|attribute|optionset|relationship]
Component kind of <target>. attribute uses
dotted 'entity.attribute'. [default:
entity]
--for [delete|dependents|required]
delete = blockers preventing delete
(RetrieveDependenciesForDelete); dependents
= components that depend on it
(RetrieveDependentComponents); required =
components it depends on
(RetrieveRequiredComponents). [default:
delete]
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm metadata describe
One-shot write-readiness brief for an entity.
Consolidates everything an agent needs to construct a valid create/update
payload in one read-only call: the entity set name, primary id/name, and each
writable attribute with its required level. Lookups carry bind_key
(<Nav>@odata.bind) plus targets[] (logical + set_name); picklist / state /
status attributes carry inline {value, label} options, and a picklist bound
to a global option set also carries its global_optionset_id GUID. Read-only.
Usage:
crm metadata describe [OPTIONS] LOGICAL_NAME
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata entities
List entity definitions.
Usage:
crm metadata entities [OPTIONS]
Options:
--custom-only
--managed-only
--filter TEXT
--top INTEGER
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata entity
Show full entity definition.
Usage:
crm metadata entity [OPTIONS] LOGICAL_NAME
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata export-spec
Export a live entity as a desired-state spec for crm apply -f.
Reads the entity's metadata over the Web API (pure GETs) and emits a spec.
Pass --solution to bake in the top-level solution: block that crm apply
requires; without it the document is valid but not directly appliable (apply
exits 2 until a solution: block is added). Pass --with-forms to project the
entity's seedable main form (custom fields and their placement, script
libraries, event handlers); a form that cannot round-trip a real apply is
reported in the skipped bucket (ADR 0019) — meta.skipped under the JSON
envelope, data.skipped in the -o summary. Without -o, the spec is emitted
under the standard JSON envelope (pipeable); with -o, the bare YAML spec is
written to FILE.
Usage:
crm metadata export-spec [OPTIONS] LOGICAL_NAME
Options:
--with-views Include the entity's public views in the spec.
--with-relationships Include the entity's custom 1:N relationships in the
spec.
--with-forms Include the entity's seedable main form (custom
fields, libraries, handlers) as a forms: block.
--solution TEXT Bake a top-level solution: block (unique_name) into
the spec so it applies directly (crm apply requires
one). Omit to emit a valid but non-appliable
document.
-o, --output FILE Write the bare spec as YAML to FILE (appliable with
crm apply -f when --solution is given).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata get-optionset
Retrieve a global option set, including its options.
Usage:
crm metadata get-optionset [OPTIONS] NAME
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata keys
List alternate keys defined on an entity.
Usage:
crm metadata keys [OPTIONS] LOGICAL_NAME
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata list-actions
List OData actions advertised by the service ($metadata).
Usage:
crm metadata list-actions [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata list-functions
List OData functions advertised by the service ($metadata).
Usage:
crm metadata list-functions [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata list-optionsets
List global option set definitions.
Usage:
crm metadata list-optionsets [OPTIONS]
Options:
--custom-only
--top INTEGER
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata picklist
Retrieve option set values for a picklist / state / status attribute.
Usage:
crm metadata picklist [OPTIONS] LOGICAL_NAME ATTRIBUTE
Options:
--no-global Skip GlobalOptionSet expansion.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata relationships
Show one-to-many, many-to-one, and many-to-many relationships.
Usage:
crm metadata relationships [OPTIONS] LOGICAL_NAME
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata state-relabel
Relabel a statecode state option (UpdateStateValue).
Usage:
crm metadata state-relabel [OPTIONS] ENTITY
Options:
--value INTEGER statecode value to relabel (e.g. 1 =
Inactive). [required]
--label TEXT New state label. [required]
--description TEXT
--merge-labels / --no-merge-labels
Preserve labels in untouched languages
(MergeLabels).
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm metadata status-add
Add a statuscode option tied to a state (InsertStatusValue).
Usage:
crm metadata status-add [OPTIONS] ENTITY
Options:
--state INTEGER statecode value the new status belongs to (e.g. 0
= Active). [required]
--label TEXT Status option label. [required]
--value INTEGER Explicit statuscode value. Omit to let the server
assign one.
--description TEXT
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata update-attribute
Update an attribute (column) definition (retrieve-merge-write).
Option-set option edits are NOT handled here — use update-optionset.
Usage:
crm metadata update-attribute [OPTIONS] ENTITY ATTRIBUTE
Options:
--display TEXT New UI label.
--description TEXT
--required [None|Recommended|ApplicationRequired]
--max-length INTEGER String/memo: max characters.
--precision INTEGER Decimal/double/money: precision (decimals).
--min FLOAT Numeric: minimum value.
--max FLOAT Numeric: maximum value.
--format TEXT String: Text|Email|Url|Phone|TextArea.
Datetime: DateOnly|DateAndTime.
--behavior [UserLocal|DateOnly|TimeZoneIndependent]
Datetime: change DateTimeBehavior. Only a
UserLocal column may change, once, to
DateOnly or TimeZoneIndependent (both
terminal). DateOnly auto-sets --format
DateOnly. Existing stored values are not
migrated (no Web API backfill).
--audit / --no-audit Enable/disable auditing (IsAuditEnabled).
Requires org-level auditing to be turned on
for audit records to be written; omit to
leave unchanged.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm metadata update-entity
Update an entity (table) definition (retrieve-merge-write).
Usage:
crm metadata update-entity [OPTIONS] LOGICAL_NAME
Options:
--display TEXT New singular UI label.
--display-collection TEXT New plural UI label.
--description TEXT New entity description.
--ownership [UserOwned|OrganizationOwned]
Note: Dataverse rejects ownership changes
post-create.
--has-activities / --no-has-activities
Enable/disable activities.
--has-notes / --no-has-notes Enable/disable notes.
--audit / --no-audit Enable/disable auditing (IsAuditEnabled).
Requires org-level auditing to be turned on
for audit records to be written; omit to
leave unchanged.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm metadata update-optionset
Granular update: insert/update/delete/reorder options.
Usage:
crm metadata update-optionset [OPTIONS] NAME
Options:
--insert-option TEXT Insert option 'value:label' or ':label'.
Repeatable.
--update-option TEXT Update an existing option's label, 'value:label'.
Repeatable.
--delete-option INTEGER Delete option by value. Repeatable.
--reorder INT-LIST Comma-separated full ordered list of values, e.g.
'1,2,7,4'.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm metadata update-relationship
Update a relationship definition (retrieve-merge-write).
Usage:
crm metadata update-relationship [OPTIONS] SCHEMA_NAME
Options:
--cascade-assign [NoCascade|Cascade|Active|UserOwned|RemoveLink|Restrict]
--cascade-delete [NoCascade|Cascade|Active|UserOwned|RemoveLink|Restrict]
--cascade-reparent [NoCascade|Cascade|Active|UserOwned|RemoveLink|Restrict]
--cascade-share [NoCascade|Cascade|Active|UserOwned|RemoveLink|Restrict]
--cascade-unshare [NoCascade|Cascade|Active|UserOwned|RemoveLink|Restrict]
--cascade-merge [NoCascade|Cascade|Active|UserOwned|RemoveLink|Restrict]
--menu-behavior [UseLabel|UseCollectionName|DoNotDisplay]
--menu-label TEXT
--menu-order INTEGER
--hierarchical / --no-hierarchical
Set IsHierarchical on a 1:N relationship
(rejected for N:N).
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm org
Org-level orientation (inventory, recon).
Usage:
crm org [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm org brief
One-call read-only org inventory: counts and key names, never full rows.
Consolidates what six fat list verbs (solution list, metadata entities,
webresource list, plugin list, workflow list, app list) would return
into one summarized brief, so an agent can orient without spending its context
budget. Sections: identity, solutions, publishers, schema, apps, automation,
components. Read-only — safe to run first.
Usage:
crm org brief [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm plugin
Register and manage plug-in assemblies, processing steps, and step images.
Usage:
crm plugin [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm plugin list-types
List registered plug-in types (optionally for one assembly).
Usage:
crm plugin list-types [OPTIONS]
Options:
--assembly TEXT Filter to plug-in types of this assembly (by name).
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm plugin register-assembly
Register a plug-in assembly from a .dll file (uploads its bytes).
Usage:
crm plugin register-assembly [OPTIONS] PATH
Options:
--name TEXT Assembly name; defaults to the file name
stem.
--version TEXT Assembly version; defaults to 1.0.0.0.
--culture TEXT Culture code; defaults to 'neutral'.
--public-key-token TEXT Public key token; defaults to 'null'
(unsigned).
--isolation-mode [sandbox|none]
Isolation mode (sandbox=2, none=1). Default:
sandbox.
--description TEXT Assembly description.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--update PATCH the content of an existing assembly
(resolved by name).
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm plugin register-image
Register a step entity image (sdkmessageprocessingstepimage).
Usage:
crm plugin register-image [OPTIONS]
Options:
--step TEXT Step GUID or exact step name
(sdkmessageprocessingstep). [required]
--type [pre|post|both] Image type (pre=0, post=1, both=2). Post-
images require a PostOperation-stage step.
[required]
--alias TEXT Entity alias — the key used to access the
image from PreEntityImages/PostEntityImages in
plug-in code. [required]
--attributes TEXT Comma-separated columns to include in the
image. Omit for all columns (hurts
performance; pass a list).
--name TEXT Image name; defaults to the alias.
--message-property-name TEXT Override the derived request property
(required for Send-message steps: FaxId,
EmailId or TemplateId).
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default
for a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the
command]
-h, --help Show this message and exit.
crm plugin register-step
Register a plug-in step (sdkmessageprocessingstep).
The step's event handler is a plug-in type (--plugin-type) or a service endpoint such as a webhook (--service-endpoint) — pass exactly one.
Usage:
crm plugin register-step [OPTIONS]
Options:
--message TEXT SDK message name (e.g. Create, Update,
Delete). [required]
--plugin-type TEXT Plug-in type name (the fully qualified
typename). Provide this or --service-
endpoint (exactly one event handler).
--service-endpoint TEXT Bind the step to a service endpoint (e.g. a
webhook from register-webhook) by name
instead of a plug-in type. Provide this or
--plugin-type (exactly one event handler).
--entity TEXT Primary entity logical name
(primaryobjecttypecode). Omit for a message-
level step (all entities).
--stage [prevalidation|preoperation|postoperation]
Pipeline stage (prevalidation=10,
preoperation=20, postoperation=40). Default:
postoperation.
--mode [sync|async] Execution mode (sync=0, async=1). Default:
sync. async requires --stage postoperation.
--rank INTEGER Execution order within the stage. Default:
1.
--filtering-attributes TEXT Comma-separated attributes that trigger the
step (Update).
--name TEXT Step name; defaults to a derived label. Pass
explicitly if the derived name would exceed
the platform's 256-char limit.
--configuration TEXT Unsecure configuration string.
--secure-configuration TEXT Secure configuration string, stored as a
separate related record linked from the
step. Write-only: the platform never returns
it and it is omitted from normal command
output. A --dry-run preview echoes the
request body, so it includes this value —
treat dry-run output as sensitive.
--async-auto-delete Auto-delete the system job on success (async
steps only).
--assembly TEXT Scope the plug-in type lookup to this
assembly (by name).
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm plugin register-type
Register a plug-in type (plugintypes) under an existing assembly.
A content-only register-assembly does not create plugintype rows, so name each type here before register-step --plugin-type can resolve it.
Usage:
crm plugin register-type [OPTIONS]
Options:
--assembly TEXT Existing assembly NAME the plug-in type belongs to.
[required]
--type TEXT Fully qualified plug-in type name (e.g.
Contoso.Plugins.PreCreateAccount). [required]
--friendly-name TEXT Display name (friendlyname); defaults to the type
name.
--name TEXT Designer label (plugintype name); defaults to the
type name. Workflow activities use this as the
classic-designer Add-Step label — a null name shows
an empty, unusable label.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for a
deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm plugin register-webhook
Register a webhook service endpoint (serviceendpoint, contract=8).
Usage:
crm plugin register-webhook [OPTIONS]
Options:
--name TEXT Unique webhook name (serviceendpoint.name).
[required]
--url TEXT Endpoint URL the platform POSTs the
execution context to (http on port 80 or
https on port 443). [required]
--auth [webhookkey|httpheader|httpquerystring]
Authentication scheme the endpoint expects
(authtype: webhookkey=4, httpheader=5,
httpquerystring=6). [required]
--auth-value TEXT Authentication value the endpoint expects
(the ?code= key for webhookkey, or the
header/query-string key-value pairs). Write-
only; the platform never returns it.
[required]
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm plugin set-step-state
Enable or disable a plug-in step (sdkmessageprocessingstep).
Usage:
crm plugin set-step-state [OPTIONS] STEP
Options:
--enable Enable the step. [required]
--disable Disable the step. [required]
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm plugin unregister-assembly
Unregister a plug-in assembly (NAME or GUID), deleting dependent steps first.
Usage:
crm plugin unregister-assembly [OPTIONS] ASSEMBLY
Options:
--yes Skip interactive confirmation.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm plugin unregister-image
Unregister a step entity image (sdkmessageprocessingstepimage, NAME or GUID).
Usage:
crm plugin unregister-image [OPTIONS] IMAGE
Options:
--yes Skip interactive confirmation.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm plugin unregister-step
Unregister a plug-in step (sdkmessageprocessingstep, NAME or GUID).
Usage:
crm plugin unregister-step [OPTIONS] STEP
Options:
--yes Skip interactive confirmation.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm profile
Create, switch, and manage connection profiles.
Usage:
crm profile [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm profile add
Create a profile, save its secret, test the connection, and activate it.
Run with no flags for an interactive wizard; pass flags for scripting/CI.
Usage:
crm profile add [OPTIONS]
Options:
--url TEXT Server URL, e.g.
https://crm.contoso.local/org or
https://org.crm.dynamics.com
--name TEXT Profile name (default: URL host label).
--auth-scheme [ntlm|kerberos|negotiate|oauth]
Override the auth scheme inferred from the
URL.
--username TEXT NTLM: username.
--domain TEXT NTLM: AD domain (blank for UPN).
--tenant-id TEXT OAuth: Azure AD tenant id.
--client-id TEXT OAuth: application (client) id.
--password TEXT NTLM password (or OAuth client secret).
Prompted if omitted on a TTY.
--client-secret TEXT OAuth client secret — alias for --password
(mutually exclusive).
--api-version TEXT Web API version. Omit to auto-negotiate
(v9.2 → v9.1 on on-prem).
--no-verify-ssl Skip SSL certificate verification.
--publisher-prefix TEXT Default schema-name prefix, e.g. 'new'.
--store-password-plaintext Force plaintext storage (skip the OS
keyring).
--read-only Mark the profile read-only: the backend
refuses org mutations. Clearing it later
requires an interactive terminal.
-y, --yes Skip the overwrite-confirm prompt.
--save-on-test-failure Save the profile even if the live connection
test fails, as long as it is structurally
valid (for CI / no-TTY runs; a malformed URL
still errors). Distinct from --yes.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm profile delete-password
Remove a stored secret (OS keyring AND plaintext).
Usage:
crm profile delete-password [OPTIONS]
Options:
--profile TEXT Profile whose secret to remove. [required]
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm profile edit
Change a profile's fields (not its secret — use set-password).
No NAME argument shows a picker.
Usage:
crm profile edit [OPTIONS] [NAME]
Options:
--url TEXT
--username TEXT
--domain TEXT
--tenant-id TEXT
--client-id TEXT
--api-version TEXT
--publisher-prefix TEXT
--verify-ssl / --no-verify-ssl Enable or skip SSL certificate verification
(parity with `profile add`'s --no-verify-
ssl).
--read-only / --no-read-only Set or clear the read-only guardrail.
Clearing (--no-read-only) requires an
interactive terminal to confirm.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm profile list
List saved profiles; the active one is marked.
Usage:
crm profile list [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm profile rename
Rename profile OLD to NEW, cascading its secret, active pointer, and cache.
No OLD shows a picker; a missing NEW is prompted for. All validation runs
before any mutation; a keyring failure warns (with a profile set-password
NEW recovery hint) rather than rolling back.
Usage:
crm profile rename [OPTIONS] [OLD] [NEW]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm profile rm
Delete a profile and its stored secret. No argument shows a picker.
Usage:
crm profile rm [OPTIONS] [NAME]
Options:
-y, --yes Skip confirmation.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm profile set-password
Store/replace the secret for an existing profile.
Usage:
crm profile set-password [OPTIONS]
Options:
--profile TEXT Profile to store the secret for. [required]
--password TEXT Secret to store (else prompted on a TTY).
--client-secret TEXT OAuth client secret — alias for --password
(mutually exclusive).
--store-password-plaintext Force plaintext storage.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the
command]
-h, --help Show this message and exit.
crm profile use
Switch the active profile. No argument shows an interactive picker.
Usage:
crm profile use [OPTIONS] [NAME]
Options:
--none Clear the active profile.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm query
Run OData and FetchXML queries.
Usage:
crm query [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm query count
Count rows for an entity via RetrieveTotalRecordCount (cached server-side).
ENTITY may be the entity-set name ("accounts") or the logical name ("account"), in any case — it is resolved to the logical name that RetrieveTotalRecordCount requires, so it matches the entity-set form used everywhere else in the CLI.
Usage:
crm query count [OPTIONS] ENTITY
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm query fetchxml
Run a FetchXML query.
ENTITY_SET is the OData entity-set name (e.g. "accounts"). When omitted,
the logical entity name is parsed from the
Examples:
crm --json query fetchxml --xml '
Usage:
crm query fetchxml [OPTIONS] [ENTITY_SET]
Options:
--xml TEXT Inline FetchXML string.
--file FILE Path to a FetchXML file.
--annotations / --no-annotations
Include formatted values.
--minimal JSON mode: drop every record key containing
'@' (OData annotations like @odata.etag,
*@FormattedValue, *@lookuplogicalname);
keeps business fields, _*_value lookup
GUIDs, and the primary id.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm query odata
OData v4 GET — entity set, bound-function path, or metadata path.
Accepted forms:
contacts bare entity set
RetrieveAppComponents(AppModuleId=
OData query options go through --select/--filter/etc., never inline. A '?' or '$' in the positional arg is rejected client-side before the request.
Usage:
crm query odata [OPTIONS] ENTITY_SET|BOUND_FUNC|METADATA_PATH
Options:
--select TEXT
--filter TEXT OData $filter expression.
--top INTEGER
--order-by TEXT OData $orderby expression.
--expand TEXT
--apply EXPR OData $apply aggregation expression, e.g.
'groupby((field),aggregate(measure with sum
as total))'. The result shape is whatever
the aggregation returns.
--count Also request $count.
--page-size INTEGER
--all Follow @odata.nextLink across all pages and
merge the results into one array (default: a
single server page).
--max-records INTEGER Cap the total rows returned, following
@odata.nextLink only as far as needed.
Implies page-following; bounds --all when
both given.
--annotations / --no-annotations
Include formatted values.
--track-changes Request a change-tracking delta link
(Prefer: odata.track-changes): returns the
current rows plus
meta.delta_token/meta.delta_link to resume
from later. Rejects --filter/--order-
by/--expand/--top/--all.
--delta-token TEXT Resume change tracking from a prior
meta.delta_token: returns only rows
created/updated/deleted since (deletes carry
reason="deleted").
--minimal JSON mode: drop every record key containing
'@' (OData annotations like @odata.etag,
*@FormattedValue, *@lookuplogicalname);
keeps business fields, _*_value lookup
GUIDs, and the primary id.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm query saved
Execute a system view (savedquery) by GUID. Use --json query odata savedqueries to
discover IDs.
Usage:
crm query saved [OPTIONS] ENTITY_SET SAVEDQUERY_ID
Options:
--annotations / --no-annotations
Include formatted values.
--page-size INTEGER
--minimal JSON mode: drop every record key containing
'@' (OData annotations like @odata.etag,
*@FormattedValue, *@lookuplogicalname);
keeps business fields, _*_value lookup
GUIDs, and the primary id.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm query user
Execute a saved view (userquery) by GUID.
Usage:
crm query user [OPTIONS] ENTITY_SET USERQUERY_ID
Options:
--annotations / --no-annotations
Include formatted values.
--page-size INTEGER
--minimal JSON mode: drop every record key containing
'@' (OData annotations like @odata.etag,
*@FormattedValue, *@lookuplogicalname);
keeps business fields, _*_value lookup
GUIDs, and the primary id.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm repl
Interactive REPL (default when no subcommand is provided).
Usage:
crm repl [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm report
Register and manage custom reports (SSRS RDL or link) headlessly.
create --body-file uploads an RDL; create --url registers a link report.
create --org makes a report organization-wide (otherwise it is personal).
set-category files a report under sales/service/marketing/administrative.
Usage:
crm report [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm report create
Create a report from an RDL file (--body-file) or a link (--url).
Usage:
crm report create [OPTIONS]
Options:
--name TEXT Report display name. [required]
--body-file FILE Path to an SSRS RDL file to upload (Reporting
Services report). Mutually exclusive with --url.
--url TEXT External report URL (link report). Mutually exclusive
with --body-file.
--filename TEXT Report file name. Defaults to the --body-file
basename.
--description TEXT Report description.
--org Make the report available to the organization
(ispersonal=false). Default: personal.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for a
deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm report delete
Delete a report by REPORT_ID.
Usage:
crm report delete [OPTIONS] REPORT_ID
Options:
--yes Skip interactive confirmation.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm report get
Get a single report by REPORT_ID (its RDL body / link URL included).
Usage:
crm report get [OPTIONS] REPORT_ID
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm report list
List all reports (summary columns only — use report get for the body).
Usage:
crm report list [OPTIONS]
Options:
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm report set-category
File REPORT_ID under a report area (creates a reportcategory record).
Usage:
crm report set-category [OPTIONS] REPORT_ID
Options:
--category [administrative|marketing|sales|service]
Report area: sales, service, marketing, or
administrative. [required]
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm ribbon
Read and edit entity command-bar (ribbon) buttons.
Usage:
crm ribbon [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
crm ribbon add-button
Add a JavaScript command-bar button to an entity (no manual XML editing).
Optionally set the button's icon at creation: --modern-image (SVG web resource,
Unified Interface) and/or --image16 / --image32 (raster web resources, classic
UI). Each is written as a $webresource: reference (which adds a solution
dependency on the icon) and validated for existence + type before the import.
With --diff-file the edit is applied offline to a local RibbonDiffXml file (no
backend calls); the icon web-resource existence check is skipped and deferred to
ribbon apply's import-time validation.
Usage:
crm ribbon add-button [OPTIONS] ENTITY
Options:
--label TEXT Button label text. [required]
--location [form|homegrid|subgrid]
Where the button appears. [required]
--group TEXT Override the target ribbon group id.
--webresource TEXT JS web resource name, e.g.
'cwx_/scripts/x.js'. [required]
--function TEXT JavaScript function name, e.g. 'ns.fn'.
[required]
--param [PrimaryControl|SelectedControlSelectedItemIds]
CrmParameter passed to the function.
[required]
--sequence INTEGER [default: 50]
--id TEXT Override the generated id base
({entity}.{location}.{label}).
--modern-image TEXT Web resource (SVG) for the Unified Interface
ModernImage icon.
--image16 TEXT Web resource (16×16 raster: PNG/JPG/GIF/ICO)
for the classic Image16by16 icon.
--image32 TEXT Web resource (32×32 raster: PNG/JPG/GIF/ICO)
for the classic Image32by32 icon.
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--diff-file FILE Offline: apply this edit to a local
RibbonDiffXml file (from `ribbon export
--solution`), no backend calls. Compose N
edits, then `ribbon apply`. Mutually
exclusive with --solution/--publish.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm ribbon add-custom-rule
Add a custom (JavaScript) enable rule to a command and reference it.
Defines an EnableRule whose CustomRule calls the given web-resource function,
then references it on the command. The web resource must already exist. The
CommandDefinition Id is never touched. With --diff-file the edit is applied
offline to a local RibbonDiffXml file (no backend calls); the web-resource
existence check is skipped and deferred to ribbon apply's import.
Usage:
crm ribbon add-custom-rule [OPTIONS] ENTITY
Options:
--command-id TEXT The CommandDefinition Id to attach the rule to.
[required]
--webresource TEXT JS web resource holding the rule function, e.g.
'cwx_/scripts/x.js'. [required]
--function TEXT JavaScript function returning bool/Promise, e.g.
'ns.canRun'. [required]
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--diff-file FILE Offline: apply this edit to a local RibbonDiffXml
file (from `ribbon export --solution`), no backend
calls. Compose N edits, then `ribbon apply`.
Mutually exclusive with --solution/--publish.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm ribbon apply
Import a local RibbonDiffXml working-copy file, full-replacing ENTITY's ribbon.
The terminal step of the offline flow: ribbon export ENTITY --solution S
--output f.xml, compose N --diff-file edits against f.xml, then ribbon apply
ENTITY --solution S --from f.xml — one export → import → publish. ENTITY's
Usage:
crm ribbon apply [OPTIONS] ENTITY
Options:
--from FILE The local RibbonDiffXml working-copy file to
import (from `ribbon export --solution`, edited
with `--diff-file`). [required]
--publish / --no-publish Run PublishAllXml after the import. Default:
publish (the working-copy flow's single terminal
publish); pass --no-publish to stage the import
without publishing. [default: publish]
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm ribbon export
Export a ribbon as readable XML.
Pass ENTITY for one table's composed ribbon, or --application for the app-wide
ribbon (the commands not bound to a specific table). With --solution, export
ENTITY's editable RibbonDiffXml fragment from that solution — the working-copy
the offline --diff-file verbs edit and ribbon apply imports. Read-only.
Usage:
crm ribbon export [OPTIONS] [ENTITY]
Options:
-a, --application Export the application-wide ribbon
(RetrieveApplicationRibbon) instead of a single
entity's. Omit ENTITY when set.
--solution TEXT Export ENTITY's editable RibbonDiffXml fragment from
this solution (the importable working-copy the
`--diff-file` verbs edit and `ribbon apply` imports),
instead of the composed read-only ribbon. Requires
ENTITY.
-o, --output FILE Write the ribbon XML to this file instead of stdout.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm ribbon hide-button
Hide an out-of-box command-bar button (reversibly by default).
Validates --target-id against the live composed ribbon so a typo errors instead
of silently doing nothing. Never touches the button's classid/Command/
TemplateAlias. display-rule overrides the button's command with two
always-false platform DisplayRules; hide-action writes a HideCustomAction,
which is irreversible without a new solution version and is gated behind --yes.
Usage:
crm ribbon hide-button [OPTIONS] ENTITY
Options:
--target-id TEXT The OOB button (control) Id to hide, as it
appears in `crm ribbon export ENTITY`.
[required]
--method [display-rule|hide-action]
display-rule: reversible (override the
command with two always-false DisplayRules).
hide-action: HideCustomAction, a one-way
trapdoor removable only by a new solution
version. [default: display-rule]
--yes Skip interactive confirmation.
--publish / --no-publish Run PublishAllXml after the change. Default:
stage (no publish); run `solution publish-
all` when your set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution
Default for a deliberate Default-Solution-
only write.
--json Emit machine-readable JSON output. [global;
also valid before the command]
--fields KEY[,KEY...] Project the data payload down to these
comma-separated top-level keys. [global;
also valid before the command]
--jq PROGRAM Run a jq program over the curated data
payload; the result replaces data. Implies
--json. [global; also valid before the
command]
--profile TEXT Connection profile name. [global; also
valid before the command]
--dry-run Preview writes without issuing them; reads
run normally. [global; also valid before
the command]
-h, --help Show this message and exit.
crm ribbon list
List the custom buttons declared in a solution's RibbonDiffXml.
Usage:
crm ribbon list [OPTIONS] ENTITY
Options:
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for a
deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid before
the command]
--jq PROGRAM Run a jq program over the curated data payload; the
result replaces data. Implies --json. [global; also
valid before the command]
--profile TEXT Connection profile name. [global; also valid before
the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm ribbon remove
Remove a custom button (CustomAction + its CommandDefinition).
With --diff-file the button is removed from a local RibbonDiffXml file offline
(no backend calls); ribbon apply then imports the result.
Usage:
crm ribbon remove [OPTIONS] ENTITY
Options:
--button-id TEXT The CustomAction Id to remove (see `crm ribbon
list`). [required]
--yes Skip interactive confirmation.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--diff-file FILE Offline: apply this edit to a local RibbonDiffXml
file (from `ribbon export --solution`), no backend
calls. Compose N edits, then `ribbon apply`.
Mutually exclusive with --solution/--publish.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm ribbon set-icon
Set a custom command-bar button's icon on an existing button.
Writes only the icon attributes — ModernImage (--modern-image, an SVG web resource for the Unified Interface) and/or Image16by16 / Image32by32 (--image16 / --image32, raster web resources for the classic UI). The button's Command, LabelText, TemplateAlias, Sequence and Id are protected. Pass at least one icon flag. Each reference is validated (exists + slot type) before the solution round-trip, and written as a $webresource: directive so the solution gains a dependency on the icon web resource.
Usage:
crm ribbon set-icon [OPTIONS] ENTITY
Options:
--button-id TEXT The custom button's CustomAction Id (see `crm
ribbon list`). [required]
--modern-image TEXT Web resource (SVG) for the Unified Interface
ModernImage icon.
--image16 TEXT Web resource (16×16 raster: PNG/JPG/GIF/ICO) for
the classic Image16by16 icon.
--image32 TEXT Web resource (32×32 raster: PNG/JPG/GIF/ICO) for
the classic Image32by32 icon.
--publish / --no-publish Run PublishAllXml after the change. Default: stage
(no publish); run `solution publish-all` when your
set is done.
--solution TEXT Target unmanaged solution uniquename
(MSCRM.SolutionUniqueName). Required for
customization writes; pass --solution Default for
a deliberate Default-Solution-only write.
--json Emit machine-readable JSON output. [global; also
valid before the command]
--fields KEY[,KEY...] Project the data payload down to these comma-
separated top-level keys. [global; also valid
before the command]
--jq PROGRAM Run a jq program over the curated data payload;
the result replaces data. Implies --json.
[global; also valid before the command]
--profile TEXT Connection profile name. [global; also valid
before the command]
--dry-run Preview writes without issuing them; reads run
normally. [global; also valid before the command]
-h, --help Show this message and exit.
crm ribbon set-label
Set a custom command-bar button's label and tooltips.
Touches only LabelText / ToolTipTitle / ToolTipDescription — the button's
Command, TemplateAlias, Sequence and Id are protected. Pass at least one of
--label / --tooltip-title / --tooltip-description. With --lcid the text is
localized through a CASE-SENSITIVE $LocLabels:<id> directive (the text lands
in a