Skip to content
This repository was archived by the owner on Sep 11, 2025. It is now read-only.
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions tools/keygen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@ This is a small utility that will generate keys and tokens for use with Modus.

## Usage

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

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

The output will contain the following:
- Clone this repo, then from the `/tools/keygen` directory, run the utility via: `go run .`
- Install it with `go install github.com/hypermodeinc/modus/tools/keygen@latest` then run `keygen`

The keygen tool will print the following items to stdout:

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