Discovery Commands

Namespace-scoped connection overrides are available for remote execution on ldev portal and ldev resource:

ldev portal --liferay-url https://portal.example.com inventory sites --json
ldev --repo-root ../.. portal inventory sites --json

Use ldev --repo-root <path> ... when the command should resolve local portal URL, OAuth2 credentials, and docker/.env from another checkout root, such as the main repo while your shell stays inside a worktree.

ldev context

Resolve repo, runtime, and Liferay context as one snapshot.

ldev context
ldev context --json
ldev context --describe --json

context is the offline project snapshot: it returns repo root, worktree, resolved Liferay product/version, resource paths, runtime config, platform tool availability, and which command areas are supported. It does not contact Docker or the portal.

ldev portal check

Check OAuth and basic API reachability.

ldev portal check
ldev portal check --json

Real text-mode example:

HEALTH_OK
baseUrl=http://localhost:8081
checkedPath=/o/headless-admin-user/v1.0/my-user-account
status=200
tokenType=Bearer
expiresIn=600

ldev portal auth token

Fetch an OAuth2 access token for scripting.

ldev portal auth token
ldev portal auth token --raw

--raw prints only the access token in text mode, so it can be captured for shell variables.

ldev portal inventory preflight

Check whether the portal's admin/JSONWS API surfaces are reachable with the current credentials. Used to fail fast before running longer inventory or resource flows.

ldev portal inventory preflight
ldev portal inventory preflight --force-refresh

The result is cached; --force-refresh bypasses the cache. You can also attach preflight as a pre-hook to any inventory or resource subcommand with --preflight:

ldev portal inventory --preflight sites --json
ldev resource --preflight export-structures --all-sites

ldev portal inventory sites

List accessible sites, or switch into folder inventory mode when a site is selected.

ldev portal inventory sites
ldev portal inventory sites --json
ldev portal inventory sites --with-content --sort-by content
ldev portal inventory sites --site /estudis --with-structures --limit 20
ldev portal inventory sites --group-id 2710030 --with-structures

Options:

• --page-size <n> — JSONWS page size (default 200)
• --with-content — include Journal content volume metrics
• --sort-by site|name|content — sort order (default site)
• --limit <n> — max sites to return in content mode
• --site <friendlyUrl> — inspect one site (switches to folder inventory)
• --group-id <id> — inspect one site by numeric group id
• --with-structures — include per-folder structure breakdowns when scoped
• --exclude-site <site> — exclude a site from content metrics (repeatable)

ldev portal inventory pages

List pages in a site hierarchy.

ldev portal inventory pages --site /global
ldev portal inventory pages --site /guest --private-layout
ldev portal inventory pages --site /global --max-depth 4 --json

ldev portal inventory page

Inspect a specific page or display page.

ldev portal inventory page --url /home --json
ldev portal inventory page --url /web/guest/home --json
ldev portal inventory page --site /global --friendly-url /home --json
ldev portal inventory page --url /home --verbose

--verbose includes fragment/widget element names, CSS classes, and custom CSS.

ldev portal inventory structures

List journal structures for a site or for every site.

ldev portal inventory structures --site /global --json
ldev portal inventory structures --site /global --with-templates --json
ldev portal inventory structures --all-sites --with-templates --json

Prefer --with-templates as the first discovery step for structure/template incidents: it returns structures enriched with their associated templates in one call.

In text mode, --with-templates renders a detailed site -> structure -> template view. In --all-sites text mode, sites with no structures are omitted to keep discovery output focused.

ldev portal inventory templates

List web content templates for a site.

ldev portal inventory templates --site /global --json

ldev portal inventory where-used

Reverse lookup for portal resources. Use it when you already know the fragment, widget, Structure, Template, or ADT key and need to answer the practical question: which Pages use it?

ldev portal inventory where-used --type fragment --key card-hero --site /guest
ldev portal inventory where-used --type widget --key com_liferay_journal_content_web_portlet_JournalContentPortlet --site /guest
ldev portal inventory where-used --type structure --key BASIC --site /facultat-farmacia-alimentacio
ldev portal inventory where-used --type adt --key UB_ADT_STUDIES_SEARCH --site /global
ldev portal inventory where-used --type template --key NEWS_TEMPLATE --site /global --include-private --json

Use where-used after discovery has identified the resource you care about. It scans candidate Pages, extracts normalized Page evidence, and returns only the Pages whose evidence matches the requested resource.

Prefer --site whenever you already know the owning Site. Without it, where-used scans every accessible Site and can take much longer.

Options:

• --type <fragment|widget|structure|template|adt> — resource type to trace
• --key <value> — resource key to look up; repeatable
• --site <friendlyUrl> — limit the scan to one Site instead of all accessible Sites
• --widget-type <value> — required when an ADT key is ambiguous across widget types
• --class-name <value> — optional ADT disambiguator for the owning class
• --include-private — include private layouts in addition to public Pages
• --max-depth <n> — recursion depth for page hierarchy scans
• --concurrency <n> — concurrent page inspections
• --page-size <n> — page size for candidate collection APIs

This is especially useful before changing a shared portal resource: it gives you read-before-write impact analysis without opening the UI or guessing where a resource might be referenced.

ldev portal api discover

Resolve the OpenAPI spec of a Liferay Headless app and list its endpoints, schemas, filter/sort parameters, pagination support, and (optionally) a working curl/JS example. This is the operational bridge between "I need this entity" and a working request.

ldev portal api discover
ldev portal api discover headless-delivery
ldev portal api discover headless-delivery --path structured-contents
ldev portal api discover headless-delivery --schema StructuredContent
ldev portal api discover headless-delivery --example /sites/{siteId}/structured-contents
ldev portal api discover headless-admin-user --json

Without an app name, it lists every Headless app registered at /o/openapi. With an app name, it resolves the spec (first from the /o/openapi catalog, then by the /o/<app>/v1.0/openapi.json pattern), then reports:

• Every endpoint's path, method, and which of page/pageSize, filter, sort, and search query parameters it accepts
• Available schemas, with --schema <name> to inspect one schema's properties in full
• Fixed pagination/auth/filter/sort conventions for the whole Headless surface
• With --example <path>, a ready-to-run curl command and fetch() snippet for the matching endpoint, authenticated with a Bearer token

Options:

• --path <substring> — only show endpoints whose path contains this substring
• --method <verb> — only show endpoints with this HTTP method (also selects the --example method)
• --schema <name> — show full property details for one schema
• --example <path> — emit a curl + fetch example for the endpoint matching this path

Pair this with ldev portal auth token --raw to get a token for the emitted examples.

ldev portal audit

Minimal runtime audit of accessible site metadata and API reachability. Defaults to JSON.

ldev portal audit
ldev portal audit --site /global --page-size 200

ldev portal config get|set

Inspect and update local Liferay config files (portal properties and OSGi PIDs).

ldev portal config get com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConfiguration
ldev portal config get companyDefaultLanguageId --source effective
ldev portal config set com.liferay.portal.search.... --key networkHostAddresses --value '["host:9200"]'

--source defaults to source for set and effective for get.

ldev oauth install

Create or refresh the OAuth app used by ldev and optionally persist credentials locally.

ldev oauth install --write-env
ldev oauth install --write-env --scope-profile default
ldev oauth install --company-id 20097 --user-id 20130 --write-env

Use this once after the portal is ready. The local credentials are written to .liferay-cli.local.yml. See OAuth for the full model, including scope profiles and manual remote setup.

ldev oauth admin-unblock

Clear the initial password-reset state for the selected admin user, so OAuth flows that create/update the OAuth app can succeed.

ldev oauth admin-unblock
ldev oauth admin-unblock --company-id 20097 --user-id 20130