Installation

Requirements

The oluso command is the bin in packages/cli. That package is private, so npm install -g oluso is not a real install. You clone the repository, install its dependencies, and link the bin.

Install

The desk serves a one-line installer at /install.sh. It checks the operating system and the Node version, clones the repository to ~/.local/share/oluso, runs pnpm install --frozen-lockfile, and links the oluso bin to ~/.local/bin/oluso.

curl -fsSL https://desk.oluso.xyz/install.sh | sh

Install from source

The same steps, typed by hand. packages/cli/package.json names the bin oluso and points it at packages/cli/bin/oluso.mjs. The link below puts that file on your PATH.

git clone https://origin.cursor.com/git/samolubunmi-eth/oluso.git
cd oluso
corepack enable
corepack prepare pnpm@10.33.4 --activate
pnpm install
mkdir -p "$HOME/.local/bin"
ln -sfn "$PWD/packages/cli/bin/oluso.mjs" "$HOME/.local/bin/oluso"
export PATH="$HOME/.local/bin:$PATH"
oluso --version

On Windows, open WSL and run the same block. If corepack enable cannot write to the Node prefix, run corepack pnpm install --frozen-lockfile from the repository instead of pnpm install.

Sign in

oluso login starts a device-code sign-in. The command prints a short code and a link on the desk. Open the link, sign in, and approve the code. The CLI polls for up to 15 minutes, then stores the session.

The hosted desk is https://desk.oluso.xyz. Its API is https://api.oluso.xyz. The CLI reads OLUSO_API_URL on every command and otherwise uses http://127.0.0.1:4317. Put the export in your shell profile when you use the hosted desk.

export OLUSO_API_URL=https://api.oluso.xyz
oluso login
oluso whoami

--api overrides the environment variable for a single command. It is a global option, so it can sit before or after the command name: oluso --api https://api.oluso.xyz login.

Verify

oluso --version prints the version from packages/cli/package.json. The short flag is -V.

oluso --version

A working install prints 0.1.0. oluso --help lists every command. If the shell says oluso: command not found, ~/.local/bin is not on PATH.

First run

1. Confirm the bin with oluso --version.
2. Export OLUSO_API_URL=https://api.oluso.xyz for the hosted desk, or leave it unset to use a local API on port 4317.
3. Run oluso login and approve the code at the printed URL.
4. Run oluso whoami. It prints your name, email, and wallet.
5. In a project, run oluso init. The first time, it writes .oluso/project.json (version 1, Oluso Swift, review) and prints the next commands. A second run prints This folder is already set up.
6. Run oluso scan . for a vulnerability scan. Scans do not spend wallet credit.

Update

The linked bin is the file in your checkout, so a pull updates the command. From a hand clone, run this in that directory. The one-line installer uses ~/.local/share/oluso, and running the installer again pulls and reinstalls.

cd "$HOME/.local/share/oluso"
git pull --ff-only
pnpm install --frozen-lockfile
oluso --version

Uninstall

Sign out while the command still exists. oluso logout writes an empty session and prints Signed out. Then remove the link, the checkout, and the credential directory.

oluso logout
rm -f "$HOME/.local/bin/oluso"
rm -rf "$HOME/.local/share/oluso"
rm -rf "$HOME/.oluso"

Troubleshooting