Host Environment

Sometimes it's necessary to find out the host environment where a plugin or script is running. You can find a range of information such as the host OS, locale, home folder, installed application version, etc, by using UXP APIs.

System requirements

Please make sure your local environment uses the following application versions before proceeding.

InDesign v18.5 or higher
UDT v1.9.0 or higher
Manifest version v5 or higher

Example

JavaScript

Output

async function foo() {
    const { host, versions } = require('uxp');
    const osInfo = require('os');

    console.log(`System information: ${osInfo.platform()} v${osInfo.release()}`);
    console.log(`Application: ${host.name} v${host.version} powered by ${versions.uxp}`);
}
Copied to your clipboard
async function foo() {
    const { host, versions } = require('uxp');
    const osInfo = require('os');

    console.log(`System information: ${osInfo.platform()} v${osInfo.release()}`);
    console.log(`Application: ${host.name} v${host.version} powered by ${versions.uxp}`);
}

System information: darwin v21.1.0
Application: InDesign v18.5.0 powered by uxp-7.1.0
Copied to your clipboard
System information: darwin v21.1.0
Application: InDesign v18.5.0 powered by uxp-7.1.0

Reference material

Host APIs
Versions APIs
OS APIs

Debug

Changes to Document

Was this helpful?

Yes

Host Environment

System requirements.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Example

Reference material

System requirements