Skip to content

xg license status

Display the current license status for this machine. The command contacts the AKMS licensing backend, resolves the active API key, and prints the tier, expiration date, and any subscription claims associated with the license.

xg license status [OPTIONS]

xg license status queries the local API key store and the AKMS (API Key Management Service) backend to determine whether the machine holds a valid, active license.

When a license is found the command prints:

  • StatusLicense Active (green) or No Active License Found (red).
  • Tier — the highest active subscription tier: Free, Basic, Premium, Pro, or Enterprise.
  • Expires — the UTC expiration timestamp of the license (yyyy-MM-dd HH:mm:ss K format).
  • Expiration warning — an amber warning if the license expires within 30 days; a red warning if it expires within 7 days.
  • Subscription claims — one entry per active subscription parsed from the JWT entitlement token (program name, tier, expiry). Shown in verbose mode only (see --verbose).

When no valid license is found the command prints the Unlicensed / Free tier state and shows the activation hint.

StateConditionTier shown
ActiveAPI key present, AKMS validation succeeds, expiration date in the futureResolved from subscription claims (Basic, Premium, Pro, Enterprise)
UnlicensedNo API key stored, or AKMS validation failsFree
Expiring soonActive license expires within 30 daysSame as Active, with amber warning
Expiring criticallyActive license expires within 7 daysSame as Active, with red warning

Note: The license status is cached in-process for up to 2 minutes. If you just activated a license, run xg license status again after a few seconds to pick up the refreshed state.

OptionShortTypeDefaultDescription
--verbose-vflagfalsePrint extended output including subscription claim details (program name, tier, expiry) parsed from the JWT entitlement token.
CodeMeaning
0License information retrieved successfully (regardless of license validity).
1An error occurred while contacting AKMS or reading the local API key store.
$ xg license status
XrmGhost License Status
Retrieving license information...
License Active
Tier: Pro
Expires: 2027-01-15 00:00:00 +00:00

Check license status with verbose subscription claims

Section titled “Check license status with verbose subscription claims”
$ xg license status --verbose
XrmGhost License Status
Retrieving license information...
License Active
Tier: Pro
Expires: 2027-01-15 00:00:00 +00:00
Subscription Claims:
XrmGhost Pro (Active) - Expires: 2027-01-15
$ xg license status
XrmGhost License Status
Retrieving license information...
No Active License Found
Status: Unlicensed
Tier: Free
Description: No active license was found on this machine.
To activate a license, use: xg license activate <bootstrap-key>
$ xg license status
XrmGhost License Status
Retrieving license information...
License Active
Tier: Enterprise
Expires: 2026-05-25 00:00:00 +00:00
⚠️ License expires in 18 days
Consider renewing your license before it expires.