xg license status
xg license status
Section titled “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.
Synopsis
Section titled “Synopsis”xg license status [OPTIONS]Description
Section titled “Description”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:
- Status —
License Active(green),License in Grace Period(yellow) orNo Active License Found(red). - Tier — the highest active subscription tier:
StandardorPro. - Expires — the UTC expiration timestamp of the license (
yyyy-MM-dd HH:mm:ss Kformat). - 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 subscription parsed from the JWT entitlement token (program name, tier, status, expiry). The
Subscription Claimsblock is always printed;--verboseaddsProgram ID:to each claim and shows expired subscriptions when active subscriptions also exist.
When no valid license is found the command prints Status: Unlicensed with the Standard Unlicensed tier and shows the activation hint.
License in Grace Period
Section titled “License in Grace Period”When AKMS reports the license in the Grace status, the license is still valid: the subscription has expired, but the tier is kept for a limited time. Instead of License Active and Expires:, the command prints:
- Status —
License in Grace Period(yellow). - Tier — the tier retained by the server, for example
Pro. Pro features remain available for the whole Grace period. - Grace ends — the end of the Grace period in the same
yyyy-MM-dd HH:mm:ss Kformat, followed by the days remaining, for exampleGrace ends: 2026-11-05 00:00:00 +00:00 (14 days left). - Renewal link —
Renew your subscription: https://admin.xrmghost.tech/subscriptions. The same address is shown regardless of the AKMS environment the CLI targets.
Subscription claims describe active subscriptions, so during Grace the Subscription Claims block may contain no active subscription. When no claims are present, the block prints Your subscription has expired; the tier is kept until the grace period ends. instead of No subscription claims found. This does not affect the license: the tier retained by the server and the Pro gates stay valid until Grace ends.
When the Grace period ends without a renewal, the license is no longer valid and the command reports the existing Unlicensed result (No Active License Found, Status: Unlicensed).
License states
Section titled “License states”| State | Condition | Tier shown |
|---|---|---|
| Active | API key present, AKMS validation succeeds, expiration date in the future | Resolved from subscription claims (Standard, Pro) |
| Grace | API key present, AKMS validation succeeds and reports the Grace status with a Grace end date | Tier retained by the server (Standard, Pro), with Grace ends: and days remaining; Pro access is kept until Grace ends |
| Unlicensed | No API key stored, or AKMS validation fails | Standard Unlicensed |
| Expiring soon | Active license expires within 30 days | Same as Active, with amber warning |
| Expiring critically | Active license expires within 7 days | Same 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 statusagain after a few seconds to pick up the refreshed state.
Options
Section titled “Options”| Option | Short | Type | Default | Description |
|---|---|---|---|---|
--verbose | -v | flag | false | Print extended subscription claim details. The Subscription Claims block is always printed; --verbose adds Program ID: to each claim and shows expired subscriptions when active subscriptions also exist. |
Exit codes
Section titled “Exit codes”| Code | Meaning |
|---|---|
0 | License information retrieved successfully (regardless of license validity). |
1 | An error occurred while contacting AKMS or reading the local API key store. |
Examples
Section titled “Examples”Check license status (standard output)
Section titled “Check license status (standard output)”$ xg license status
XrmGhost License Status
Retrieving license information...License Active Tier: Pro Expires: 2027-01-15 00:00:00 +00:00
Subscription ClaimsActive Subscriptions (1) ✓ XrmGhost Pro Tier: Pro Status: Active Expires: 2027-01-15 00:00:00 +00:00Check 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 ClaimsActive Subscriptions (1) ✓ XrmGhost Pro Tier: Pro Status: Active Expires: 2027-01-15 00:00:00 +00:00 Program ID: 4f2b9c1e-8d3a-4f57-9b0c-2a6e5d71c843Unlicensed machine
Section titled “Unlicensed machine”$ xg license status
XrmGhost License Status
Retrieving license information...No Active License Found Status: Unlicensed Tier: Standard Unlicensed Description: No active license was found on this machine.
To activate a license, use: xg license activate <bootstrap-key>
Subscription Claims No subscription claims foundLicense expiring within 30 days
Section titled “License expiring within 30 days”$ xg license status
XrmGhost License Status
Retrieving license information...License Active Tier: Pro Expires: 2026-05-25 00:00:00 +00:00
⚠️ License expires in 18 daysConsider renewing your license before it expires.
Subscription ClaimsActive Subscriptions (1) ✓ XrmGhost Pro Tier: Pro Status: Active Expires: 2026-05-25 00:00:00 +00:00 ⚠️ Expires in 18 daysLicense in Grace Period
Section titled “License in Grace Period”$ xg license status
XrmGhost License Status
Retrieving license information...License in Grace Period Tier: Pro Grace ends: 2026-11-05 00:00:00 +00:00 (14 days left)
Renew your subscription: https://admin.xrmghost.tech/subscriptions
Subscription Claims Your subscription has expired; the tier is kept until the grace period ends.See Also
Section titled “See Also”- xg license activate — Activate a license using a bootstrap key.
- xg license get-platform-id — Display the unique machine identifier required for licensing.
- CLI Overview — Introduction to the
xgcommand-line interface.