Skip to content

CLI Reference

Browse the available CLI native reference and its declared callable forms.

CLI Reference shows CLI forms.

Public acquisition: Available. Coordinate: @merulan/cli. Version: 0.1.0. Live operation: Preview. Production calls and readback are not yet qualified. Evidence: 2026-09-17.

Reference pages

CLI pages list member syntax.

MemberNative syntax
app.bootstrapmerulan app bootstrap
app.resources.resolvemerulan app resources-resolve --resources <json>
dashboards.createmerulan dashboards create --name <value> [--description <value>] [--system <value>]
dashboards.getmerulan dashboards get <dashboardId>
dataPipelines.runs.getmerulan dataPipelines runs-get <runId>
dataPipelines.runs.startmerulan dataPipelines runs-start [--pipeline-id <value>] [--pipeline-ref <json>] [--version-id <value>] [--source <json>] [--s3key <value>] [--retry-from-run-id <value>] [--idempotency-key <value>]
entities.createmerulan entities create --entity-kind <value> [--values <json>] [--idempotency-key <value>]
entities.getmerulan entities get --entity-kind <value> --record-id <value>
entities.querymerulan entities query --entity-kind <value> [--cursor <value>] [--limit <value>] [--search <value>] [--where <json>] [--sort <json>] [--fields <json>] [--group-field <value>] [--renderer <value>] [--expected-descriptor-version <value>]
entities.updatemerulan entities update --entity-kind <value> --entity-id <value> --patch <json> [--interface-name <value>] [--reason <value>] [--expected-object-version <value>] [--expected-policy-version <value>] [--idempotency-key <value>] [--dry-run <value>]
grouping.declaremerulan grouping declare --axis <value> [--label <value>] [--parent-axis <value>] [--values <json>]
grouping.listmerulan grouping list
groups.getMembersmerulan groups get-members <groupId>
joinRequests.listPendingmerulan join-requests list-pending
laboratory.experiments.createmerulan laboratory experiments create --experiment-ref <value> --title <value> --objective-version-ref <value> --subjects <json> --case-set-ref <value> --method <json> [--inputs <json>] --evaluation <json>
laboratory.experiments.readmerulan laboratory experiments read <experimentRef>
laboratory.experiments.startmerulan laboratory experiments start <experimentRef> --revision <value>
laboratory.sandboxes.createmerulan laboratory sandboxes create --name <value> --purpose <value>
laboratory.sandboxes.readmerulan laboratory sandboxes read <sandboxRef>
lineage.getForRunmerulan lineage get-for-run <runId> [--direction <value>] [--depth <value>] [--limit <value>] [--cursor <value>]
lists.addMembersmerulan lists addMembers <listId> --member-refs <json>
lists.createmerulan lists create --name <value> [--description <value>] --target <json> [--member-refs <json>] [--is-ranked <value>]
lists.getmerulan lists get <listId>
lists.listmerulan lists list [--include-archived <value>] [--workflow-instance-id <value>]
lists.removeMembersmerulan lists removeMembers <listId> --member-refs <json>
lists.updatemerulan lists update <listId> [--name <value>] [--description <value>] [--ranking-config <json>]
notifications.listmerulan notifications list [--limit <value>] [--unread-only <value>]
notifications.markReadmerulan notifications markRead <notificationId>
ontology.declareKindmerulan ontology kinds declare
ontology.declareRelationshipmerulan ontology relationships declare --definition <json> [--expected-version <value>] [--acknowledge-breaking-change <value>]
ontology.getKindmerulan ontology kinds get <partyKind>
ontology.getRelationshipDefinitionmerulan ontology relationships get <id>
ontology.listKindsmerulan ontology kinds list [--cursor <value>] [--limit <value>]
ontology.listRelationshipDefinitionsmerulan ontology relationships list [--cursor <value>] [--limit <value>]
ontology.migrations.approvemerulan ontology migrations approve <planId>
ontology.migrations.getmerulan ontology migrations get <planId>
ontology.migrations.planmerulan ontology migrations plan --kind <value> --fields <json> [--implements <json>]
ontology.migrations.previewmerulan ontology migrations preview --kind <value> --fields <json> [--implements <json>]
predictiveModels.objective.createmerulan predictiveModels objective-create --objective-key <value> --name <value> --task-type <value> --contract <json>
predictiveModels.objective.readmerulan predictiveModels objective-read <id>
predictiveModels.release.approvemerulan predictiveModels release-approve <releaseId> [--note <value>]
predictiveModels.release.listmerulan predictiveModels release-list [--objective-id <value>] [--environment <value>] [--status <value>] [--limit <value>]
predictiveModels.release.requestmerulan predictiveModels release-request --objective-id <value> --environment <value> --version-id <value> [--evidence <json>]
predictiveModels.runs.readmerulan predictiveModels runs-read <runId>
predictiveModels.runs.startmerulan predictiveModels runs-start --objective-id <value> --data-definition-id <value> --project-key <value> --project-version <value> --executor-kind <value> --resource-class <value> --max-spend-usd-micros <value> --deadline-at <value> [--executor-config-ref <value>] [--request-key <value>]
predictiveModels.versions.readmerulan predictiveModels versions-read <versionId>
processFrameworks.inspectmerulan process-frameworks inspect --authority <json> --framework-key <value> --release-key <value>
processFrameworks.publishmerulan process-frameworks publish --authority <json> --release-id <value>
processFrameworks.validatemerulan process-frameworks validate --authority <json> --release-id <value>
products.configuremerulan products configure --installation-id <value> --settings <json> --expected-revision <value> [--change-reason <value>]
products.inspectInstalledmerulan products inspectInstalled --installation-id <value>
products.installmerulan products install --product-key <value> --product-version <value> [--namespace <value>] --idempotency-key <value> --expected-plan <json> [--bindings <json>] [--product-config <json>] [--reference-inputs <json>] [--profile <json>] [--binding-answers <json>] [--role-satisfactions <json>] [--accepted-recommendations <json>]
products.previewmerulan products preview --product-key <value> --product-version <value> [--namespace <value>] [--expected-plan <json>] [--product-config <json>] [--profile <json>] [--binding-answers <json>] [--role-satisfactions <json>] [--accepted-recommendations <json>]
products.retiremerulan products retire --installation-id <value> --expected-install-updated-at <value>
products.upgradeApplymerulan products upgradeApply --installation-id <value> --target-version <value> [--expected-current-plan <json>] [--expected-target-plan <json>] --expected-install-updated-at <value> --expected-manifest-digest <value> --expected-configuration-revision <value> [--bindings <json>] [--product-config <json>] --plan-id <value> --idempotency-key <value>
products.upgradePreviewmerulan products upgradePreview --installation-id <value> --target-version <value> [--expected-current-plan <json>] [--expected-target-plan <json>] --expected-install-updated-at <value> --expected-manifest-digest <value> --expected-configuration-revision <value> [--bindings <json>] [--product-config <json>]
quality.configuration.applymerulan quality configuration apply --plan <json> --expected-plan-digest <value> --idempotency-key <value>
quality.configuration.deactivatemerulan quality configuration deactivate --kind <value> --resource-id <value> --expected-revision <value> --idempotency-key <value>
quality.configuration.getmerulan quality configuration get <kind> <resourceId> [--revision <value>]
quality.configuration.listmerulan quality configuration list [--kind <value>]
quality.configuration.planmerulan quality configuration plan --draft <json> --expected-revision <value>
quality.constraintGroups.assessmerulan quality constraint-groups assess <groupId> [--revision <value>] [--maximum-run-age-seconds <value>]
quality.constraintRuns.getmerulan quality constraint-runs get <runId>
quality.constraintRuns.readDetailmerulan quality constraint-runs read-detail <runId>
quality.constraintRuns.requestmerulan quality constraint-runs request --constraint <json> --cause <value> --cause-key <value> [--window <json>]
quality.operations.querymerulan quality operations query --collection <value> [--cursor <value>] [--limit <value>] [--saved-view <value>] [--filters <json>] [--stale-after-seconds <value>] [--worker-healthy-within-seconds <value>]
recertify.listmerulan recertify list [--campaign-id <value>] [--status <value>] [--limit <value>]
recertify.reviewmerulan recertify review <itemId> --decision <value> [--reason <value>]
recertify.startmerulan recertify start --kind <value> --cadence-days <value> --lapse-policy <value>
savedQueries.createmerulan saved-queries create --key <value> --title <value> [--description <value>] --kind <value> --target <json> [--where <json>] [--composite <value>] [--sort <json>] [--default-limit <value>] [--tags <json>]
savedQueries.getmerulan saved-queries get <savedQueryId>
savedQueries.listmerulan saved-queries list [--target <json>]
savedQueries.previewmerulan saved-queries preview --definition <json> [--result-mode <value>] [--size <value>]
savedQueries.runmerulan saved-queries run <savedQueryId> [--result-mode <value>] [--size <value>] [--target-entity-id <value>]
savedQueries.updatemerulan saved-queries update <savedQueryId> --expected-revision <value> --definition <json> [--acknowledge-breaking-change <value>]
settings.integrationsAdmin.listSourceInstallationsmerulan sources installations list
simulations.runs.readmerulan simulations runs-read <runId>
simulations.runs.startmerulan simulations runs-start --input-snapshot-id <value> --release-alias <value> [--scenario-revision-id <value>] [--seed <value>] [--trials <value>] [--horizon-days <value>] [--variants <value>] [--parameter-overrides <json>] [--request-key <value>]
tasks.createmerulan tasks create --title <value> [--workflow-instance-id <value>] [--target-ref <json>] [--due-at <value>] [--expires-at <value>] [--responsible-principal <json>] [--description <value>] --task-type <value> [--priority <value>] [--entity-type <value>] [--entity-id <value>] [--email-draft-id <value>] [--suggested-action <json>] [--routing-rule-id <value>] [--source-type <value>] [--source-entity <value>] [--source-id <value>] [--context <json>] [--status <value>]
tasks.getmerulan tasks get <taskId>
tasks.schedulemerulan tasks schedule <taskId> [--due-at <value>] [--correlation-id <value>]
tasks.transitionmerulan tasks transition <taskId> --to-state-key <value> [--expected-state-key <value>] [--reason <value>]
workflows.decideApprovalmerulan workflows decideApproval <instanceId> <blockId> [--review-revision <value>] --decision <json> [--approved-outputs <json>] [--duplicate-recipient-action <value>] [--exclude-member-ids <json>] [--double-contact-action <value>] [--exclude-account-ids <json>]
workflows.getBlockStatemerulan workflows getBlockState <instanceId> <blockId>
workspace.design.adoption.importmerulan workspace design-adoption-import --installation-id <value>
workspace.design.authority.readmerulan workspace design-authority-read
workspace.design.authority.transfermerulan workspace design-authority-transfer --authority <json> --design-change <json> --import-attestations <json>
writeback.getRequestmerulan writeback getRequest <requestId>
writeback.repairmerulan writeback repair --ledger-id <value> --action <value> [--reason <value>] [--correlation-id <value>]
writeback.statusmerulan writeback status --correlation-id <value>