Skip to content

Repository files navigation

rimdex

Semantic search for RimWorld Workshop mods.

Install

Download

Download the latest rimdex release from Releases.

  • Windows: rimdex-win-x64.zip
  • macOS (Apple silicon): rimdex-osx-arm64.zip

Add it to your path

  • Windows: mkdir %USERPROFILE%\.local\bin
  • macOS: mkdir ~/.local/bin

Skip this step if the directory already exists.

Move the extracted rimdex executable into that directory. On macOS, also run:

chmod +x ~/.local/bin/rimdex

Add %USERPROFILE%\.local\bin to PATH on Windows.

On macOS, add this line to ~/.zshrc:

export PATH="$HOME/.local/bin:$PATH"

Check the installation

Run rimdex --version. If it prints a version number, installation is complete.

Configure rimdex

rimdex uses an embedding model. Configure it with:

rimdex config set \
  --api-key "YOUR_API_KEY" \
  --base-url "https://api.openai.com/v1" \
  --model "text-embedding-3-small"

Build from source

git clone https://github.com/realloon/rimdex.git
cd rimdex
dotnet publish -c Release

About

CLI tool for semantic search of RimWorld Workshop mods.

Resources

Stars

Watchers

Forks

Releases

Contributors

Languages