Skip to content

Commit 473404d

Browse files
Merge pull request #2 from relativitydev/REL-1275252-aggree-on-rapbuilder-delivery
REL-1275252: update rapbuilder README
2 parents 4671896 + 8a26c1c commit 473404d

1 file changed

Lines changed: 3 additions & 19 deletions

File tree

rapbuilder/README.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,16 @@
22

33
The `relsvr-rap` CLI builds Relativity Application Package (RAP) files from your application schema, resource files, assemblies, and custom pages. As part of the build process, the CLI will also perform certain validation checks on the RAP, such as whether assemblies contained within the RAP reference the expected version of Relativity SDKs for a given Relativity Server release. Starting with Relativity Server 2026, RAPs that are uploaded to a Relativity Server will display a warning if they do not pass RAP Builder's validations, or were built without using RAP Builder.
44

5-
## Prerequisites
6-
7-
Before running the build, ensure the following tools are installed and available on your `PATH`:
8-
9-
- **[.NET SDK](https://dotnet.microsoft.com/download)** — required to install as a dotnet tool
10-
115
## Installation
126

137
1. Find and download the latest `rapbuilder` [release from GitHub](https://github.com/relativitydev/server-release/releases).
14-
2. Extract the contents of the zip file somewhere on your local computer. Make note of the folder that contains the Relativity.Server.RAPTool.nupkg.
15-
3. Install or update RAP Builder:
16-
- **For first-time installation**: Use the [`dotnet tool install` command](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-install) with the folder from step 2 as a source. For example:
17-
```
18-
dotnet tool install --global Relativity.Server.RAPTool --add-source C:\Downloads\RAPBuilder
19-
```
20-
- **For updating an existing installation**: Use the `dotnet tool update` command instead:
21-
```
22-
dotnet tool update --global Relativity.Server.RAPTool --add-source C:\Downloads\RAPBuilder
23-
```
24-
4. Verify that RAP Builder has been installed by running `relsvr-rap -v`. This command should print the version of RAP Builder.
25-
5. To uninstall RAP Builder, run `dotnet tool uninstall --global Relativity.Server.RAPTool`
8+
2. Extract the contents of the zip file somewhere on your local computer.
9+
3. Copy `relsvr-rap.exe` to a directory that is included in your `%PATH%` environment variable, or [update the environment variable](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/path) to include the folder that contains `relsvr-rap.exe`.
2610

2711
## Command Syntax
2812

2913
```text
30-
relsvr-rap build --source <path> --input <file> --version <version> --relativity-server-release <year> [--warnings-as-errors <true|false>] [--log-file <path>] [--log-level <level>]
14+
relsvr-rap.exe build --source <path> --input <file> --version <version> --relativity-server-release <year> [--warnings-as-errors <true|false>] [--log-file <path>] [--log-level <level>]
3115
```
3216

3317
## Parameters

0 commit comments

Comments
 (0)