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

3939 lines
78 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="../tui_index/">
<link rel="next" href="../user_interface/">
<link rel="icon" href="../../assets/imago.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
<title>Getting Started - 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="#getting-started-with-cai-tui" 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">
Getting Started
</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--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<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="false">
<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">
<a href="../../mui/mui_index/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../mui/getting_started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../mui/user_interface/" class="md-nav__link">
<span class="md-ellipsis">
User Interface
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../mui/gestures_shortcuts/" class="md-nav__link">
<span class="md-ellipsis">
Gestures & Shortcuts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../mui/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--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" checked>
<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="true">
<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_index/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<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">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Getting Started
</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="#prerequisites" class="md-nav__link">
<span class="md-ellipsis">
Prerequisites
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-1-launch-the-tui" class="md-nav__link">
<span class="md-ellipsis">
Step 1: Launch the TUI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-2-configure-your-api-key" class="md-nav__link">
<span class="md-ellipsis">
Step 2: Configure Your API Key
</span>
</a>
<nav class="md-nav" aria-label="Step 2: Configure Your API Key">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#alternative-using-environment-variables" class="md-nav__link">
<span class="md-ellipsis">
Alternative: Using Environment Variables
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#step-3-select-your-model" class="md-nav__link">
<span class="md-ellipsis">
Step 3: Select Your Model
</span>
</a>
<nav class="md-nav" aria-label="Step 3: Select Your Model">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#option-1-using-the-dropdown-recommended" class="md-nav__link">
<span class="md-ellipsis">
Option 1: Using the Dropdown (Recommended)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#option-2-using-a-command" class="md-nav__link">
<span class="md-ellipsis">
Option 2: Using a Command
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#available-models" class="md-nav__link">
<span class="md-ellipsis">
Available Models
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#step-4-choose-your-agent" class="md-nav__link">
<span class="md-ellipsis">
Step 4: Choose Your Agent
</span>
</a>
<nav class="md-nav" aria-label="Step 4: Choose Your Agent">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#option-1-use-the-agent-recommendation-system" class="md-nav__link">
<span class="md-ellipsis">
Option 1: Use the Agent Recommendation System
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#option-2-choose-directly-from-the-dropdown" class="md-nav__link">
<span class="md-ellipsis">
Option 2: Choose Directly from the Dropdown
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#option-3-list-all-agents" class="md-nav__link">
<span class="md-ellipsis">
Option 3: List All Agents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#common-agent-types" class="md-nav__link">
<span class="md-ellipsis">
Common Agent Types
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#step-5-start-your-first-conversation" class="md-nav__link">
<span class="md-ellipsis">
Step 5: Start Your First Conversation
</span>
</a>
<nav class="md-nav" aria-label="Step 5: Start Your First Conversation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#example-1-basic-reconnaissance" class="md-nav__link">
<span class="md-ellipsis">
Example 1: Basic Reconnaissance
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-2-web-application-testing" class="md-nav__link">
<span class="md-ellipsis">
Example 2: Web Application Testing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-3-network-analysis" class="md-nav__link">
<span class="md-ellipsis">
Example 3: Network Analysis
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#understanding-the-output" class="md-nav__link">
<span class="md-ellipsis">
Understanding the Output
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#queuing-prompts" class="md-nav__link">
<span class="md-ellipsis">
Queuing Prompts
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#step-6-working-with-multiple-terminals" class="md-nav__link">
<span class="md-ellipsis">
Step 6: Working with Multiple Terminals
</span>
</a>
<nav class="md-nav" aria-label="Step 6: Working with Multiple Terminals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#adding-a-new-terminal" class="md-nav__link">
<span class="md-ellipsis">
Adding a New Terminal
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#navigating-between-terminals" class="md-nav__link">
<span class="md-ellipsis">
Navigating Between Terminals
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-workflow-dual-perspective-analysis" class="md-nav__link">
<span class="md-ellipsis">
Example Workflow: Dual-Perspective Analysis
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#step-7-using-preconfigured-teams" class="md-nav__link">
<span class="md-ellipsis">
Step 7: Using Preconfigured Teams
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-8-saving-your-work" class="md-nav__link">
<span class="md-ellipsis">
Step 8: Saving Your Work
</span>
</a>
<nav class="md-nav" aria-label="Step 8: Saving Your Work">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#loading-a-saved-session" class="md-nav__link">
<span class="md-ellipsis">
Loading a Saved Session
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#step-9-monitoring-costs" class="md-nav__link">
<span class="md-ellipsis">
Step 9: Monitoring Costs
</span>
</a>
<nav class="md-nav" aria-label="Step 9: Monitoring Costs">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#view-costs-for-current-agent" class="md-nav__link">
<span class="md-ellipsis">
View Costs for Current Agent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#check-stats-in-sidebar" class="md-nav__link">
<span class="md-ellipsis">
Check Stats in Sidebar
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#common-first-time-issues" class="md-nav__link">
<span class="md-ellipsis">
Common First-Time Issues
</span>
</a>
<nav class="md-nav" aria-label="Common First-Time Issues">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#issue-agent-is-not-responding" class="md-nav__link">
<span class="md-ellipsis">
Issue: Agent is not responding
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#issue-terminal-output-is-cluttered" class="md-nav__link">
<span class="md-ellipsis">
Issue: Terminal output is cluttered
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#issue-i-cant-see-the-full-interface" class="md-nav__link">
<span class="md-ellipsis">
Issue: I can't see the full interface
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#next-steps" class="md-nav__link">
<span class="md-ellipsis">
Next Steps
</span>
</a>
<nav class="md-nav" aria-label="Next Steps">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#learn-more-commands" class="md-nav__link">
<span class="md-ellipsis">
Learn More Commands
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#explore-advanced-features" class="md-nav__link">
<span class="md-ellipsis">
Explore Advanced Features
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-help" class="md-nav__link">
<span class="md-ellipsis">
Get Help
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</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="../terminals_management/" class="md-nav__link">
<span class="md-ellipsis">
Terminals Management
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../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="../sidebar_features/" class="md-nav__link">
<span class="md-ellipsis">
Sidebar Features
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../keyboard_shortcuts/" class="md-nav__link">
<span class="md-ellipsis">
Keyboard Shortcuts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../commands_reference/" class="md-nav__link">
<span class="md-ellipsis">
Commands Reference
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../advanced_features/" class="md-nav__link">
<span class="md-ellipsis">
Advanced Features
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../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="#prerequisites" class="md-nav__link">
<span class="md-ellipsis">
Prerequisites
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-1-launch-the-tui" class="md-nav__link">
<span class="md-ellipsis">
Step 1: Launch the TUI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-2-configure-your-api-key" class="md-nav__link">
<span class="md-ellipsis">
Step 2: Configure Your API Key
</span>
</a>
<nav class="md-nav" aria-label="Step 2: Configure Your API Key">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#alternative-using-environment-variables" class="md-nav__link">
<span class="md-ellipsis">
Alternative: Using Environment Variables
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#step-3-select-your-model" class="md-nav__link">
<span class="md-ellipsis">
Step 3: Select Your Model
</span>
</a>
<nav class="md-nav" aria-label="Step 3: Select Your Model">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#option-1-using-the-dropdown-recommended" class="md-nav__link">
<span class="md-ellipsis">
Option 1: Using the Dropdown (Recommended)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#option-2-using-a-command" class="md-nav__link">
<span class="md-ellipsis">
Option 2: Using a Command
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#available-models" class="md-nav__link">
<span class="md-ellipsis">
Available Models
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#step-4-choose-your-agent" class="md-nav__link">
<span class="md-ellipsis">
Step 4: Choose Your Agent
</span>
</a>
<nav class="md-nav" aria-label="Step 4: Choose Your Agent">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#option-1-use-the-agent-recommendation-system" class="md-nav__link">
<span class="md-ellipsis">
Option 1: Use the Agent Recommendation System
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#option-2-choose-directly-from-the-dropdown" class="md-nav__link">
<span class="md-ellipsis">
Option 2: Choose Directly from the Dropdown
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#option-3-list-all-agents" class="md-nav__link">
<span class="md-ellipsis">
Option 3: List All Agents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#common-agent-types" class="md-nav__link">
<span class="md-ellipsis">
Common Agent Types
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#step-5-start-your-first-conversation" class="md-nav__link">
<span class="md-ellipsis">
Step 5: Start Your First Conversation
</span>
</a>
<nav class="md-nav" aria-label="Step 5: Start Your First Conversation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#example-1-basic-reconnaissance" class="md-nav__link">
<span class="md-ellipsis">
Example 1: Basic Reconnaissance
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-2-web-application-testing" class="md-nav__link">
<span class="md-ellipsis">
Example 2: Web Application Testing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-3-network-analysis" class="md-nav__link">
<span class="md-ellipsis">
Example 3: Network Analysis
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#understanding-the-output" class="md-nav__link">
<span class="md-ellipsis">
Understanding the Output
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#queuing-prompts" class="md-nav__link">
<span class="md-ellipsis">
Queuing Prompts
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#step-6-working-with-multiple-terminals" class="md-nav__link">
<span class="md-ellipsis">
Step 6: Working with Multiple Terminals
</span>
</a>
<nav class="md-nav" aria-label="Step 6: Working with Multiple Terminals">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#adding-a-new-terminal" class="md-nav__link">
<span class="md-ellipsis">
Adding a New Terminal
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#navigating-between-terminals" class="md-nav__link">
<span class="md-ellipsis">
Navigating Between Terminals
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-workflow-dual-perspective-analysis" class="md-nav__link">
<span class="md-ellipsis">
Example Workflow: Dual-Perspective Analysis
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#step-7-using-preconfigured-teams" class="md-nav__link">
<span class="md-ellipsis">
Step 7: Using Preconfigured Teams
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-8-saving-your-work" class="md-nav__link">
<span class="md-ellipsis">
Step 8: Saving Your Work
</span>
</a>
<nav class="md-nav" aria-label="Step 8: Saving Your Work">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#loading-a-saved-session" class="md-nav__link">
<span class="md-ellipsis">
Loading a Saved Session
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#step-9-monitoring-costs" class="md-nav__link">
<span class="md-ellipsis">
Step 9: Monitoring Costs
</span>
</a>
<nav class="md-nav" aria-label="Step 9: Monitoring Costs">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#view-costs-for-current-agent" class="md-nav__link">
<span class="md-ellipsis">
View Costs for Current Agent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#check-stats-in-sidebar" class="md-nav__link">
<span class="md-ellipsis">
Check Stats in Sidebar
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#common-first-time-issues" class="md-nav__link">
<span class="md-ellipsis">
Common First-Time Issues
</span>
</a>
<nav class="md-nav" aria-label="Common First-Time Issues">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#issue-agent-is-not-responding" class="md-nav__link">
<span class="md-ellipsis">
Issue: Agent is not responding
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#issue-terminal-output-is-cluttered" class="md-nav__link">
<span class="md-ellipsis">
Issue: Terminal output is cluttered
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#issue-i-cant-see-the-full-interface" class="md-nav__link">
<span class="md-ellipsis">
Issue: I can't see the full interface
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#next-steps" class="md-nav__link">
<span class="md-ellipsis">
Next Steps
</span>
</a>
<nav class="md-nav" aria-label="Next Steps">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#learn-more-commands" class="md-nav__link">
<span class="md-ellipsis">
Learn More Commands
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#explore-advanced-features" class="md-nav__link">
<span class="md-ellipsis">
Explore Advanced Features
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-help" class="md-nav__link">
<span class="md-ellipsis">
Get Help
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="getting-started-with-cai-tui">Getting Started with CAI TUI</h1>
<blockquote>
<p><strong>⚡ CAI-Pro Exclusive Feature</strong><br />
The Terminal User Interface (TUI) is available exclusively in <strong>CAI-Pro</strong>. To access this feature and unlock advanced multi-agent workflows, visit <a href="https://aliasrobotics.com/cybersecurityai.php">Alias Robotics</a> for more information.</p>
</blockquote>
<hr />
<p>This guide will walk you through launching the CAI TUI for the first time and performing your first security assessment.</p>
<h2 id="prerequisites">Prerequisites</h2>
<p>Before starting, ensure you have:</p>
<ul>
<li>✅ CAI installed (see <a href="../Installation_Guide_for_CAI_Pro_v0.6.md">Installation Guide</a>)</li>
<li>✅ Python 3.9+ installed</li>
<li>✅ A valid <code>ALIAS_API_KEY</code> from <a href="https://aliasrobotics.com">Alias Robotics</a></li>
</ul>
<h2 id="step-1-launch-the-tui">Step 1: Launch the TUI</h2>
<p>Open your terminal and run:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1">cai<span class="w"> </span>--tui
</span></code></pre></div>
<p>If your <code>ALIAS_API_KEY</code> is not configured, you'll see an authentication error. Don't worry—we'll fix this in the next step.</p>
<h2 id="step-2-configure-your-api-key">Step 2: Configure Your API Key</h2>
<p>The first time you use CAI TUI, you need to configure your API key:</p>
<ol>
<li><strong>Open the Sidebar</strong></li>
<li>
<p>Press <code>Ctrl+S</code> to toggle the sidebar (if not already visible)</p>
</li>
<li>
<p><strong>Navigate to Keys Tab</strong></p>
</li>
<li>Click on the <strong>"Keys"</strong> tab in the sidebar</li>
<li>
<p>This shows all configured API keys</p>
</li>
<li>
<p><strong>Add Your API Key</strong></p>
</li>
<li>Click the <strong>"Add New Key"</strong> button</li>
<li>
<p>A dialog will appear with two fields:</p>
<ul>
<li><strong>Key Name</strong>: Enter <code>ALIAS_API_KEY</code></li>
<li><strong>Key Value</strong>: Enter your API key (e.g., <code>ak_live_1234567890abcdef</code>)</li>
</ul>
</li>
<li>
<p><strong>Save the Key</strong></p>
</li>
<li>Click the <strong>"Save"</strong> button</li>
<li>Your key is now securely stored in <code>~/.cai/.env</code></li>
</ol>
<h3 id="alternative-using-environment-variables">Alternative: Using Environment Variables</h3>
<p>You can also set your API key via environment variable:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><span class="nb">export</span><span class="w"> </span><span class="nv">ALIAS_API_KEY</span><span class="o">=</span><span class="s2">&quot;your_api_key_here&quot;</span>
</span><span id="__span-1-2">cai<span class="w"> </span>--tui
</span></code></pre></div>
<p>Or create a <code>.env</code> file in your project directory:</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-2-1">ALIAS_API_KEY=your_api_key_here
</span></code></pre></div>
<h2 id="step-3-select-your-model">Step 3: Select Your Model</h2>
<p>CAI supports multiple AI models. For optimal performance and cost balance, we recommend <code>alias1</code>:</p>
<h3 id="option-1-using-the-dropdown-recommended">Option 1: Using the Dropdown (Recommended)</h3>
<ol>
<li>Look at the terminal header (top bar of each terminal)</li>
<li>Find the <strong>"model"</strong> dropdown (center-right area)</li>
<li>Click on it to see available models</li>
<li>Select <strong><code>alias1</code></strong></li>
</ol>
<h3 id="option-2-using-a-command">Option 2: Using a Command</h3>
<p>Type in the input field at the bottom:</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-3-1">/model alias1
</span></code></pre></div>
<p>Press <strong>Enter</strong>.</p>
<h3 id="available-models">Available Models</h3>
<table>
<thead>
<tr>
<th>Model</th>
<th>Provider</th>
<th>Best For</th>
<th>Cost</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>alias1</code></td>
<td>Alias Robotics</td>
<td><strong>Recommended</strong> - Balanced performance</td>
<td>Medium</td>
</tr>
<tr>
<td><code>gpt-5</code></td>
<td>OpenAI</td>
<td>Latest reasoning and code generation</td>
<td>Very High</td>
</tr>
<tr>
<td><code>gpt-4o</code></td>
<td>OpenAI</td>
<td>Complex reasoning and multi-modal</td>
<td>High</td>
</tr>
<tr>
<td><code>claude-4-5</code></td>
<td>Anthropic</td>
<td>Advanced reasoning and long contexts</td>
<td>Very High</td>
</tr>
<tr>
<td><code>claude-3-5-sonnet-20241022</code></td>
<td>Anthropic</td>
<td>Fast responses with good quality</td>
<td>High</td>
</tr>
</tbody>
</table>
<blockquote>
<p><strong>💡 Tip</strong>: You can change models at any time without losing your conversation history.</p>
</blockquote>
<h2 id="step-4-choose-your-agent">Step 4: Choose Your Agent</h2>
<p>CAI comes with specialized agents for different security tasks. Here's how to choose:</p>
<h3 id="option-1-use-the-agent-recommendation-system">Option 1: Use the Agent Recommendation System</h3>
<p>The easiest way to start:</p>
<ol>
<li>Click the <strong>agent</strong> dropdown in the terminal header</li>
<li>Select <strong><code>selection_agent</code></strong> </li>
<li>Type your task description: <code>"I need to test a web application for SQL injection"</code></li>
<li>The agent will recommend the best agent for your task</li>
</ol>
<p>Alternatively, use the command:</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-4-1">/agent selection_agent
</span></code></pre></div>
<p>Then describe your task.</p>
<h3 id="option-2-choose-directly-from-the-dropdown">Option 2: Choose Directly from the Dropdown</h3>
<p>If you know which agent you need:</p>
<ol>
<li>Click the <strong>agent</strong> dropdown</li>
<li>Browse available agents (scroll if needed)</li>
<li>Select your desired agent (e.g., <code>redteam_agent</code>, <code>bug_bounter_agent</code>)</li>
</ol>
<h3 id="option-3-list-all-agents">Option 3: List All Agents</h3>
<p>To see all available agents with descriptions:</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-5-1">/agent list
</span></code></pre></div>
<h3 id="common-agent-types">Common Agent Types</h3>
<table>
<thead>
<tr>
<th>Agent</th>
<th>Purpose</th>
<th>When to Use</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>redteam_agent</code></td>
<td>Offensive security testing</td>
<td>Default for penetration testing</td>
</tr>
<tr>
<td><code>blueteam_agent</code></td>
<td>Defensive security analysis</td>
<td>Security posture assessment</td>
</tr>
<tr>
<td><code>bug_bounter_agent</code></td>
<td>Bug bounty hunting</td>
<td>Finding high-value vulnerabilities</td>
</tr>
<tr>
<td><code>retester_agent</code></td>
<td>Vulnerability retesting</td>
<td>Confirming fixes</td>
</tr>
<tr>
<td><code>selection_agent</code></td>
<td>Agent recommendation</td>
<td><strong>When unsure which agent to use</strong></td>
</tr>
</tbody>
</table>
<blockquote>
<p><strong>💡 Pro Tip</strong>: Start with <code>selection_agent</code> if you're new to CAI—it will guide you to the right agent for your task.</p>
</blockquote>
<h2 id="step-5-start-your-first-conversation">Step 5: Start Your First Conversation</h2>
<p>Now you're ready to interact with CAI!</p>
<h3 id="example-1-basic-reconnaissance">Example 1: Basic Reconnaissance</h3>
<p>In the input field at the bottom (marked with <code>CAI&gt;</code>), type:</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-6-1">Scan 198.51.100.50 for open ports and services
</span></code></pre></div>
<p>Press <strong>Enter</strong>.</p>
<p>The agent will:
- Process your request
- Use appropriate tools (nmap, etc.)
- Display results in the terminal output area</p>
<h3 id="example-2-web-application-testing">Example 2: Web Application Testing</h3>
<p>Prompt example:</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-7-1">Test https://example.com for common web vulnerabilities
</span></code></pre></div>
<p>Press <strong>Enter</strong>.</p>
<p>The agent will:
- Process your request
- Use appropriate tools (nmap, etc.)
- Display results in the terminal output area</p>
<h3 id="example-3-network-analysis">Example 3: Network Analysis</h3>
<p>Prompt example:</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-8-1">Analyze the network traffic from this pcap file: capture.pcap
</span></code></pre></div>
<h3 id="understanding-the-output">Understanding the Output</h3>
<p>As the agent works, you'll see:</p>
<ol>
<li><strong>Tool Execution</strong>: Messages showing which tools are being launched</li>
<li><strong>Streaming Output</strong>: Real-time results from tools</li>
<li><strong>Agent Reasoning</strong>: The agent's thought process (if <code>CAI_DEBUG=1</code>)</li>
<li><strong>Final Response</strong>: Summary and recommendations</li>
</ol>
<h3 id="queuing-prompts">Queuing Prompts</h3>
<p>If the agent is busy, you can send another prompt—it will be <strong>automatically queued</strong>:</p>
<ul>
<li>View the queue: Press <code>Ctrl+Shift+Q</code> or use <code>/queue</code></li>
<li>The next prompt will execute when the current one finishes</li>
</ul>
<h2 id="step-6-working-with-multiple-terminals">Step 6: Working with Multiple Terminals</h2>
<p>One of the TUI's most powerful features is multi-terminal support.</p>
<h3 id="adding-a-new-terminal">Adding a New Terminal</h3>
<p>Click the <strong>"Add +"</strong> button in the top of the screen</p>
<p>Each new terminal:
- Starts with <code>alias1</code> model and <code>redteam_agent</code>
- Has an independent conversation history
- Can run a different agent and model</p>
<h3 id="navigating-between-terminals">Navigating Between Terminals</h3>
<ul>
<li><strong>Next terminal</strong>: <code>Ctrl+N</code></li>
<li><strong>Previous terminal</strong>: <code>Ctrl+B</code></li>
<li><strong>Click directly</strong> on any terminal to focus it</li>
</ul>
<h3 id="example-workflow-dual-perspective-analysis">Example Workflow: Dual-Perspective Analysis</h3>
<ol>
<li><strong>Terminal 1</strong>: Keep <code>redteam_agent</code> for offensive testing</li>
<li><strong>Terminal 2</strong>: Add a new terminal, switch to <code>blueteam_agent</code></li>
<li>Send the same target to both:</li>
<li>T1: Offensive analysis</li>
<li>T2: Defensive recommendations</li>
<li>Compare results side-by-side</li>
</ol>
<h2 id="step-7-using-preconfigured-teams">Step 7: Using Preconfigured Teams</h2>
<p>For common multi-agent workflows, use <strong>Teams</strong>:</p>
<ol>
<li>Open the sidebar (<code>Ctrl+S</code>)</li>
<li>Click the <strong>"Teams"</strong> tab</li>
<li>Select a team (e.g., <strong>"#1: 2 red + 2 bug"</strong>)</li>
</ol>
<p>This will:
- Automatically open 4 terminals (or reuse existing ones)
- Assign agents according to the team configuration
- Ready to process your prompt in parallel</p>
<p><strong>Popular Teams</strong>:
- <strong>2 Red + 2 Bug</strong>: Comprehensive penetration testing + bug hunting
- <strong>2 Red + 2 Blue</strong>: Offensive + defensive analysis
- <strong>Red + Blue + Retester + Bug</strong>: Full security assessment lifecycle</p>
<p>Learn more about Teams and Parallel Execution in the full TUI documentation.</p>
<h2 id="step-8-saving-your-work">Step 8: Saving Your Work</h2>
<p>To save all agent histories:</p>
<ul>
<li><strong>JSONL</strong> (reload later with <code>/load</code>):</li>
</ul>
<div class="language-text highlight"><pre><span></span><code><span id="__span-9-1">/save my-assessment.jsonl
</span></code></pre></div>
<ul>
<li><strong>Markdown</strong> (readable report or handoff document; not for <code>/load</code>):</li>
</ul>
<div class="language-text highlight"><pre><span></span><code><span id="__span-10-1">/save my-assessment.md
</span></code></pre></div>
<p>Files are written to the path you give (relative paths use the current working directory). This is separate from <code>/memory save</code>, which stores summarized memory under <code>.cai/memory</code>.</p>
<h3 id="loading-a-saved-session">Loading a Saved Session</h3>
<p>Use a <strong><code>.jsonl</code></strong> file from <code>/save</code> (or a compatible session log):</p>
<div class="language-text highlight"><pre><span></span><code><span id="__span-11-1">/load my-assessment.jsonl
</span></code></pre></div>
<p>This merges the saved messages into the session (see <code>/help load</code> for targeting a specific agent or parallel slot).</p>
<h2 id="step-9-monitoring-costs">Step 9: Monitoring Costs</h2>
<p>CAI tracks your API usage and costs in real-time.</p>
<h3 id="view-costs-for-current-agent">View Costs for Current Agent</h3>
<div class="language-text highlight"><pre><span></span><code><span id="__span-12-1">/cost
</span></code></pre></div>
<p>This shows:
- Total tokens used (input + output)
- Estimated cost in USD
- Breakdown by interaction</p>
<h3 id="check-stats-in-sidebar">Check Stats in Sidebar</h3>
<p>Open the sidebar (<code>Ctrl+S</code>) and go to <strong>"Stats"</strong> tab to see:
- Session duration
- Total agents used
- Total cost across all terminals</p>
<h2 id="common-first-time-issues">Common First-Time Issues</h2>
<h3 id="issue-agent-is-not-responding">Issue: Agent is not responding</h3>
<p><strong>Solution</strong>:
- Press <code>Ctrl+C</code> to cancel the current agent
- Check your internet connection
- Verify your API key is valid</p>
<h3 id="issue-terminal-output-is-cluttered">Issue: Terminal output is cluttered</h3>
<p><strong>Solution</strong>:
- Clear the terminal: <code>Ctrl+L</code> or <code>/clear</code>
- Reduce debug output: Set <code>CAI_DEBUG=0</code> before launching
- Use <code>/flush</code> to clear conversation history</p>
<h3 id="issue-i-cant-see-the-full-interface">Issue: I can't see the full interface</h3>
<p><strong>Solution</strong>:
- Resize your terminal window to at least 120x40 characters
- Try full-screen mode: <code>F11</code> (on most terminals)
- Zoom out: <code>Ctrl+-</code> (on most terminals)</p>
<h2 id="next-steps">Next Steps</h2>
<p>Congratulations! You've completed the basics of CAI TUI. Here's what to explore next:</p>
<h3 id="learn-more-commands">Learn More Commands</h3>
<ul>
<li>📖 <a href="../commands_reference/">Commands Reference</a> - Master all available commands</li>
<li>⌨️ <a href="../keyboard_shortcuts/">Keyboard Shortcuts</a> - Speed up your workflow</li>
</ul>
<h3 id="explore-advanced-features">Explore Advanced Features</h3>
<ul>
<li>👥 <a href="../teams_and_parallel_execution/">Teams and Parallel Execution</a> - Multi-agent workflows</li>
<li>🚀 <a href="../advanced_features/">Advanced Features</a> - MCP, ICL, and more</li>
</ul>
<h3 id="get-help">Get Help</h3>
<ul>
<li>🔧 <a href="../troubleshooting/">Troubleshooting</a> - Solve issues</li>
<li>💬 <a href="https://discord.gg/aliasrobotics">Community Discord</a> - Ask questions</li>
</ul>
</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