Installation

CLI installation #

Follow the instructions below to install memorix-cli on your machine depending on the platform you use

macOS, linux and WSL installation #

Requirements #

• brew — Package manager for macOS and linux.
  • To install on Linux or WSL, couple of commands are required after the install script.

Steps #

Run these in the terminal

brew tap uvop/memorix
brew install memorix
memorix --version

Done!
if successful, you should see the version installed in your terminal

Windows #

Requirements #

• choco — Package manager for Windows.

Steps #

Run these in the cmd

choco install memorix
memorix --version

Done!
if successful, you should see the version installed in your terminal

Manual installation #

• Go to memorix releases on github.
• Download the executable for your platform and place somewhere in your system (for instance, ~/.memorix)
• Add the folder where the executable is to your PATH environment variable.
• Done!

Client installation #

To start using Memorix, first head into your project(s) and install the run-time dependency.
At the moment, only Redis is supported

Redis client #

deno add jsr:@memorix/client-redis

bunx jsr add @memorix/client-redis

npx jsr add @memorix/client-redis

pip install memorix-client-redis

poetry add memorix-client-redis

cargo add memorix-client-redis

Now we’re ready to start using Memorix! Head on to Quick start →