# summary

Resolve profiling definition keys to their full configuration — see what each definition targets, which method it uses, and what state it is in.

# description

Definition keys like PD-0001 appear throughout the Cuneiform workflow — in profiling logs, summary reports, error messages, and colleague questions. When a key surfaces in any context, the next step is resolving what that definition targets, what method it uses, and what state it is in. This command retrieves profiling definitions by key and presents them in a nine-column table: key, name, target object, profiling type, category, time category, segment category, profiling status, and last profiled date.

Multiple keys are fetched in parallel, so looking up 5 definitions is as fast as looking up 1. The output includes an Org Identity header, a definitions table with section header and count, JSON flag guidance with a copy-paste command, and contextual next steps. Keys that do not match any definition produce warnings (not errors), supporting partial success when retrieving batches.

**When to use vs related commands:**

- `definition list` — "Show me all definitions" (browse, filter, overview of many)
- `definition get` — "Show me PD-0001" (targeted lookup of specific definitions by key)
- `definition export` — "Back up definitions for migration" (portable CSV export, not inspection)

**File export:** Use `--output-dir` to save each definition as a separate JSON file for audit artifacts, project documentation, or version control.

Read-only. Does not create, modify, or execute definitions. The access gate validates Cuneiform installation and permissions before queries execute.

NATURAL LANGUAGE → FLAG MAPPING:

"get definition PD-0001" → --keys PD-0001
"get details for Account Standard" → --keys Account_Standard
"show me multiple definitions" → --keys PD-0001 --keys PD-0002
"export definitions to files" → --keys PD-0001 --output-dir ./definitions
"show definition as JSON" → --keys PD-0001 --json

COMMAND SEQUENCE: `definition list` (find keys) → `definition get` (inspect by key) → `profile` (execute profiling) or `definition update` (refine configuration)

# flags.target-org.summary

Retrieve definitions from this Salesforce org. Specify the org alias or username when you have multiple authenticated orgs.

# flags.keys.summary

One or more definition keys to retrieve (e.g., `--keys PD-0001`). Repeat the flag for multiple keys: `--keys PD-0001 --keys PD-0002`. Keys are fetched in parallel for efficient batch lookup.

# flags.output-dir.summary

Save each definition as a separate JSON file in this directory (e.g., `PD-0001.json`). The directory is created if it does not exist. Use this for audit artifacts, project documentation, or version control snapshots.

# flags.file-names.summary

Override default key-based file names with custom names (must match `--keys` count). Use when you want descriptive names for exported files (e.g., `--file-names account-standard.json`).

# flags.format.summary

Display format: `table` (nine-column summary, default) or `json` (complete definition record with all fields).

# examples

- Resolve a definition key from a profiling log or error message:

  <%= config.bin %> <%= command.id %> --target-org myOrg --keys PD-0001

- Verify multiple definitions before executing profiling (fetched in parallel):

  <%= config.bin %> <%= command.id %> --target-org myOrg --keys PD-0001 --keys PD-0002 --keys PD-0003

- Export definitions as JSON files for audit artifacts or project documentation:

  <%= config.bin %> <%= command.id %> --target-org myOrg --keys PD-0001 --keys PD-0002 --output-dir ./definitions

- Export with descriptive file names for engagement deliverables:

  <%= config.bin %> <%= command.id %> --target-org myOrg --keys PD-0001 --output-dir ./definitions --file-names account-standard.json

- View the complete definition record in JSON format:

  <%= config.bin %> <%= command.id %> --target-org myOrg --keys PD-0001 --json

# errors.keyCountMismatch

The number of file names (%d) must match the number of keys (%d).

# errors.definitionNotFound

Definition not found: %s

# errors.exportFailed

Failed to export definition %s: %s

# output.headerTitle

Definition Get

# output.identity.header

Org Identity

# output.identity.orgName

Org Name

# output.identity.orgId

Org ID

# output.identity.instanceUrl

Instance URL

# output.identity.orgType

Org Type

# output.identity.edition

Edition

# output.identity.namespace

Namespace

# output.identity.username

Username

# output.definitions.header

Definitions

# output.jsonGuidance

For a full export of definition data, use the JSON flag:

# output.nextSteps.header

Next steps:

# output.nextSteps.profile

Execute profiling for this definition

# output.nextSteps.profileMultiple

Execute profiling for these definitions

# output.nextSteps.definitionList

View all definitions in this org

# warnings.title

Warnings