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 (recommended) #

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 this in your terminal

@@@     @@@    @@@@@@&    @@     .@@      @@@@@     #@@@@@      @@    @&    &@
@@@@   @@@@    @@         @@@   @@@@    @@    %@    #@&   @@    @@     @@@@@@
@@ @@ @@ @@    @@^^^^^    @@ @@@@ @@    @@    @@    #@@@@@@     @@     @@@@@@
@@  @@@  @@    @@@@@@&    @@ .@@  @@      @@@@      #@&  @@@    @@    @&    &@

1.0.0

Manual installation #

This way also supports windows without WSL, but is a bit more tedious

• Go to memorix releases on github.
• Download the asset for your platform.
• Extract the executable somewhere on your computer, like ~/.memorix/bin/*.
• Add the folder extracted to 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 #

npm install @memorix/client-redis

yarn 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 →