Skip to main content

Twinit Config Check

The Twinit Config Check view helps you configure your local system and the IDE Extension for developing Twinit applications. It scans your current configuration, reports what is still required, and lets you fix each item directly from the view.

Opening the Twinit Config Check View#

The first time the Twinit IDE Extension is activated it will display the Twinit Config Check View.

The Twinit Config Check View can also be invoked from the Support Center panel.

When the view opens it scans your configuration and populates three sections: Suggested Actions, Twinit Environments, and NPM and Environment Variables. The scan re-runs automatically whenever you save a change from within the view.

Suggested Actions#

The Suggested Actions section summarizes everything that still needs your attention, such as adding access keys for an environment, installing Node.js and npm, setting the NPM environment variables, or verifying registry access.

Once every required item is configured, this section displays Your Twinit Setup is Complete and no further action is needed.

Twinit Environments#

When developing Twinit applications you typically work with at least two environments:

  • Twinit Sandbox — used for training, development, and testing. This environment is required.
  • Twinit Production — used for live production deployments. This environment is optional.

Each environment requires its own user access keys, created from your account on that environment.

Adding Access Keys#

When an environment has not been configured, the view shows a card with Access Key and Secret Key fields:

  1. Click the Twinit User Account link in the card to open your account for that environment.
  2. Sign in, open User Access Keys, and click Generate New Access Keys to create your access and secret keys.
  3. Paste the keys into the Access Key and Secret Key fields.
  4. Click Save.

Both the access key and secret key are required. When saved, the keys are stored in the extension's environment settings and the environment card updates to show a configured checkmark.

A configured environment is shown with a green checkmark and the environment's name. To review or edit all of your environment configurations directly in your user settings, click the View all Twinit Environment Configurations link.

NPM and Environment Variables#

The @dtplatform and @invicara npm packages that simplify working with Twinit APIs are hosted in a private registry. To install them, most projects use an .npmrc file that references environment variables containing your Twinit Production user access keys.

This section checks the following items and shows a checkmark or a missing indicator for each:

  • npm — whether npm (and Node.js) is installed and available on your PATH. If npm is not found, an Install Node.js (includes npm) link is provided.
  • DTPLATFORM_KEY — your Production user access key.
  • DTPLATFORM_SECRET_BASE64 — the Base64-encoded Production secret key (generated automatically from your secret key).
  • DTPLATFORM_EMAIL — your Twinit platform login email.
  • @dtplatform registry access — verifies that the configured credentials can access @dtplatform packages on the Twinit NPM registry. This check is skipped until the environment variables are set.

Creating NPM Environment Variables#

When any of the required environment variables are missing, the view shows a Create NPM Environment Variables form with two ways to provide your credentials:

  • Use configured Production environment — select an existing configured Twinit Production environment and the access keys from that environment are used. This option is only available when at least one Production environment has been configured in the Twinit Environments section.
  • Enter keys manually — paste a Production access key and secret key directly. Use the Twinit User Account link to generate the keys if needed.

In both cases, if you are signed in to Twinit your User's email will be populated automatically. Otherwise you will need to enter it yourself.

Click Save to write the environment variables to your user environment:

  • On Windows, the variables are saved to your Windows user environment.
  • On macOS and Linux, the variables are saved to your shell profile (and applied to the current macOS session).

DTPLATFORM_SECRET_BASE64 is generated automatically from the secret key you provide, and DTPLATFORM_EMAIL is set from your signed-in Twinit account email when it is not already set.

Restarting the IDE#

After saving NPM environment variables, you must restart your IDE so that terminals and npm pick up the new values. When a restart is required, a Restart button appears at the bottom of the view. Click Restart to reload the window.

Closing the View#

Click Close at the bottom of the view to dismiss the Twinit Config Check. You can reopen it at any time from the Support Center panel.