Skip to content
This repository was archived by the owner on Sep 11, 2025. It is now read-only.

Commit 8b79d17

Browse files
chore: update keygen readme (#974)
1 parent 2c37284 commit 8b79d17

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

tools/keygen/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,15 @@ This is a small utility that will generate keys and tokens for use with Modus.
44

55
## Usage
66

7-
You must have Go installed locally. We currently do not release this tool as a binary.
7+
You must have Go v1.25 or newer installed locally. We currently do not release this tool as a
8+
binary.
89

9-
From the `/tools/keygen` directory, run the utility via: `go run .`
10+
You can run it in one of two ways:
1011

11-
The output will contain the following:
12+
- Clone this repo, then from the `/tools/keygen` directory, run the utility via: `go run .`
13+
- Install it with `go install github.com/hypermodeinc/modus/tools/keygen@latest` then run `keygen`
14+
15+
The keygen tool will print the following items to stdout:
1216

1317
- A JSON encoded object containing an RSA public key, suitable for passing to `MODUS_PEMS`
1418
- A JWT token that is signed with that key, having a 1 year expiration date and no other claims,

0 commit comments

Comments
 (0)