Skip to content

uc-apx page

Show a specific page’s properties and its components (regions, items, buttons, processes, …). Accepts the page number, alias, or name. By default each component is listed as a summary with a descendant count; pass —detail for the full recursive property tree of every component.

uc-apx page <id> [flags]
FlagTypeDefaultDescription
--detailInclude the full recursive property tree of every component instead of a summary
FlagTypeDefaultDescription
--app-dirstring.Path to the APEX application directory
--json-prettyOutput in pretty-printed JSON (human-readable) instead of minified JSON
--toonOutput in TOON format (human-readable, token-efficient) instead of JSON
Terminal window
# Look up a page by its numeric ID
uc-apx page 1
# Look up a page by its alias (case-sensitive)
uc-apx page HOME
# Look up a page by its display name (case-insensitive)
uc-apx page "home"
# Output as pretty-printed JSON for agent processing
uc-apx --json-pretty page 1

Running against examples/brookstrut:

Terminal window
uc-apx --app-dir examples/brookstrut page 1
id: "1"
name: Home
alias: HOME
title: &APP_NAME.
file: pages/p00001-home.apx
properties:
advanced.reloadOnSubmit: always
alias: HOME
appearance.pageTemplate: /standard
appearance.templateOptions: #DEFAULT#
help.helpText: No help is available for this page.
name: Home
navigation.warnOnUnsavedChanges: "false"
security.formAutoComplete: "false"
security.pageAccessProtection: argumentsMustHaveChecksum
title: &APP_NAME.
regions[2]{kind,id,name,type,file,line}:
region,application-actions,Application Actions,list,pages/p00001-home.apx,23
region,home,Home,staticContent,pages/p00001-home.apx,56
pageItems[0]:
buttons[1]{kind,id,name,type,file,line}:
button,about,"","",pages/p00001-home.apx,75
processes[0]:
computations[1]{kind,id,name,type,file,line}:
computation,last-view,"","",pages/p00001-home.apx,101
validations[0]:
branches[0]:
dynamicActions[0]:
JSON output
{
"id": "1",
"name": "Home",
"alias": "HOME",
"title": "&APP_NAME.",
"file": "pages/p00001-home.apx",
"properties": {
"advanced.reloadOnSubmit": "always",
"alias": "HOME",
"appearance.pageTemplate": "/standard",
"appearance.templateOptions": "#DEFAULT#",
"help.helpText": "No help is available for this page.",
"name": "Home",
"navigation.warnOnUnsavedChanges": "false",
"security.formAutoComplete": "false",
"security.pageAccessProtection": "argumentsMustHaveChecksum",
"title": "&APP_NAME."
},
"regions": [
{
"kind": "region",
"id": "application-actions",
"name": "Application Actions",
"type": "list",
"file": "pages/p00001-home.apx",
"line": 23
},
{
"kind": "region",
"id": "home",
"name": "Home",
"type": "staticContent",
"file": "pages/p00001-home.apx",
"line": 56
}
],
"buttons": [
{
"kind": "button",
"id": "about",
"file": "pages/p00001-home.apx",
"line": 75
}
],
"computations": [
{
"kind": "computation",
"id": "last-view",
"file": "pages/p00001-home.apx",
"line": 101
}
]
}