Skip to content

TRM Registry

TRM uses a registry to publish and download packages.

By default, TRM is configured to work with the public registry, and no additional setup is required unless you wish to use or host a private registry.

Any TRM registry other than the official public registry is considered a private registry.

Public Registry

The TRM Public Registry is the official registry service provided by TRM.

  • Default Behavior: All TRM clients are preconfigured to use it.
  • Anonymous Access: Package downloads can often be done without an account.
  • Plans & Permissions: Access levels and limits are determined by the user’s subscription plan. You can compare plans here.

Private Registry

You can configure one or more private registries to use with TRM.

How to Add a Private Registry

You can add a private registry in two ways:

Option 1: Manually via File

  1. Navigate to your system's AppData folder:
  2. Go to the trm directory (created after running any CLI command once).
  3. Open or create a file named registry.ini.
  4. Add your private registry in the following format:
[<registry name>]
endpointUrl=<registry endpoint>

You may also optionally include an auth property containing a JSON-formatted authentication payload if your registry requires credentials.

Option 2: Using the CLI

You can also add a registry with a single command:

trm registry add <registry name>

TRM will prompt you for the registry endpoint and any optional authentication configuration.

Create Your Own Private Registry

To host a private registry, implement the required endpoints described in the TRM Registry API reference.

The API contract is also available as a machine-readable OpenAPI schema.

TypeScript definitions for the request and response payloads are available in the trm-registry-types npm package.