> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/dev-reference/custom-protocol.md).

# Custom Protocol

RealmJoin custom protocol (realmjoin:) handlers that trigger sync, install, upgrade, and remote support actions for packages by package ID.

The `CustomProtocol` class defines a set of URI-like prefixes that can be used to trigger specific actions within the system by providing a package ID. These custom protocol handlers are designed to streamline operations such as syncing, installing, upgrading, or initiating remote support for software packages.

| Constant                   | Description                                       | Example Usage                  |
| -------------------------- | ------------------------------------------------- | ------------------------------ |
| `realmjoin:`               | Base prefix for all custom protocol actions.      |                                |
| `realmjoin:sync:`          | Triggers a sync operation for the RealmJoin agent | `realmjoin:sync:`              |
| `realmjoin:install:`       | Initiates installation of the specified package.  | `realmjoin:install:package-id` |
| `realmjoin:upgrade:`       | Starts an upgrade process for the package.        | `realmjoin:upgrade:package-id` |
| `realmjoin:remotesupport:` | Launches a remote support session.                | `realmjoin:remotesupport:`     |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.realmjoin.com/dev-reference/custom-protocol.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.