Commands

Commands are grouped by topic.

ai-agents

ai-agents close-conversation — Close an AI agent conversation
ai-agents dislike — Dislike a message in an AI agent conversation
ai-agents get-conversation — Get details of a single AI agent conversation
ai-agents like — Like a message in an AI agent conversation
ai-agents list — Fetch all AI agents enabled for external access
ai-agents list-conversations — List conversations for an AI agent
ai-agents send-message — Send a message in an AI agent conversation
ai-agents start-conversation — Start a new AI agent conversation

assignments

assignments get — Get a Pega assignment by ID
assignments get-action — Get the action/view details for a specific action on an assignment
assignments get-next — Get the next assignment from the worklist
assignments navigate-back — Navigate back to the previous step in a multi-step assignment
assignments navigate-to-step — Navigate to a specific step in a multi-step assignment
assignments perform — Perform an assignment action (auto-fetches eTag)
assignments recalculate — Recalculate calculated fields and when conditions for an assignment action
assignments refresh-action — Refresh a field after a value change
assignments save — Save a draft of an in-progress assignment

assistants

assistants close-conversation — Close a GenAI assistant conversation
assistants get-conversation — Get details of a single GenAI assistant conversation
assistants list-conversations — List conversations for a GenAI assistant
assistants send-message — Send a message in a GenAI assistant conversation
assistants start-conversation — Start a new GenAI assistant conversation

attachments

attachments add — Add attachments to a Pega case (atomic batch POST)
attachments delete — Delete a Pega attachment by ID
attachments get — Get a Pega attachment by ID
attachments list — List attachments on a Pega case
attachments patch — Update attachment metadata (name and/or category)
attachments upload — Upload a file as a Pega attachment (multipart POST)

auth

auth diagnose — Run diagnostic checks against Pega configuration
auth login — Acquire a fresh OAuth token and cache it
auth ping — Check Pega API V2 reachability
auth refresh-b2s — Refresh a B2S authentication token

auth-profiles

auth-profiles get — Get an authentication profile
auth-profiles revoke-tokens — Revoke user-specific tokens for an authentication profile

case-types

case-types get — Get full details of a specific case type (filters the case-types list response)
case-types get-action — Get the creation action/view for a case type
case-types list — List all available case types in the application
case-types list-bulk-actions — List bulk actions for a case type (Launchpad only)

cases

cases bulk-actions — List bulk actions available across a set of cases
cases bulk-perform — Perform an action across multiple cases in a single API call
cases calc-fields — Compute calculated fields for a case view
cases create — Create a new Pega case (V2)
cases delete — Delete a Pega case (V2)
cases discard-updates — Release the case lock (discard pending updates)
cases get — Get a Pega case by ID
cases get-action — Get the view/form for a specific action on a case
cases get-view — Get a named view for a case
cases list-ancestors — List all ancestor cases in the case hierarchy
cases list-attachment-categories — List configured attachment categories on a case
cases list-descendants — List all descendant cases in the case hierarchy
cases list-stages — List stages for a case
cases perform-action — Perform a case-level action
cases recalculate — Recalculate calculated fields and when conditions for a case action
cases refresh-action — Refresh a case action view (re-render form)
cases refresh-view — Refresh a named case view
cases stage-go — Move the case to a specific named stage
cases stage-next — Advance the case to the next stage
cases start-process — Start an optional or stage process on a case

data

data count — Get count of records in a data view by POSTing to /data_views/{dataViewId}/count
data create — Create a new data record
data delete — Delete a data record
data get — Get a data view by ID
data get-action — Get a specific action for a data record
data get-metadata — Get metadata for a data view by ID
data list-actions — List available actions for a data record
data list-objects — List all data objects available in the application
data list-pages — List data pages available in the application
data patch — Patch a data record (PATCH with eTag)
data perform-action — Perform an action on a data record
data query — Query a data view by POSTing to /data_views/
data query-metadata — Get metadata for a data view by POSTing to /data_views/{dataViewId}/metadata
data query-view — Query a specific view of a data view by POSTing to /data_views/{dataViewId}/views/
data update — Update a data record (PUT with eTag)

documents

documents delete — Remove a document linked to a case
documents get — Get metadata for a specific document

followers

followers add — Add a follower to a case
followers delete — Remove a follower from a case
followers list — List all followers of a case

participants

participants add — Add a participant to a case in a given role
participants delete — Remove a participant from a case
participants get — Get a specific participant by participant ID
participants get-role — Get details of a specific participant role on a case
participants list — List all participants on a case
participants list-roles — List participant roles configured on a case
participants update — Update a participant's details

recents

recents list — List the operator's recent items
recents update — Add or update a recent item

related add — Add a related case link
related delete — Remove a related case link
related list — List all related cases

skill

skill install — Install the pega-dx agent skill into the right location for your AI tool. Note: --profile is ignored — this command makes no API calls.
skill list — List available skill targets and resolved install paths
skill show — Print the SKILL.md body or a named reference to stdout

social delete-message — Delete a Pulse message
social get-feed — Get a Pulse feed list
social get-message — Get a Pulse message by ID
social get-message-type — Get the create-form view metadata for a Pulse message type
social like-message — Add a like to a Pulse message
social list-likes — List likes on a Pulse message
social list-mention-types — List Pulse mention types
social list-mentions — List mentions for a search string and type
social list-messages — List Pulse messages for a context
social list-suggested-tags — List suggested + recent tags for a Pulse context
social post-message — Post a new Pulse message
social search-tags — Search tags by string
social unlike-message — Remove a like from a Pulse message
social update-message — Edit a Pulse message

static-content

static-content component — Get a custom component as raw JavaScript
static-content file — Get a static file (binary). --output is required.
static-content profile-image — Get a user profile image

ui-lists

ui-lists create-personalization — Create a personalization on a UI list
ui-lists delete-personalization — Delete a personalization on a UI list
ui-lists list-personalizations — List personalizations for a UI list
ui-lists move — Move a record within a UI list
ui-lists update-personalization — Update a personalization on a UI list

user-settings

user-settings get — Get operator user settings
user-settings patch — Patch operator user settings

Commands ​

Commands