From 1183027372fdfd17515b3e031c998121445edbc5 Mon Sep 17 00:00:00 2001 From: Andres Nowak <35544006+andresnowak@users.noreply.github.com> Date: Wed, 20 May 2026 06:49:59 -0600 Subject: [PATCH] Updated run:ai CLI installation instructions Updated installation instructions for run:ai CLI, including steps for adding binary location to PATH. --- README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 56 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f03e8fe..d2e17e0 100644 --- a/README.md +++ b/README.md @@ -117,17 +117,65 @@ curl -o ~/.kube/config https://raw.githubusercontent.com/epfml/getting-started/m Download and install the run:ai CLI: +1. Go to the [EPFL Run:ai website](https://rcpepfl.run.ai/). + +2. Click the `?` icon in the top-right corner. + + Screenshot 2026-05-20 at 2 42 05 p m + +3. Select your operating system. + + Screenshot 2026-05-20 at 2 42 29 p m + +4. Copy and run the installation command shown there, replacing the authorization header with your own token. For example on macOS: + + ```bash + bash -c "$(curl -fsSL https://rcpepfl.run.ai/api/v1/cli-exposer/installer/mac \ + -H '')" + ``` + +5. Accept the prompts during installation. + +6. Reload your shell configuration: + + ```bash + source ~/.zshrc + # or, if you use bash: + source ~/.bashrc + ``` + +#### If `runai` is still not found + +Sometimes the installer does not add the binary location to your `PATH` correctly. + +During installation, look for a line like: + ```bash -# macOS with Apple Silicon -wget --content-disposition https://rcp-caas-prod.rcp.epfl.ch/cli/darwin +## Installing... + ▸ Preparing directory (/Users//.runai/bin/2.116.2) + ▸ Downloading binary (https://rcpepfl.run.ai/api/v1/cli-exposer/dist/darwin/arm64/runai) + ▸ Linking executable (/Users//.runai/bin/runai) +``` -# Linux (replace 'darwin' with 'linux') -# wget --content-disposition https://rcp-caas-prod.rcp.epfl.ch/cli/linux +The important part is the parent directory of the linked executable, for example: -# Install -chmod +x ./runai -sudo mv ./runai /usr/local/bin/runai -sudo chown root: /usr/local/bin/runai +```text +/Users//.runai/bin +``` + +Add that directory to your shell config file: + +```bash +echo 'export PATH="$PATH:/Users//.runai/bin"' >> ~/.zshrc +# or ~/.bashrc if you use bash +``` + +Then reload your shell again: + +```bash +source ~/.zshrc +# or +source ~/.bashrc ``` ### 3. Login to the Cluster