Skip to main content

Installation

Make sure you have nodejs version 22 or above up and running on your computer.

npm config set @sterfive:registry=https://npm-registry.sterfive.fr

then you'll need to create a user account on the sterfive registry, and answer the questions

$ npm login --registry=https://npm-registry.sterfive.fr
Username: joe.doe
Password:
Email: (this IS public) joe.doe@acme.com

finally, you can install the opcua-tool

npm install -g @sterfive/opcua-modeler

and you should be able to run the opcua-modeler command

opcua-modeler version

Windows: install with Scoop​

On Windows, Scoop installs the CLI together with the Node.js 22 it needs, and does not require an account on the Sterfive registry:

scoop install https://deploy.sterfive.com/bucket/opcua-modeler.json

The manifest adds Scoop's versions bucket if it is missing and installs versions/nodejs22 alongside the CLI. Check the installation from a new terminal:

opcua-modeler version

Using a Scoop install from VS Code​

Leave opcuaModeler.serverPath at its default, opcua-modeler. Scoop puts opcua-modeler.cmd on your PATH, and the extension finds it there.

If you do set the path explicitly, use the .cmd shim:

C:\Users\<you>\scoop\shims\opcua-modeler.cmd
Find the right file with where, not which

In Git Bash, which opcua-modeler prints …\scoop\shims\opcua-modeler, a shell script for Bash that VS Code cannot run on its own. In cmd or PowerShell, where opcua-modeler lists the .cmd shim.

Faster start-up. The Scoop shim looks up Node.js 22 through Scoop before starting the CLI, which adds about two seconds every time VS Code launches the language server. To skip it, point opcuaModeler.serverPath straight at the CLI script. The current folder follows scoop update, so the path stays valid across upgrades:

C:\Users\<you>\scoop\apps\opcua-modeler\current\node_modules\@sterfive\opcua-modeler\opcua-modeler.js

The extension then runs it with the node found on your PATH, which must be version 22 or later.

"CLI was not found on PATH" although the CLI works in a terminal

Extension 1.1.0 waits only 5 seconds for opcua-modeler --version. A Scoop install can take longer than that, particularly the first time after a reboot while antivirus software scans the files, so the extension reports the CLI as missing. Run OPC UA Modeler: Restart Language Server from the Command Palette to try again, or use the direct script path above, which starts faster. Later extension versions wait up to 30 seconds.

Updating the opcua-modeler to the latest version​

simply run this command to upgrade the opcua-modeler command to the latest version

npm install -g @sterfive/opcua-modeler@latest

or, for a Scoop installation:

scoop update opcua-modeler

Trial version​

The opcua-modeler command can be used in trial mode for 30 days without any licence. It contains limitations on the number of nodes that can be generated but will allow you to test the functionalities of the tool on a small model.

acquiring the licence​

You can acquire a licence by buying it online on the Sterfive E-Shop at https://www.sterfive.com/shop/opcua-modeler/

There are several types of licences available:

  • a monthly subscription licence
  • a yearly subscription licence [most popular]

You can also contact Sterfive sales team to get a quote for volume licences or enterprise licences at https://www.sterfive.com/quote

Activating your licence​

Once you have purchased a licence, activate it with:

opcua-modeler licence activate

You will be prompted to enter your licence key. The tool contacts the Sterfive licence server to validate and register your activation. An internet connection is required.

To check your current activation status at any time:

opcua-modeler licence

See the Licence management page for full details including offline activation and deactivation.