Skip to content
uc-apx

Human Quickstart

This guide walks through the most common read commands using a real exported APEX application. If you haven’t installed uc-apx yet, see Installation.

Get an Exported App

Section titled “Get an Exported App”

Export your APEX application using APEX Builder’s APEXlang export option (APEX 26.1+). You’ll get a directory that looks like:

my-app/
├── .apex/apexlang.json
├── application.apx
├── pages/
│   ├── p00001-home.apx
│   ├── p00010-employees.apx
│   └── ...
└── shared-components/
    ├── lovs.apx
    └── ...

All examples below assume you cd into the app directory first, so --app-dir defaults to ..

Overview

Section titled “Overview”

Get a bird’s-eye view of the entire application:

Terminal window
uc-apx overview
name: Brookstrut Sample App
fileCount: 75
componentCounts:
  button: 93
  region: 87
  pageItem: 124
  page: 22
  ...

List Pages

Section titled “List Pages”
Terminal window
uc-apx pages
pages:
  - id: "1"
    name: Home
    alias: HOME
    title: Home
    file: pages/p00001-home.apx
  - id: "2"
    name: Departments
    ...

Inspect a Page

Section titled “Inspect a Page”
Terminal window
uc-apx page 2

Returns the full component tree for page 2: regions, items, buttons, branches, processes, validations, and dynamic actions.

Use --json for machine-readable output:

Terminal window
uc-apx page 2 --json

Hierarchical Tree

Section titled “Hierarchical Tree”

tree gives a compact outline — useful for quickly seeing the region/item nesting:

Terminal window
uc-apx tree 2
page 2 "Departments"
  region "Departments" [interactive-report]
    action "Create" [button]
    action "Edit" [button]
  region "Breadcrumb" [breadcrumb]
Section titled “Search”

Full-text search across all names, SQL queries, and PL/SQL code:

Terminal window
uc-apx search "DEPTNO"

Cross-References

Section titled “Cross-References”

Find everything that references a component by ID or name:

Terminal window
uc-apx refs EMP_DEPTNO

LOV Lookup

Section titled “LOV Lookup”

Inspect a List of Values and see where it’s used:

Terminal window
uc-apx lov EMP_DEPTNO

Schema

Section titled “Schema”

Extract the tables and columns referenced in all SQL queries across the app:

Terminal window
uc-apx shape

Next Steps

Section titled “Next Steps”
  • Commands reference — flags and examples for every command
  • Scaffolding — use create page, create region, etc. to add new components
  • Validate — validate --official checks your app against Oracle’s MMD schema