RomanNum3ral
/
cai
mirror of https://github.com/aliasrobotics/cai.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cai/mui/mui_index/index.html

3695 lines
71 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../../cai/case-studies/operator-artifact-evidence/">
<link rel="next" href="../getting_started/">
<link rel="icon" href="../../assets/imago.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<title>Overview - CAI</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.4af4bdda.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
<link rel="stylesheet" href="../../stylesheets/extra.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#cai-mobile-user-interface-mobile-ui" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="CAI" class="md-header__button md-logo" aria-label="CAI" data-md-component="logo">
<img src="../../assets/imago.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
CAI
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Overview
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/aliasrobotics/cai" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
aliasrobotics/cai
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="CAI" class="md-nav__button md-logo" aria-label="CAI" data-md-component="logo">
<img src="../../assets/imago.png" alt="logo">
</a>
CAI
</label>
<div class="md-nav__source">
<a href="https://github.com/aliasrobotics/cai" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
aliasrobotics/cai
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
<label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="">
<span class="md-ellipsis">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_1">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Welcome
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../cai_installation/" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../cai_quickstart/" class="md-nav__link">
<span class="md-ellipsis">
Quickstart
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../cai_list_of_models/" class="md-nav__link">
<span class="md-ellipsis">
Available Models
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1_5" >
<label class="md-nav__link" for="__nav_1_5" id="__nav_1_5_label" tabindex="0">
<span class="md-ellipsis">
Model Providers
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_1_5">
<span class="md-nav__icon md-icon"></span>
Model Providers
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../providers/openrouter.md" class="md-nav__link">
<span class="md-ellipsis">
OpenRouter
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../providers/ollama/" class="md-nav__link">
<span class="md-ellipsis">
Ollama
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../providers/azure.md" class="md-nav__link">
<span class="md-ellipsis">
Azure OpenAI
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../cai_pro/" class="md-nav__link">
<span class="md-ellipsis">
🚀 CAI PRO
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Core Concepts
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Core Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cai_architecture/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../agents/" class="md-nav__link">
<span class="md-ellipsis">
Agents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tools/" class="md-nav__link">
<span class="md-ellipsis">
Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../handoffs/" class="md-nav__link">
<span class="md-ellipsis">
Handoffs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../multi_agent/" class="md-nav__link">
<span class="md-ellipsis">
Multi-Agent Systems
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
Benchmarking
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Benchmarking
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../benchmarking/overview/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../benchmarking/running_benchmarks/" class="md-nav__link">
<span class="md-ellipsis">
Running Benchmarks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../benchmarking/attack_defense/" class="md-nav__link">
<span class="md-ellipsis">
Attack & Defense CTFs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../benchmarking/jeopardy_ctfs/" class="md-nav__link">
<span class="md-ellipsis">
Jeopardy CTFs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../benchmarking/cyber_ranges/" class="md-nav__link">
<span class="md-ellipsis">
Cyber Ranges
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../benchmarking/knowledge_benchmarks/" class="md-nav__link">
<span class="md-ellipsis">
Knowledge Benchmarks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../benchmarking/privacy_benchmarks/" class="md-nav__link">
<span class="md-ellipsis">
Privacy Benchmarks
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../running_agents/" class="md-nav__link">
<span class="md-ellipsis">
Running Agents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../continue_mode/" class="md-nav__link">
<span class="md-ellipsis">
Continue Mode
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../results/" class="md-nav__link">
<span class="md-ellipsis">
Working with Results
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../streaming/" class="md-nav__link">
<span class="md-ellipsis">
Streaming
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tracing/" class="md-nav__link">
<span class="md-ellipsis">
Tracing & Debugging
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../context/" class="md-nav__link">
<span class="md-ellipsis">
Context Management
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guardrails/" class="md-nav__link">
<span class="md-ellipsis">
Guardrails & Security
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../environment_variables/" class="md-nav__link">
<span class="md-ellipsis">
Environment Variables
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../cai/getting-started/packet_capture_wsl/" class="md-nav__link">
<span class="md-ellipsis">
Packet Capture on WSL2
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-ellipsis">
Troubleshooting
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Troubleshooting
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cai/troubleshooting/operator_feedback_reproduction/" class="md-nav__link">
<span class="md-ellipsis">
Operator Feedback Reproduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../cai/troubleshooting/platform_limitations/" class="md-nav__link">
<span class="md-ellipsis">
Platform Limitations
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<span class="md-ellipsis">
Case Studies
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Case Studies
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cai/case-studies/operator-artifact-evidence/" class="md-nav__link">
<span class="md-ellipsis">
Operator Artifact Evidence
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" checked>
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<span class="md-ellipsis">
Mobile UI (iOS)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
Mobile UI (iOS)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Overview
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Overview
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#overview" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#when-to-use-mobile-ui-vs-tui-vs-cli" class="md-nav__link">
<span class="md-ellipsis">
When to Use Mobile UI vs TUI vs CLI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#quick-start" class="md-nav__link">
<span class="md-ellipsis">
Quick Start
</span>
</a>
<nav class="md-nav" aria-label="Quick Start">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-install-the-app" class="md-nav__link">
<span class="md-ellipsis">
1. Install the App
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-connect-to-your-cai-server" class="md-nav__link">
<span class="md-ellipsis">
2. Connect to Your CAI Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-start-using-cai" class="md-nav__link">
<span class="md-ellipsis">
3. Start Using CAI
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#system-requirements" class="md-nav__link">
<span class="md-ellipsis">
System Requirements
</span>
</a>
<nav class="md-nav" aria-label="System Requirements">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#device-requirements" class="md-nav__link">
<span class="md-ellipsis">
Device Requirements
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#server-requirements" class="md-nav__link">
<span class="md-ellipsis">
Server Requirements
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#key-features" class="md-nav__link">
<span class="md-ellipsis">
Key Features
</span>
</a>
<nav class="md-nav" aria-label="Key Features">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#native-ios-interface" class="md-nav__link">
<span class="md-ellipsis">
📱 Native iOS Interface
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#advanced-chat-interface" class="md-nav__link">
<span class="md-ellipsis">
💬 Advanced Chat Interface
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#network-discovery-mcp" class="md-nav__link">
<span class="md-ellipsis">
🌐 Network Discovery &amp; MCP
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#agent-management" class="md-nav__link">
<span class="md-ellipsis">
🎯 Agent Management
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#session-management" class="md-nav__link">
<span class="md-ellipsis">
📊 Session Management
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentation-structure" class="md-nav__link">
<span class="md-ellipsis">
Documentation Structure
</span>
</a>
<nav class="md-nav" aria-label="Documentation Structure">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#for-new-users" class="md-nav__link">
<span class="md-ellipsis">
For New Users
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-regular-users" class="md-nav__link">
<span class="md-ellipsis">
For Regular Users
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-advanced-users" class="md-nav__link">
<span class="md-ellipsis">
For Advanced Users
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#support-resources" class="md-nav__link">
<span class="md-ellipsis">
Support Resources
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#quick-reference" class="md-nav__link">
<span class="md-ellipsis">
Quick Reference
</span>
</a>
<nav class="md-nav" aria-label="Quick Reference">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#essential-gestures" class="md-nav__link">
<span class="md-ellipsis">
Essential Gestures
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#common-actions" class="md-nav__link">
<span class="md-ellipsis">
Common Actions
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#architecture" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#video-demo" class="md-nav__link">
<span class="md-ellipsis">
Video Demo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#community-and-support" class="md-nav__link">
<span class="md-ellipsis">
Community and Support
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#whats-next" class="md-nav__link">
<span class="md-ellipsis">
What's Next?
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../getting_started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../user_interface/" class="md-nav__link">
<span class="md-ellipsis">
User Interface
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../gestures_shortcuts/" class="md-nav__link">
<span class="md-ellipsis">
Gestures & Shortcuts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../chat_features/" class="md-nav__link">
<span class="md-ellipsis">
Chat Features
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
<label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="">
<span class="md-ellipsis">
Terminal UI (TUI) - Deprecated
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9">
<span class="md-nav__icon md-icon"></span>
Terminal UI (TUI) - Deprecated
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../tui/tui_index/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tui/getting_started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tui/user_interface/" class="md-nav__link">
<span class="md-ellipsis">
User Interface
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tui/terminals_management/" class="md-nav__link">
<span class="md-ellipsis">
Terminals Management
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tui/teams_and_parallel_execution/" class="md-nav__link">
<span class="md-ellipsis">
Teams & Parallel Execution
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tui/sidebar_features/" class="md-nav__link">
<span class="md-ellipsis">
Sidebar Features
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tui/keyboard_shortcuts/" class="md-nav__link">
<span class="md-ellipsis">
Keyboard Shortcuts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tui/commands_reference/" class="md-nav__link">
<span class="md-ellipsis">
Commands Reference
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tui/advanced_features/" class="md-nav__link">
<span class="md-ellipsis">
Advanced Features
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tui/troubleshooting/" class="md-nav__link">
<span class="md-ellipsis">
Troubleshooting
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
<label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="">
<span class="md-ellipsis">
API Reference
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_10">
<span class="md-nav__icon md-icon"></span>
API Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10_1" >
<label class="md-nav__link" for="__nav_10_1" id="__nav_10_1_label" tabindex="0">
<span class="md-ellipsis">
Agents
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_10_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_10_1">
<span class="md-nav__icon md-icon"></span>
Agents
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../ref/agent/" class="md-nav__link">
<span class="md-ellipsis">
Agent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/run/" class="md-nav__link">
<span class="md-ellipsis">
Runner
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/tool/" class="md-nav__link">
<span class="md-ellipsis">
Tool
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/result/" class="md-nav__link">
<span class="md-ellipsis">
Result
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/stream_events/" class="md-nav__link">
<span class="md-ellipsis">
Stream Events
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/handoffs/" class="md-nav__link">
<span class="md-ellipsis">
Handoffs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/lifecycle/" class="md-nav__link">
<span class="md-ellipsis">
Lifecycle
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/items/" class="md-nav__link">
<span class="md-ellipsis">
Items
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/run_context/" class="md-nav__link">
<span class="md-ellipsis">
Run Context
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/usage/" class="md-nav__link">
<span class="md-ellipsis">
Usage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/exceptions/" class="md-nav__link">
<span class="md-ellipsis">
Exceptions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/guardrail/" class="md-nav__link">
<span class="md-ellipsis">
Guardrail
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/model_settings/" class="md-nav__link">
<span class="md-ellipsis">
Model Settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/agent_output/" class="md-nav__link">
<span class="md-ellipsis">
Agent Output
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/function_schema/" class="md-nav__link">
<span class="md-ellipsis">
Function Schema
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10_2" >
<label class="md-nav__link" for="__nav_10_2" id="__nav_10_2_label" tabindex="0">
<span class="md-ellipsis">
Models
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_10_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_10_2">
<span class="md-nav__icon md-icon"></span>
Models
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../ref/models/interface/" class="md-nav__link">
<span class="md-ellipsis">
Interface
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/models/openai_chatcompletions/" class="md-nav__link">
<span class="md-ellipsis">
OpenAI Chat Completions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/models/openai_responses/" class="md-nav__link">
<span class="md-ellipsis">
OpenAI Responses
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10_3" >
<label class="md-nav__link" for="__nav_10_3" id="__nav_10_3_label" tabindex="0">
<span class="md-ellipsis">
Extensions
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_10_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_10_3">
<span class="md-nav__icon md-icon"></span>
Extensions
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../ref/extensions/handoff_filters/" class="md-nav__link">
<span class="md-ellipsis">
Handoff Filters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../ref/extensions/handoff_prompt/" class="md-nav__link">
<span class="md-ellipsis">
Handoff Prompt
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
<label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="">
<span class="md-ellipsis">
Advanced
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_11">
<span class="md-nav__icon md-icon"></span>
Advanced
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cai_development/" class="md-nav__link">
<span class="md-ellipsis">
Development
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_12" >
<label class="md-nav__link" for="__nav_12" id="__nav_12_label" tabindex="">
<span class="md-ellipsis">
Research
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_12_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_12">
<span class="md-nav__icon md-icon"></span>
Research
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../research/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_13" >
<label class="md-nav__link" for="__nav_13" id="__nav_13_label" tabindex="">
<span class="md-ellipsis">
Resources
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_13_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_13">
<span class="md-nav__icon md-icon"></span>
Resources
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cai_faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../cai_find_us/" class="md-nav__link">
<span class="md-ellipsis">
Find Us
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../cai_citation_and_acknowledgments/" class="md-nav__link">
<span class="md-ellipsis">
Citation & Acknowledgments
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#overview" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#when-to-use-mobile-ui-vs-tui-vs-cli" class="md-nav__link">
<span class="md-ellipsis">
When to Use Mobile UI vs TUI vs CLI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#quick-start" class="md-nav__link">
<span class="md-ellipsis">
Quick Start
</span>
</a>
<nav class="md-nav" aria-label="Quick Start">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-install-the-app" class="md-nav__link">
<span class="md-ellipsis">
1. Install the App
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-connect-to-your-cai-server" class="md-nav__link">
<span class="md-ellipsis">
2. Connect to Your CAI Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-start-using-cai" class="md-nav__link">
<span class="md-ellipsis">
3. Start Using CAI
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#system-requirements" class="md-nav__link">
<span class="md-ellipsis">
System Requirements
</span>
</a>
<nav class="md-nav" aria-label="System Requirements">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#device-requirements" class="md-nav__link">
<span class="md-ellipsis">
Device Requirements
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#server-requirements" class="md-nav__link">
<span class="md-ellipsis">
Server Requirements
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#key-features" class="md-nav__link">
<span class="md-ellipsis">
Key Features
</span>
</a>
<nav class="md-nav" aria-label="Key Features">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#native-ios-interface" class="md-nav__link">
<span class="md-ellipsis">
📱 Native iOS Interface
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#advanced-chat-interface" class="md-nav__link">
<span class="md-ellipsis">
💬 Advanced Chat Interface
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#network-discovery-mcp" class="md-nav__link">
<span class="md-ellipsis">
🌐 Network Discovery &amp; MCP
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#agent-management" class="md-nav__link">
<span class="md-ellipsis">
🎯 Agent Management
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#session-management" class="md-nav__link">
<span class="md-ellipsis">
📊 Session Management
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentation-structure" class="md-nav__link">
<span class="md-ellipsis">
Documentation Structure
</span>
</a>
<nav class="md-nav" aria-label="Documentation Structure">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#for-new-users" class="md-nav__link">
<span class="md-ellipsis">
For New Users
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-regular-users" class="md-nav__link">
<span class="md-ellipsis">
For Regular Users
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-advanced-users" class="md-nav__link">
<span class="md-ellipsis">
For Advanced Users
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#support-resources" class="md-nav__link">
<span class="md-ellipsis">
Support Resources
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#quick-reference" class="md-nav__link">
<span class="md-ellipsis">
Quick Reference
</span>
</a>
<nav class="md-nav" aria-label="Quick Reference">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#essential-gestures" class="md-nav__link">
<span class="md-ellipsis">
Essential Gestures
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#common-actions" class="md-nav__link">
<span class="md-ellipsis">
Common Actions
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#architecture" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#video-demo" class="md-nav__link">
<span class="md-ellipsis">
Video Demo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#community-and-support" class="md-nav__link">
<span class="md-ellipsis">
Community and Support
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#whats-next" class="md-nav__link">
<span class="md-ellipsis">
What's Next?
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="cai-mobile-user-interface-mobile-ui">CAI Mobile User Interface (Mobile UI)</h1>
<blockquote>
<p><strong>⚡ CAI-Pro Exclusive Feature</strong><br />
The Mobile User Interface (Mobile UI) is available exclusively in <strong>CAI-Pro</strong>. Experience the power of CAI on your iOS device.<br />
<strong><a href="https://testflight.apple.com/join/nXZZD4Z5">Join the TestFlight Beta</a></strong> to get early access to the CAI mobile app.</p>
</blockquote>
<hr />
<p>The CAI Mobile UI brings the full power of CAI to iOS devices, providing a native mobile experience for cybersecurity professionals who need to perform security assessments, respond to incidents, and manage agents on the go.</p>
<p><img alt="CAI Mobile UI Login" src="../../media/MUI/cai_app_ios_login.png" /></p>
<h2 id="overview">Overview</h2>
<p>The Mobile UI is a native iOS application built with SwiftUI, offering:</p>
<ul>
<li><strong>📱 Native iOS Experience</strong>: Optimized for iPhone and iPad with familiar iOS interactions</li>
<li><strong>🔒 Secure Authentication</strong>: Direct pairing with your CAI API server</li>
<li><strong>💬 Real-Time Chat</strong>: Stream responses from multiple agents with native performance</li>
<li><strong>🌐 Network Discovery</strong>: Automatically discover CAI servers on your local network</li>
<li><strong>🛠️ MCP Integration</strong>: Connect to Model Context Protocol tools directly from mobile</li>
<li><strong>🎨 Professional UI</strong>: Custom Alias theme with dark mode support</li>
<li><strong>⚡ Offline Capability</strong>: Continue reading conversations without connectivity</li>
</ul>
<h2 id="when-to-use-mobile-ui-vs-tui-vs-cli">When to Use Mobile UI vs TUI vs CLI</h2>
<table>
<thead>
<tr>
<th>Feature</th>
<th>Mobile UI</th>
<th>TUI</th>
<th>CLI</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Mobility</strong></td>
<td>✅ Full mobile access</td>
<td>❌ Desktop only</td>
<td>❌ Desktop only</td>
</tr>
<tr>
<td><strong>Touch Interface</strong></td>
<td>✅ Native touch/gesture</td>
<td>❌ Keyboard only</td>
<td>❌ Keyboard only</td>
</tr>
<tr>
<td><strong>Visual Experience</strong></td>
<td>✅ Native iOS UI</td>
<td>✅ Rich terminal UI</td>
<td>⚠️ Basic text</td>
</tr>
<tr>
<td><strong>Multi-Agent</strong></td>
<td>✅ Tab-based switching</td>
<td>✅ Split-screen</td>
<td>❌ Sequential</td>
</tr>
<tr>
<td><strong>Network Scanning</strong></td>
<td>✅ Built-in discovery</td>
<td>❌ Manual config</td>
<td>❌ Manual config</td>
</tr>
<tr>
<td><strong>Session Portability</strong></td>
<td>✅ Sync across devices</td>
<td>⚠️ Local only</td>
<td>⚠️ Local only</td>
</tr>
<tr>
<td><strong>Resource Usage</strong></td>
<td>✅ Optimized for mobile</td>
<td>⚠️ Higher (UI)</td>
<td>✅ Minimal</td>
</tr>
<tr>
<td><strong>Automation</strong></td>
<td>❌ Interactive only</td>
<td>❌ Interactive only</td>
<td>✅ Full scripting</td>
</tr>
</tbody>
</table>
<p><strong>Use Mobile UI for</strong>: On-the-go security testing, incident response, remote agent management, field assessments</p>
<p><strong>Use TUI for</strong>: Desktop-based interactive testing, multi-agent workflows, team collaboration</p>
<p><strong>Use CLI for</strong>: Automation, CI/CD integration, scripting, server deployments</p>
<h2 id="quick-start">Quick Start</h2>
<h3 id="1-install-the-app">1. Install the App</h3>
<ol>
<li><strong>Join TestFlight Beta</strong>: <a href="https://testflight.apple.com/join/nXZZD4Z5">https://testflight.apple.com/join/nXZZD4Z5</a></li>
<li>Install TestFlight from the App Store if not already installed</li>
<li>Follow the link to install CAI Mobile UI</li>
<li>Launch the app</li>
</ol>
<h3 id="2-connect-to-your-cai-server">2. Connect to Your CAI Server</h3>
<p><img alt="CAI Mobile UI Chat" src="../../media/MUI/cai_app_ios_chat.png" /></p>
<p><strong>Option A: Network Discovery</strong>
1. Ensure your iOS device is on the same network as your CAI API server
2. Tap "Scan Network" on the login screen
3. Select your server from the discovered list
4. Enter your API key</p>
<p><strong>Option B: Manual Connection</strong>
1. Enter your CAI API server URL (e.g., <code>http://192.168.1.100:8000</code>)
2. Enter your API key
3. Tap "Connect"</p>
<h3 id="3-start-using-cai">3. Start Using CAI</h3>
<ol>
<li>Select an agent from the agent selector</li>
<li>Choose your preferred model (recommended: <code>alias1</code>)</li>
<li>Type your security query or command</li>
<li>Swipe between conversations using tabs</li>
</ol>
<p>See the <a href="../getting_started/">Getting Started Guide</a> for detailed setup instructions.</p>
<h2 id="system-requirements">System Requirements</h2>
<h3 id="device-requirements">Device Requirements</h3>
<ul>
<li><strong>iOS Version</strong>: 15.0 or later</li>
<li><strong>Device</strong>: iPhone 12 or newer, iPad (6th generation) or newer</li>
<li><strong>Storage</strong>: 100MB free space</li>
<li><strong>Network</strong>: Wi-Fi or cellular data connection</li>
</ul>
<h3 id="server-requirements">Server Requirements</h3>
<ul>
<li><strong>CAI API Server</strong>: v0.7.0 or later</li>
<li><strong>API Key</strong>: Valid <code>ALIAS_API_KEY</code> from <a href="https://aliasrobotics.com">Alias Robotics</a></li>
<li><strong>Network</strong>: Server must be accessible from your iOS device</li>
</ul>
<h2 id="key-features">Key Features</h2>
<h3 id="native-ios-interface">📱 Native iOS Interface</h3>
<p>Experience CAI with a truly native iOS experience:</p>
<p><img alt="CAI Mobile UI Reasoning" src="../../media/MUI/cai_app_ios_reasoning.png" /></p>
<ul>
<li><strong>Intuitive Navigation</strong>: Swipe gestures, pull-to-refresh, and familiar iOS patterns</li>
<li><strong>Dark Mode</strong>: Automatic adaptation to system appearance</li>
<li><strong>Dynamic Type</strong>: Support for accessibility text sizes</li>
<li><strong>Haptic Feedback</strong>: Subtle feedback for important actions</li>
<li><strong>Face ID/Touch ID</strong>: Secure your sessions with biometric authentication</li>
</ul>
<h3 id="advanced-chat-interface">💬 Advanced Chat Interface</h3>
<p>Interact with agents using a sophisticated chat system:</p>
<ul>
<li><strong>Real-time Streaming</strong>: See responses as they're generated</li>
<li><strong>Rich Formatting</strong>: Markdown rendering with syntax highlighting</li>
<li><strong>Code Blocks</strong>: Copy code snippets with one tap</li>
<li><strong>Message Actions</strong>: Long-press for copy, share, or save</li>
<li><strong>Conversation History</strong>: Persistent storage with search</li>
</ul>
<h3 id="network-discovery-mcp">🌐 Network Discovery &amp; MCP</h3>
<p>Connect to your infrastructure seamlessly:</p>
<ul>
<li><strong>Auto-Discovery</strong>: Find CAI servers on your local network</li>
<li><strong>MCP Tools</strong>: Access filesystem, git, and custom tools</li>
<li><strong>Server Profiles</strong>: Save multiple server configurations</li>
<li><strong>Connection Status</strong>: Real-time server health monitoring</li>
</ul>
<h3 id="agent-management">🎯 Agent Management</h3>
<p>Access the full power of CAI agents:</p>
<ul>
<li><strong>Quick Switching</strong>: Swipe or tap to change agents</li>
<li><strong>Agent Info</strong>: View capabilities and documentation</li>
<li><strong>Favorites</strong>: Star frequently used agents</li>
<li><strong>Context Preservation</strong>: Maintain state across sessions</li>
</ul>
<h3 id="session-management">📊 Session Management</h3>
<p>Keep track of your work:</p>
<ul>
<li><strong>Session History</strong>: Browse past conversations</li>
<li><strong>Export Options</strong>: Share as text, JSON, or PDF</li>
<li><strong>Cost Tracking</strong>: Monitor token usage and costs</li>
<li><strong>Analytics</strong>: View usage patterns and insights</li>
</ul>
<h2 id="documentation-structure">Documentation Structure</h2>
<h3 id="for-new-users">For New Users</h3>
<ol>
<li><a href="../getting_started/">Getting Started</a> - Installation and first steps</li>
<li><a href="../user_interface/">User Interface</a> - Understanding the mobile layout</li>
<li><a href="../gestures_shortcuts/">Gestures &amp; Shortcuts</a> - Essential interactions</li>
</ol>
<h3 id="for-regular-users">For Regular Users</h3>
<ol>
<li><a href="../chat_features/">Chat Features</a> - Advanced messaging capabilities</li>
<li><a href="agent_selection.md">Agent Selection</a> - Choosing and managing agents</li>
<li><a href="network_mcp.md">Network &amp; MCP</a> - Connectivity and tools</li>
</ol>
<h3 id="for-advanced-users">For Advanced Users</h3>
<ol>
<li><a href="session_management.md">Session Management</a> - History and exports</li>
<li><a href="security_features.md">Security Features</a> - Authentication and privacy</li>
<li><a href="advanced_settings.md">Advanced Settings</a> - Customization options</li>
</ol>
<h3 id="support-resources">Support Resources</h3>
<ol>
<li><a href="troubleshooting.md">Troubleshooting</a> - Common issues and solutions</li>
<li><a href="faq.md">FAQ</a> - Frequently asked questions</li>
</ol>
<h2 id="quick-reference">Quick Reference</h2>
<h3 id="essential-gestures">Essential Gestures</h3>
<table>
<thead>
<tr>
<th>Gesture</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td>Swipe Right</td>
<td>Previous conversation</td>
</tr>
<tr>
<td>Swipe Left</td>
<td>Next conversation</td>
</tr>
<tr>
<td>Pull Down</td>
<td>Refresh/Cancel</td>
</tr>
<tr>
<td>Long Press Message</td>
<td>Show actions</td>
</tr>
<tr>
<td>Double Tap Code</td>
<td>Copy to clipboard</td>
</tr>
<tr>
<td>Pinch</td>
<td>Zoom text size</td>
</tr>
</tbody>
</table>
<h3 id="common-actions">Common Actions</h3>
<table>
<thead>
<tr>
<th>Action</th>
<th>How To</th>
</tr>
</thead>
<tbody>
<tr>
<td>Change Agent</td>
<td>Tap agent name in header</td>
</tr>
<tr>
<td>Switch Model</td>
<td>Tap model dropdown</td>
</tr>
<tr>
<td>New Chat</td>
<td>Tap + button</td>
</tr>
<tr>
<td>View History</td>
<td>Tap clock icon</td>
</tr>
<tr>
<td>Export Chat</td>
<td>Long press → Share</td>
</tr>
<tr>
<td>Cancel Generation</td>
<td>Pull down during response</td>
</tr>
</tbody>
</table>
<h2 id="architecture">Architecture</h2>
<div class="language-text highlight"><pre><span></span><code><span id="__span-0-1">CAI Mobile UI
</span><span id="__span-0-2">├── Core Components
</span><span id="__span-0-3">│ ├── CAIAPIClient - Server communication
</span><span id="__span-0-4">│ ├── AuthManager - Authentication &amp; pairing
</span><span id="__span-0-5">│ └── SessionStore - Local data persistence
</span><span id="__span-0-6">├── UI Components
</span><span id="__span-0-7">│ ├── ChatView - Main conversation interface
</span><span id="__span-0-8">│ ├── AgentSelector - Agent browsing &amp; selection
</span><span id="__span-0-9">│ ├── NetworkScanner - Local network discovery
</span><span id="__span-0-10">│ └── SettingsView - Configuration management
</span><span id="__span-0-11">├── MCP Integration
</span><span id="__span-0-12">│ ├── MCPServer - Tool protocol handling
</span><span id="__span-0-13">│ ├── MCPNetworkStore - Tool discovery
</span><span id="__span-0-14">│ └── MCPToolsView - Tool management UI
</span><span id="__span-0-15">└── Services
</span><span id="__span-0-16"> ├── ChatLogStore - Conversation storage
</span><span id="__span-0-17"> ├── KeychainHelper - Secure credential storage
</span><span id="__span-0-18"> └── LocalNetworkInfo - Network utilities
</span></code></pre></div>
<h2 id="video-demo">Video Demo</h2>
<p>Watch CAI Mobile UI in action:</p>
<p><a href="../../media/MUI/cai_app_0.7_apple_hd.mp4">View Demo Video</a></p>
<h2 id="community-and-support">Community and Support</h2>
<ul>
<li><strong>TestFlight Beta</strong>: <a href="https://testflight.apple.com/join/nXZZD4Z5">Join Now</a></li>
<li><strong>Documentation</strong>: <a href="https://docs.aliasrobotics.com">https://docs.aliasrobotics.com</a></li>
<li><strong>GitHub Issues</strong>: <a href="https://github.com/aliasrobotics/cai/issues">Report iOS App Issues</a></li>
<li><strong>Discord</strong>: <a href="https://discord.gg/aliasrobotics">Join our community</a></li>
<li><strong>Twitter</strong>: <a href="https://twitter.com/aliasrobotics">@aliasrobotics</a></li>
</ul>
<h2 id="whats-next">What's Next?</h2>
<ul>
<li>📱 <a href="../getting_started/">Getting Started Guide</a> - Set up your first mobile session</li>
<li>🎯 <a href="../user_interface/">User Interface</a> - Master the mobile layout</li>
<li>👆 <a href="../gestures_shortcuts/">Gestures &amp; Shortcuts</a> - Navigate like a pro</li>
<li>💬 <a href="../chat_features/">Chat Features</a> - Advanced conversation tools</li>
<li>🌐 <a href="network_mcp.md">Network &amp; MCP</a> - Connect to your infrastructure</li>
</ul>
<hr />
<blockquote>
<p><strong>Note</strong>: The Terminal User Interface (TUI) is now deprecated in favor of the Mobile UI for CAI-Pro users. While the TUI remains functional for existing users, all new development and features are being added to the Mobile UI. We encourage all CAI-Pro users to transition to the mobile experience for the best performance and latest capabilities.</p>
</blockquote>
<hr />
<p><em>CAI Mobile UI v0.7.0+ | Exclusively for CAI-Pro</em></p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "content.code.select", "navigation.path", "navigation.sections", "navigation.expand", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.f8cc74c7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.c8b220af.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink