0 Fork 0

mirror of https://github.com/MervinPraison/PraisonAIUI.git synced 2026-11-07 05:56:17 -10:00

Files

T

MervinPraisonandClaude 1e81b32f1d feat: add 'health' alias for 'health-check' command (fixes #136 )

- Register 'health' as an alias for 'health-check' to support both command names
- Update documentation to use canonical 'health-check' with notes about 'health' alias
- Add tests to verify both commands work correctly

This ensures backward compatibility for users who expect 'aiui health' to work
while maintaining 'health-check' as the canonical command name.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>

2026-06-23 09:47:46 +00:00

2.1 KiB

Raw Blame History

Quick Start

Get a working AI dashboard in under 60 seconds.

Prerequisites

Python 3.10+
An OpenAI API key (or compatible provider)

export OPENAI_API_KEY="sk-..."

Install

pip install aiui

Option 1: Dashboard Mode (recommended)

Create an app.py:

import praisonaiui as aiui

aiui.set_style("dashboard")
aiui.set_pages(["chat", "agents", "memory", "sessions", "config"])
aiui.set_branding(title="PraisonAI", logo="🦞")

aiui.register_agent({
    "agent_id": "assistant",
    "name": "Assistant",
    "description": "General purpose AI assistant",
    "instructions": "You are a helpful assistant. Be concise.",
    "model": "gpt-4o-mini",
    "icon": "🤖",
})

@aiui.reply
async def on_reply(message):
    """Handle incoming chat messages."""
    # The registered agent handles the reply automatically
    pass

Run:

aiui run app.py

Open http://localhost:8000 — your dashboard is live with chat, agent management, memory, sessions, and config pages.

Option 2: YAML Chat Mode

Create a chat.yaml:

name: My Assistant
instructions: You are a helpful assistant.
model: gpt-4o-mini
welcome: "Hi! How can I help you today?"
starters:
  - label: "What can you do?"
    message: "Tell me about your capabilities"
  - label: "Help me write"
    message: "Help me draft an email"
tools:
  - web_search
features: true

Run:

aiui run chat.yaml

Option 3: Documentation Mode

Generate a static docs site from Markdown files:

aiui init --template docs
# Edit docs/*.md files
aiui build
aiui serve

Next Steps

CLI Reference — Full command reference with all 22 command groups
Python API — SDK function reference
Dashboard Features — All 24 dashboard pages
Configuration — YAML configuration guide

Diagnostics

If something isn't working:

aiui doctor               # Check server health
aiui health-check --detailed  # Detailed health check (alias: aiui health)
aiui test all              # Run all integration tests

2.1 KiB Raw Blame History