ARI.Software Docs

Commands

Reference for the ARI CLI and the custom Claude Code commands bundled with ARI.

ARI ships with two sets of commands: the ARI CLI for managing your local installation, and a set of Claude Code custom commands for working with modules and updates.

ARI CLI

The ARI CLI is created automatically by the installer and lives in the project directory. Run it from the root of your ARI installation.

On macOS and Linux, the CLI is invoked as ./ari. On Windows, use .\ari.cmd in PowerShell — the commands and flags are identical.

Command Description
./ari start Start the database (if local) and development server. Binds the dev server to localhost only.
./ari start --lan Same as start, but binds the Next.js dev server to all interfaces so other devices on your LAN can reach it (useful for testing on your phone or tablet). Prints both the Local: and Network: URLs.
./ari start --verbose Same as start, but streams full dev server output. Default mode hides logs behind a spinner and only prints the ready URL.
./ari stop Stop local database services. In supabaselocal mode this shuts down the Supabase containers; in postgres mode it stops pgweb and prompts before stopping PostgreSQL. No-op in supabasecloud mode.
./ari status Show database mode and connection status (Supabase containers, PostgreSQL, pgweb, env file).
./ari update Add the upstream remote if missing, fetch updates from the official ARI repo, show what's changed, and merge after confirmation. Runs pnpm install afterwards.
./ari doctor Print a diagnostic report covering Node, pnpm, Git, Postgres, .env.local keys, live DB connectivity, pgweb, and (in Supabase modes) the Supabase CLI and Docker. Paste this when asking for help.

Claude Code Commands

ARI includes a set of custom commands for Claude Code that help you scaffold modules, audit them for security, and keep your installation up to date.

/ari-create-module

Scaffolds a new custom module under modules-custom/ using hello-world as a starting template. Walks you through naming, schema, and routes while enforcing ARI's security defaults: RLS on every table, authenticated API routes, Zod-validated input, and the withRLS() helper for all database access.

/ari-audit-module

Read-only static audit of a single module covering security, production-readiness, and Supabase/Postgres best practices. Runs three parallel subagents and produces one consolidated report with findings grouped by High / Medium / Low severity, plus a top-5 priority list. Does not modify any code.

/ari-update

Pulls the latest ARI updates from the official upstream repository. Adds the upstream remote if missing, fetches changes, shows you what's new, and merges after confirmation. Handles post-update tasks like dependency installs, new SQL migrations, module registry regeneration, and env var changes.

Your Personal Workspace. Your Rules.

Open Source. Self-Hosted. Full Data Control. Fully Extendable. AI Native. Dozens of Built-In Modules And Build Your Own In Minutes. No Coding Required.

Download