Skip to content

Commit ac1a588

Browse files
respencer-nclclaude
andcommitted
Add Homebrew installation instructions for macOS
Add section documenting `brew install ossuminc/tap/riddlc` as the simplest installation method for macOS users. Also update the example output from `riddlc info` to reflect current version. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 6f32dda commit ac1a588

1 file changed

Lines changed: 28 additions & 8 deletions

File tree

docs/riddl/tools/riddlc/installation.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,21 @@ The easiest way to get started is to download a pre-built release:
3030
Not all releases include pre-built assets. If no asset is available for
3131
your desired version, you'll need to build from source.
3232

33+
## Homebrew (macOS)
34+
35+
On macOS, the easiest installation method is via Homebrew:
36+
37+
```bash
38+
brew install ossuminc/tap/riddlc
39+
```
40+
41+
This installs the latest release and manages updates automatically. To upgrade
42+
later:
43+
44+
```bash
45+
brew upgrade riddlc
46+
```
47+
3348
## Build from Source
3449

3550
Building from source requires JDK 25 and sbt.
@@ -106,14 +121,19 @@ riddlc info
106121
You should see output like:
107122

108123
```
109-
[info] About riddlc:
110-
[info] name: riddlc
111-
[info] version: 1.1.2
112-
[info] documentation: https://riddl.tech
113-
[info] copyright: © 2019-2026 Ossum Inc.
114-
[info] licenses: Apache License, Version 2.0
115-
[info] organization: Ossum Inc.
116-
[info] scala version: 3.3.7
124+
[info] About RIDDL:
125+
[info] name: utils
126+
[info] version: 1.2.1
127+
[info] documentation: https://github.com/ossuminc/riddl
128+
[info] copyright: © 2019-2026 Ossum, Inc.
129+
[info] built at: 2026-02-01 23:24:51.835-0500
130+
[info] licenses: Apache-2.0
131+
[info] organization: Ossum, Inc.
132+
[info] scala version: 3.7.4
133+
[info] sbt version: 1.12.0
134+
[info] jvm name: OpenJDK 64-Bit Server VM
135+
[info] jvm version: 21.0.10
136+
[info] operating sys: Mac OS X
117137
```
118138

119139
## Next Steps

0 commit comments

Comments
 (0)