CLI Documentation

Rauts CLI

Use Rauts CLI to authenticate, scan your backend, and sync endpoint docs to your dashboard in minutes.

Step 01

Install

npm install -g rauts-cli

Install the CLI globally so the `rauts` command works from any folder.

Step 02

rauts login

Starts browser authentication and stores your local CLI session.

Step 03

rauts scan

Scans the current project, enriches endpoint metadata, and syncs to dashboard.

Step 04

rauts local

Starts the local proxy to safely forward and test localhost playground requests from the cloud dashboard.

Check version

rauts --version

Scan a specific folder

rauts scan ./services/api

Export HTML docs file

rauts scan --export