uip tm prompts

Syntax and options for `uip tm prompts`, which lists, reads, and adds prompts in the Test Manager project prompt library used by Autopilot features.

uip tm prompts manages the prompt library of a Test Manager project. A prompt holds reusable guidelines that steer Autopilot test generation, requirement evaluation, test import, and obsolete-test detection. Its mode of use sets where Test Manager offers it.

Mode of use	Offered for
GenerateTestsFromRequirement	Generating test cases from a requirement
EvaluateRequirementQuality	Evaluating requirement quality
GenerateTestsFromSapTransaction	Generating test cases from an SAP transaction
ImportTestCases	Importing test cases
FindObsoleteTests	Finding obsolete test cases
AutonomousExploration	Autonomous exploration

The library holds built-in sample prompts (PromptType Internal) and the prompts users add (PromptType UserDefined). Prompt names are not unique within a project.

The CLI requirement AI verbs, such as requirements generate-testcases, take ad hoc guidance through --instructions and have no option to select a library prompt. project export --include prompts adds the user-defined prompts to a .tmh package.

Synopsis

uip tm prompts list (--project-key <key> | --project-id <id>) [--modes-of-use <mode...>] [--filter <text>] [--created-by <user-id>] [--updated-by <user-id>] [--sort-by <expression>] [--limit <number>] [--offset <number>]
uip tm prompts get (--project-key <key> | --project-id <id>) (--name <name> | --prompt-id <id>)
uip tm prompts create (--project-key <key> | --project-id <id>) --name <name> --mode-of-use <mode> (--guidelines <text> | --guidelines-file <path>) [--description <text>]

All verbs honor the global options and the standard exit codes.

uip tm prompts list

List the prompts in a project's prompt library, built-in and user-defined, one page at a time.

Arguments

None.

Options

Flag	Description
--project-key <key>	Test Manager project key. One of --project-key or --project-id is required. Ignored if --project-id is also given.
--project-id <id>	Test Manager project ID. Use instead of --project-key; wins if both are given.
--modes-of-use <mode...>	Filter by one or more modes of use, space-separated. Accepts the values in the mode of use table.
--filter <text>	Match prompts whose name or description starts with this text.
--created-by <user-id>	Filter by the ID of the user who created the prompt.
--updated-by <user-id>	Filter by the ID of the user who last updated the prompt.
--sort-by <expression>	Sort by name, modeOfUse, description, created, or updated, followed by asc or desc, for example 'name asc'. Defaults to created asc.
--limit <number>	Number of results per page. Defaults to 50.
--offset <number>	Number of results to skip. Defaults to 0.

Example

uip tm prompts list \
  --project-key DEMO \
  --modes-of-use GenerateTestsFromRequirement \
  --sort-by 'created desc'

Data shape

{
  "Code": "PromptsList",
  "Data": [
    {
      "Id": "6f1c2a9e-0000-0000-0000-000000000001",
      "Name": "Banking edge cases",
      "Guidelines": "Cover negative amounts, zero, the daily transfer limit and non-EUR currencies.",
      "Description": "Bias generation toward boundary amounts and currencies",
      "ModeOfUse": "GenerateTestsFromRequirement",
      "PromptType": "UserDefined",
      "ProjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "Created": "2026-10-01T09:15:00.000Z",
      "CreatedBy": "c3d4e5f6-0000-0000-0000-000000000003",
      "Updated": "2026-10-02T14:40:00.000Z",
      "UpdatedBy": "c3d4e5f6-0000-0000-0000-000000000003"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "Total": 1, "HasMore": false }
}

uip tm prompts get

Get one prompt from the prompt library by its exact name or by its ID. Pass one of --name or --prompt-id.

--name matches the whole name, including case. When no prompt matches, the command returns not_found and suggests names that differ only in case. When several prompts share the name, the command refuses it; pass --prompt-id instead. When more than 4,000 prompts have a name or description that starts with the --name value, the name cannot be resolved; pass --prompt-id.

Arguments

None.

Options

Flag	Description
--project-key <key>	Test Manager project key. One of --project-key or --project-id is required. Ignored if --project-id is also given.
--project-id <id>	Test Manager project ID. Use instead of --project-key; wins if both are given.
--name <name>	Prompt name, matched exactly. Mutually exclusive with --prompt-id.
--prompt-id <id>	Prompt ID, the Id that prompts list returns. Mutually exclusive with --name.

Examples

# Get a prompt by name
uip tm prompts get --project-key DEMO --name "Banking edge cases"

# Get a prompt by ID
uip tm prompts get --project-key DEMO --prompt-id 6f1c2a9e-0000-0000-0000-000000000001

Data shape

{
  "Code": "PromptGet",
  "Data": {
    "Id": "6f1c2a9e-0000-0000-0000-000000000001",
    "Name": "Banking edge cases",
    "Guidelines": "Cover negative amounts, zero, the daily transfer limit and non-EUR currencies.",
    "Description": "Bias generation toward boundary amounts and currencies",
    "ModeOfUse": "GenerateTestsFromRequirement",
    "PromptType": "UserDefined",
    "ProjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Created": "2026-10-01T09:15:00.000Z",
    "CreatedBy": "c3d4e5f6-0000-0000-0000-000000000003",
    "Updated": "2026-10-02T14:40:00.000Z",
    "UpdatedBy": "c3d4e5f6-0000-0000-0000-000000000003"
  }
}

uip tm prompts create

Add a user-defined prompt to the project's prompt library. The CLI checks the name, guidelines, and description lengths before it sends the request.

Arguments

None.

Options

Flag	Description
--project-key <key>	Test Manager project key. One of --project-key or --project-id is required. Ignored if --project-id is also given.
--project-id <id>	Test Manager project ID. Use instead of --project-key; wins if both are given.
--name <name>	Required. Prompt name, up to 255 characters. Leading and trailing spaces are removed.
--mode-of-use <mode>	Required. Where Test Manager offers the prompt. Accepts the values in the mode of use table.
--guidelines <text>	Guidelines text the AI follows when the prompt is selected, up to 4096 characters. One of --guidelines or --guidelines-file is required.
--guidelines-file <path>	Path to a UTF-8 text file that holds the guidelines. Mutually exclusive with --guidelines.
--description <text>	Prompt description, up to 8000 characters.

Examples

# Create a prompt with inline guidelines
uip tm prompts create \
  --project-key DEMO \
  --name "Banking edge cases" \
  --mode-of-use GenerateTestsFromRequirement \
  --guidelines "Cover negative amounts, zero, the daily transfer limit and non-EUR currencies."

# Create a prompt whose guidelines are in a text file
uip tm prompts create \
  --project-key DEMO \
  --name "Banking edge cases" \
  --mode-of-use GenerateTestsFromRequirement \
  --guidelines-file ./guidelines.md \
  --description "Bias generation toward boundary amounts and currencies"

Data shape

{
  "Code": "PromptCreate",
  "Data": {
    "Id": "6f1c2a9e-0000-0000-0000-000000000001",
    "Name": "Banking edge cases",
    "Guidelines": "Cover negative amounts, zero, the daily transfer limit and non-EUR currencies.",
    "Description": "Bias generation toward boundary amounts and currencies",
    "ModeOfUse": "GenerateTestsFromRequirement",
    "PromptType": "UserDefined",
    "ProjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Created": "2026-10-01T09:15:00.000Z",
    "CreatedBy": "c3d4e5f6-0000-0000-0000-000000000003",
    "Updated": "2026-10-01T09:15:00.000Z",
    "UpdatedBy": "c3d4e5f6-0000-0000-0000-000000000003"
  }
}

Related

• requirements generate-testcases: generate test cases from a requirement with Autopilot.
• project export: --include prompts packages the user-defined prompts.

See also

• Test Manager overview