{
  "id": "temporal",
  "name": "Temporal CLI",
  "homepage": "https://docs.temporal.io/cli",
  "description": "Command-line interface for running Temporal Server and interacting with Workflows, Activities, Namespaces, and other parts of Temporal.",
  "executables": [
    "temporal"
  ],
  "dotfiles": {
    "paths": [
      "[configHome]/temporalio/temporal.toml",
      "[appData]/temporalio/temporal.toml",
      "%APPDATA%/temporalio/temporal.toml"
    ],
    "secret": [],
    "secret_paths": [
      {
        "file": [
          "[configHome]/temporalio/temporal.toml",
          "[appData]/temporalio/temporal.toml",
          "%APPDATA%/temporalio/temporal.toml"
        ],
        "format": "toml",
        "match": {
          "key_path": [
            "profile.*.api_key"
          ]
        }
      }
    ]
  },
  "commands": {
    "format": 1,
    "label": "Temporal CLI",
    "description": "Common Workflow jobs: list, start and describe Workflow Executions. Global connection flags (address, namespace, profile) and the other subcommands are left out.",
    "quality": "ai-draft",
    "parser": {
      "end_of_options": "--",
      "interleave": "permute",
      "long_equals": true,
      "short_attached": true,
      "short_bundles": false
    },
    "subcommand": [
      {
        "path": [
          "workflow",
          "list"
        ],
        "label": "List workflows",
        "description": "List Workflow Executions, optionally filtered by a List Filter query.",
        "source": [
          {
            "id": "ref",
            "kind": "manual",
            "url": "https://docs.temporal.io/cli/workflow",
            "revision": "2026-10-27",
            "evidence": "temporal workflow list --query YourQuery\n\n--archived No bool Limit output to archived Workflow Executions. (Experimental)\n--limit No int Maximum number of Workflow Executions to display.\n--page-size No int Maximum number of Workflow Executions to fetch at a time from the server.\n--query, -q No string Content for an SQL-like QUERY List Filter.\n"
          }
        ],
        "field": [
          {
            "id": "query",
            "label": "List filter query",
            "description": "SQL-like filter, e.g. WorkflowType = 'MyWorkflow'.",
            "type": "string",
            "option": [
              "--query",
              "-q"
            ],
            "sources": [
              "ref"
            ]
          },
          {
            "id": "limit",
            "label": "Max results",
            "type": "integer",
            "option": [
              "--limit"
            ],
            "sources": [
              "ref"
            ]
          },
          {
            "id": "page_size",
            "label": "Page size",
            "type": "integer",
            "option": [
              "--page-size"
            ],
            "sources": [
              "ref"
            ]
          },
          {
            "id": "archived",
            "label": "Archived only",
            "type": "boolean",
            "option": [
              "--archived"
            ],
            "sources": [
              "ref"
            ]
          }
        ],
        "task": [
          {
            "id": "filtered",
            "label": "Filtered list",
            "fields": [
              "query",
              "limit"
            ],
            "required": [
              "query"
            ]
          }
        ],
        "group": [
          {
            "id": "basic",
            "label": "Basic",
            "fields": [
              "query",
              "limit"
            ]
          },
          {
            "id": "advanced",
            "label": "Advanced",
            "fields": [
              "page_size",
              "archived"
            ]
          }
        ]
      },
      {
        "path": [
          "workflow",
          "start"
        ],
        "label": "Start a workflow",
        "description": "Start a new Workflow Execution. Headers, memo, search attributes, fairness and priority options are left out.",
        "source": [
          {
            "id": "ref",
            "kind": "manual",
            "url": "https://docs.temporal.io/cli/workflow",
            "revision": "2026-10-27",
            "evidence": "temporal workflow start --workflow-id YourWorkflowId --type YourWorkflow --task-queue YourTaskQueue --input '{\"some-key\": \"some-value\"}'\n\n--cron No string Cron schedule for the Workflow.\n--execution-timeout No duration Fail a WorkflowExecution if it lasts longer than DURATION. This time-out includes retries and ContinueAsNew tasks.\n--id-conflict-policy No string-enum Accepted values: Fail, UseExisting, TerminateExisting.\n--id-reuse-policy No string-enum Accepted values: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning.\n--input, -i No string[] Input value. Use JSON content or set --input-meta to override.\n--run-timeout No duration Fail a Workflow Run if it lasts longer than DURATION.\n--task-queue, -t Yes string Workflow Task queue.\n--type Yes string Workflow Type name.\n--workflow-id, -w No string Workflow ID. If not supplied, the Service generates a unique ID.\n"
          }
        ],
        "field": [
          {
            "id": "type",
            "label": "Workflow type",
            "type": "string",
            "option": [
              "--type"
            ],
            "sources": [
              "ref"
            ]
          },
          {
            "id": "task_queue",
            "label": "Task queue",
            "type": "string",
            "option": [
              "--task-queue",
              "-t"
            ],
            "sources": [
              "ref"
            ]
          },
          {
            "id": "workflow_id",
            "label": "Workflow ID",
            "description": "If empty, the Service generates a unique ID.",
            "type": "string",
            "option": [
              "--workflow-id",
              "-w"
            ],
            "sources": [
              "ref"
            ]
          },
          {
            "id": "input",
            "label": "Input",
            "description": "JSON value. Repeat for multiple arguments.",
            "type": "string",
            "option": [
              "--input",
              "-i"
            ],
            "multiple": true,
            "sources": [
              "ref"
            ]
          },
          {
            "id": "id_conflict_policy",
            "label": "ID conflict policy",
            "type": "enum",
            "option": [
              "--id-conflict-policy"
            ],
            "choices": [
              {
                "value": "Fail",
                "label": "Fail"
              },
              {
                "value": "UseExisting",
                "label": "Use existing"
              },
              {
                "value": "TerminateExisting",
                "label": "Terminate existing"
              }
            ],
            "sources": [
              "ref"
            ]
          },
          {
            "id": "id_reuse_policy",
            "label": "ID reuse policy",
            "type": "enum",
            "option": [
              "--id-reuse-policy"
            ],
            "choices": [
              {
                "value": "AllowDuplicate",
                "label": "Allow duplicate"
              },
              {
                "value": "AllowDuplicateFailedOnly",
                "label": "Allow duplicate if failed"
              },
              {
                "value": "RejectDuplicate",
                "label": "Reject duplicate"
              },
              {
                "value": "TerminateIfRunning",
                "label": "Terminate if running"
              }
            ],
            "sources": [
              "ref"
            ]
          },
          {
            "id": "cron",
            "label": "Cron schedule",
            "type": "string",
            "option": [
              "--cron"
            ],
            "sources": [
              "ref"
            ]
          },
          {
            "id": "execution_timeout",
            "label": "Execution timeout",
            "description": "Duration, e.g. 30m.",
            "type": "string",
            "option": [
              "--execution-timeout"
            ],
            "sources": [
              "ref"
            ]
          },
          {
            "id": "run_timeout",
            "label": "Run timeout",
            "description": "Duration, e.g. 10m.",
            "type": "string",
            "option": [
              "--run-timeout"
            ],
            "sources": [
              "ref"
            ]
          }
        ],
        "task": [
          {
            "id": "start",
            "label": "Start with input",
            "fields": [
              "type",
              "task_queue",
              "workflow_id",
              "input"
            ],
            "required": [
              "type",
              "task_queue"
            ]
          }
        ],
        "group": [
          {
            "id": "basic",
            "label": "Basic",
            "fields": [
              "type",
              "task_queue",
              "workflow_id",
              "input"
            ]
          },
          {
            "id": "advanced",
            "label": "Advanced",
            "fields": [
              "id_conflict_policy",
              "id_reuse_policy",
              "cron",
              "execution_timeout",
              "run_timeout"
            ]
          }
        ]
      },
      {
        "path": [
          "workflow",
          "describe"
        ],
        "label": "Describe a workflow",
        "description": "Show the properties of a Workflow Execution.",
        "source": [
          {
            "id": "ref",
            "kind": "manual",
            "url": "https://docs.temporal.io/cli/workflow",
            "revision": "2026-10-27",
            "evidence": "temporal workflow describe --workflow-id YourWorkflowId\n\n--raw No bool Print properties without changing their format.\n--reset-points No bool Show auto-reset points only.\n--run-id, -r No string Run ID.\n--workflow-id, -w Yes string Workflow ID.\n"
          }
        ],
        "field": [
          {
            "id": "workflow_id",
            "label": "Workflow ID",
            "type": "string",
            "option": [
              "--workflow-id",
              "-w"
            ],
            "sources": [
              "ref"
            ]
          },
          {
            "id": "run_id",
            "label": "Run ID",
            "type": "string",
            "option": [
              "--run-id",
              "-r"
            ],
            "sources": [
              "ref"
            ]
          },
          {
            "id": "raw",
            "label": "Raw output",
            "type": "boolean",
            "option": [
              "--raw"
            ],
            "sources": [
              "ref"
            ]
          }
        ],
        "task": [
          {
            "id": "describe",
            "label": "Describe",
            "fields": [
              "workflow_id",
              "run_id"
            ],
            "required": [
              "workflow_id"
            ]
          }
        ],
        "group": [
          {
            "id": "basic",
            "label": "Basic",
            "fields": [
              "workflow_id",
              "run_id",
              "raw"
            ]
          }
        ]
      }
    ]
  }
}