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.

Example

data-slots=heading, code

data-repeat=2

data-languages=JavaScript,text

JavaScript

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}`);
}

Output

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

Reference material