Skip to content

quick-start.md

Latest commit

 

History

History
93 lines (64 loc) · 1.98 KB

quick-start.md

File metadata and controls

93 lines (64 loc) · 1.98 KB
Raw

Quick Start

Get AIRIS running in 5 minutes.

1. Install

# One-liner (Linux/macOS/Termux)
curl -fsSL https://sufiyan-sabeel.github.io/AIRIS-CLI/install.sh | sh

# Or from source
git clone https://github.com/sufiyan-sabeel/AIRIS-CLI.git
cd AIRIS-CLI
npm install --ignore-scripts --no-audit --no-fund
npm run build
npm link

2. Configure a Provider

Set an API key for at least one provider:

# Google Gemini (free tier available)
export GEMINI_AAIRIS_KEY="your-key"

# OpenAI
export OPENAI_AAIRIS_KEY="your-key"

# Anthropic
export ANTHROPIC_AAIRIS_KEY="your-key"

# Add to your shell profile for persistence
echo 'export GEMINI_AAIRIS_KEY="your-key"' >> ~/.bashrc

3. Start AIRIS

airis

You will see the AIRIS welcome screen with:

  • Brand information
  • Available providers and models
  • Quick-start commands

4. Try These Commands

# Ask a question
airis -p "What files are in this directory?"

# Review code
airis -p "Review this project for potential issues"

# Edit a file (with confirmation)
airis -p "Add a comment to the top of package.json"

# Continue your last session
airis --continue

5. Use Project Trust

When AIRIS detects a project directory, it asks whether to trust it:

# Trust the current project
airis trust

# Check trust decisions
airis trust list

Trust allows AIRIS to read and edit files in the project. Risky actions always require confirmation.

6. Try airis ship

Start a full development workflow:

airis ship start "Add a help command that shows usage examples"

This creates a mission contract, tracks progress through implementation, formatting, testing, and verification, and produces a proof report.

Next Steps