Skip to content
Oluso

Get started

Quickstart

Five minutes from the installer to a first vulnerability scan and a code review.

On this page

1. Install

Follow Installation if this machine does not have oluso yet. The one-line form is below. The clone is the slow step. The scan and the review after it are one command each.

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

bash

oluso --version

2. Sign in

Create an account at https://desk.oluso.xyz/signup. A new account receives ₦500.00 of welcome credit. Then point the CLI at the hosted API and approve the device code.

bash

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

3. Vulnerability scan

The repository includes examples/lumen-pay, a small transfer service with findings on purpose. The one-line installer checks that out at ~/.local/share/oluso. oluso scan reads the tree on this machine. It does not spend wallet credit.

bash

cd "$HOME/.local/share/oluso/examples/lumen-pay"
oluso scan .

The report prints a score out of 100, secrets and risky patterns, dependency notes, and the NDPA and CBN-style checklists. Add --json, --sarif, or --pdf report.pdf when you want a file instead of text. Add --upload to save the report on your account. Upload needs the sign-in from the previous step.

4. First review

A review is a model turn, so it draws on the wallet. Oluso Swift is the default. --mode review keeps the agent on read, scan, and checklist tools.

bash

oluso chat --mode review "Review this project. Highest severity first."

With a prompt, the command runs one turn and exits. Without a prompt, oluso chat --mode review stays open until you send an empty line. oluso with no command opens the same loop in code mode, which the banner labels chat.

Where to go next