ARI.Software Docs

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.

macOS / LinuxWindows PowerShellDescription
./ari start.\ari.cmd startStart the database (if local) and development server. Binds the dev server to localhost only.
./ari start --lan.\ari.cmd start --lanSame as start, but binds the server to all network interfaces so other devices on the same WI-FI or LAN can access it. Prints both the Local: and Network: URLs.
./ari start --verbose.\ari.cmd start --verboseSame as start, but streams full dev server output. Default mode hides logs behind a spinner and only prints the ready URL.
./ari start --tunnel.\ari.cmd start --tunnelSame as start, but also opens a temporary public HTTPS address through a Cloudflare Quick Tunnel and prints it as Tunnel:. Requires cloudflared and a completed setup. Combines with --lan and --verbose. See Tunnel.
./ari stop.\ari.cmd stopStop 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.\ari.cmd statusShow database mode and connection status (Supabase containers, PostgreSQL, pgweb, env file).
./ari update.\ari.cmd updateUpdate to the latest ARI release. Adds the upstream remote if missing, shows the version change and what it includes, and merges after confirmation. Runs pnpm install afterwards. See Updating.
./ari update 2.0.8.\ari.cmd update 2.0.8Same as update, but moves to a specific release. It must be newer than the installed version; downgrades are refused.
./ari update --edge.\ari.cmd update --edgeSame as update, but moves to the newest unreleased code on main instead of a release.
./ari doctor.\ari.cmd doctorPrint a diagnostic report covering ARI version, Node, pnpm, Git, Postgres, .env.local keys, live DB connectivity, pgweb, cloudflared, 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

Updates ARI to the latest release from the official upstream repository, or to a specific newer release if you ask for one. Adds the upstream remote if missing, shows you what's new, and merges after confirmation. Handles post-update tasks: installs new dependencies, regenerates the module registry, and reports any new environment variables the release needs. Database changes need no action; ARI applies them the next time it starts.

Your Personal Workspace. Your Rules.

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

Get Started