mirror of https://github.com/aliasrobotics/cai.git
3783 lines
92 KiB
HTML
3783 lines
92 KiB
HTML
|
||
<!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="../guardrails/">
|
||
|
||
|
||
<link rel="next" href="../cai/getting-started/packet_capture_wsl/">
|
||
|
||
|
||
<link rel="icon" href="../assets/imago.png">
|
||
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
|
||
|
||
|
||
|
||
<title>Environment Variables - 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="#environment-variables-reference" 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">
|
||
|
||
Environment Variables
|
||
|
||
</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--active md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
|
||
|
||
|
||
<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="true">
|
||
<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 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">
|
||
Environment Variables
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<a href="./" class="md-nav__link md-nav__link--active">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Environment Variables
|
||
|
||
</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="#discovering-variables-in-the-repl" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🔎 Discovering variables in the REPL
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#complete-reference-table" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
📋 Complete Reference Table
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#quick-reference-by-use-case" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🎯 Quick Reference by Use Case
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="🎯 Quick Reference by Use Case">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#getting-started-essential" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🚀 Getting Started (Essential)
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#ctf-challenges" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🏴 CTF Challenges
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#reconnaissance-osint" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🔍 Reconnaissance & OSINT
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#compacted-memory-and-state" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🧠 Compacted memory and state
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#security-safety" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🛡️ Security & Safety
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#performance-optimization" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
⚡ Performance Optimization
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#advanced-agent-configuration" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🔧 Advanced Agent Configuration
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#container-virtualization" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🐳 Container & Virtualization
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#tui-specific-configuration" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🖥️ TUI-Specific Configuration
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#debugging-development" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🐛 Debugging & Development
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#common-configuration-examples" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
💡 Common Configuration Examples
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="💡 Common Configuration Examples">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#example-1-local-development-with-ollama" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Example 1: Local Development with Ollama
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#example-2-production-ctf-solving" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Example 2: Production CTF Solving
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#example-3-pentesting-with-cost-control" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Example 3: Pentesting with Cost Control
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#example-4-parallel-testing-non-tui" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Example 4: Parallel Testing (Non-TUI)
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#related-documentation" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
📚 Related Documentation
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#important-notes" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
⚠️ Important Notes
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="⚠️ Important Notes">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#api-keys" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
API Keys
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#setting-variables" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Setting Variables
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
|
||
</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--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="#discovering-variables-in-the-repl" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🔎 Discovering variables in the REPL
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#complete-reference-table" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
📋 Complete Reference Table
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#quick-reference-by-use-case" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🎯 Quick Reference by Use Case
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="🎯 Quick Reference by Use Case">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#getting-started-essential" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🚀 Getting Started (Essential)
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#ctf-challenges" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🏴 CTF Challenges
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#reconnaissance-osint" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🔍 Reconnaissance & OSINT
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#compacted-memory-and-state" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🧠 Compacted memory and state
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#security-safety" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🛡️ Security & Safety
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#performance-optimization" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
⚡ Performance Optimization
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#advanced-agent-configuration" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🔧 Advanced Agent Configuration
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#container-virtualization" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🐳 Container & Virtualization
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#tui-specific-configuration" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🖥️ TUI-Specific Configuration
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#debugging-development" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
🐛 Debugging & Development
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#common-configuration-examples" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
💡 Common Configuration Examples
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="💡 Common Configuration Examples">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#example-1-local-development-with-ollama" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Example 1: Local Development with Ollama
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#example-2-production-ctf-solving" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Example 2: Production CTF Solving
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#example-3-pentesting-with-cost-control" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Example 3: Pentesting with Cost Control
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#example-4-parallel-testing-non-tui" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Example 4: Parallel Testing (Non-TUI)
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#related-documentation" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
📚 Related Documentation
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#important-notes" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
⚠️ Important Notes
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="⚠️ Important Notes">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#api-keys" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
API Keys
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#setting-variables" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Setting Variables
|
||
</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="environment-variables-reference">Environment Variables Reference</h1>
|
||
<p>This comprehensive guide documents all environment variables available in CAI, including their purposes, default values, and usage examples.</p>
|
||
<hr />
|
||
<h2 id="discovering-variables-in-the-repl">🔎 Discovering variables in the REPL</h2>
|
||
<p>In current CAI releases, you can explore environment variables <strong>from inside the interactive CLI</strong> without leaving the session:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>What you need</th>
|
||
<th>Command</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>Numbered list with live values</strong> (what is set <em>now</em>)</td>
|
||
<td><code>/env</code> or <code>/env list</code> for extended list of variables</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>Full reference tables</strong> (defaults, allowed values, when they apply, extras)</td>
|
||
<td><code>/help</code> — scroll past the quick guide to the tables (<code>/help topics</code> lists commands by category only, no env tables)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>Long-form help for one variable</strong> (examples, <code>/env list</code> index when listed, notes)</td>
|
||
<td><code>/help var VARIABLE_NAME</code> (e.g. <code>/help var CAI_MODEL</code>)</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Aliases such as <code>/h</code> for <code>/help</code> work the same way. This page remains the <strong>canonical web reference</strong>; the REPL output tracks the version you have installed.</p>
|
||
<hr />
|
||
<h2 id="complete-reference-table">📋 Complete Reference Table</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Variable</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>CTF_NAME</td>
|
||
<td>Name of the CTF challenge to run (e.g. "picoctf_static_flag")</td>
|
||
<td>-</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CTF_CHALLENGE</td>
|
||
<td>Specific challenge name within the CTF to test</td>
|
||
<td>-</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CTF_SUBNET</td>
|
||
<td>Network subnet for the CTF container</td>
|
||
<td>192.168.3.0/24</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CTF_IP</td>
|
||
<td>IP address for the CTF container</td>
|
||
<td>192.168.3.100</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CTF_INSIDE</td>
|
||
<td>Whether to conquer the CTF from within container</td>
|
||
<td>true</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_MODEL</td>
|
||
<td>Model to use for agents</td>
|
||
<td>alias1</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_DEBUG</td>
|
||
<td>Set debug output level (0: Only tool outputs, 1: Verbose debug output, 2: CLI debug output)</td>
|
||
<td>1</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_BRIEF</td>
|
||
<td>Enable/disable brief output mode</td>
|
||
<td>false</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_MAX_TURNS</td>
|
||
<td>Maximum number of turns for agent interactions</td>
|
||
<td>inf</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_ORCHESTRATION_WORKER_MAX_TURNS</td>
|
||
<td>Max <code>Runner</code> turns for each specialist worker spawned by <code>orchestration_agent</code> tools (<code>run_specialist</code>, <code>run_dual_approach_contest</code>, <code>run_parallel_specialists</code>). Integer 1–32</td>
|
||
<td>6</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_ORCHESTRATION_MAS_HINT</td>
|
||
<td>When <code>true</code>, <code>orchestration_agent</code> may receive one synthetic <code>user</code>-role nudge per <code>Runner</code> run if the user message looks multi-front but only <code>run_specialist</code> was invoked (suggests <code>run_parallel_specialists</code> / contest). Set <code>false</code> to disable</td>
|
||
<td>true</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_MAX_INTERACTIONS</td>
|
||
<td>Maximum number of interactions (tool calls, agent actions, etc.) allowed in a session. If exceeded, only CLI commands are allowed until increased. If force_until_flag=true, the session will exit</td>
|
||
<td>inf</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_PRICE_LIMIT</td>
|
||
<td>Price limit for the conversation in dollars. If exceeded, only CLI commands are allowed until increased. If force_until_flag=true, the session will exit</td>
|
||
<td>1</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_TRACING</td>
|
||
<td>Enable/disable OpenTelemetry tracing. When enabled, traces execution flow and agent interactions for debugging and analysis</td>
|
||
<td>true</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_AGENT_TYPE</td>
|
||
<td>Registered agent key. Defaults to <code>orchestration_agent</code> for default routing plus optional dual-approach contest; use <code>selection_agent</code> for the slimmer handoff-only router, or pin a specialist such as <code>redteam_agent</code>. Use "/agent" command in CLI to list all available agents</td>
|
||
<td>orchestration_agent</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_STATE</td>
|
||
<td>Enable/disable stateful mode. When enabled, the agent will use a state agent to keep track of the state of the network and the flags found</td>
|
||
<td>false</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_COMPACTED_MEMORY</td>
|
||
<td>When true, inject <code>/compact</code> conversation summaries into agent system prompts</td>
|
||
<td>false</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_ENV_CONTEXT</td>
|
||
<td>Add environment context, dirs and current env available</td>
|
||
<td>true</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_SUPPORT_MODEL</td>
|
||
<td>Model to use for the support agent</td>
|
||
<td>o3-mini</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_SUPPORT_INTERVAL</td>
|
||
<td>Number of turns between support agent executions</td>
|
||
<td>5</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_STREAM</td>
|
||
<td>Enable/disable streaming output for LLM inference (token-by-token display). Does NOT affect tool output streaming</td>
|
||
<td>false</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_TOOL_STREAM</td>
|
||
<td>Enable/disable streaming output for tool executions (real-time command output). Independent of CAI_STREAM</td>
|
||
<td>true</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_DEBUG_TOOLS_VIZ</td>
|
||
<td>Enable debug output for tool visualization and panel rendering. Shows detailed info about tool call display, deduplication, and streaming state</td>
|
||
<td>false</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_SHOW_CACHE</td>
|
||
<td>Show cache information and message history list. Displays prompt caching stats and the full message list sent to the model</td>
|
||
<td>false</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_TELEMETRY</td>
|
||
<td>Enable/disable telemetry</td>
|
||
<td>true</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_PARALLEL</td>
|
||
<td>Number of parallel agent instances to run. When set to values greater than 1, executes multiple instances of the same agent in parallel and displays all results</td>
|
||
<td>1</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_GUARDRAILS</td>
|
||
<td>Enable/disable security guardrails for agents. When set to "true", applies security guardrails to prevent potentially dangerous outputs and inputs</td>
|
||
<td>false</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_GCTR_NITERATIONS</td>
|
||
<td>Number of tool interactions before triggering GCTR (Generative Cut-The-Rope) analysis in bug_bounter_gctr agent. Only applies when using gctr-enabled agents</td>
|
||
<td>5</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_ACTIVE_CONTAINER</td>
|
||
<td>Docker container ID where commands should be executed. When set, shell commands and tools execute inside the specified container instead of the host. Automatically set when CTF challenges start (if CTF_INSIDE=true) or when attaching a container via <code>/virtualization</code> / <code>/virt</code> in the REPL</td>
|
||
<td>-</td>
|
||
</tr>
|
||
<tr>
|
||
<td>C99_API_KEY</td>
|
||
<td>API key for C99.nl subdomain discovery service. Required for using the C99 reconnaissance tool for DNS enumeration and subdomain discovery. Obtain from <a href="https://c99.nl">C99.nl</a></td>
|
||
<td>-</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_TOOL_TIMEOUT</td>
|
||
<td>Override the default timeout for tool command executions in seconds. When set, this value overrides all default timeouts for shell commands and tool executions</td>
|
||
<td>varies (10s for interactive, 100s for regular)</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_IDLE_TIMEOUT</td>
|
||
<td>Maximum seconds a command can produce no output before being terminated. Useful for long-running commands like nmap scans that may have gaps between output lines</td>
|
||
<td>100</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_CTX_TRUNC</td>
|
||
<td>Enable context truncation for large tool outputs. When set to "true", automatically truncates large outputs (>50k chars) to prevent context overflow. JS/HTML/CSS/JSON files get aggressive truncation with preview only. Message history also applies position-based truncation when context exceeds 100k tokens or 60% usage</td>
|
||
<td>false</td>
|
||
</tr>
|
||
<tr>
|
||
<td>CAI_DISPLAY_MAX_OUTPUT</td>
|
||
<td>Show full tool output without truncation. When set to "true", displays complete tool output regardless of length. By default (false), outputs longer than 10,000 characters are truncated showing the first 5,000 and last 5,000 characters with "... TRUNCATED ..." in between. Useful for debugging format string exploits, large command outputs, or when you need to see the complete result</td>
|
||
<td>false</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr />
|
||
<h2 id="quick-reference-by-use-case">🎯 Quick Reference by Use Case</h2>
|
||
<h3 id="getting-started-essential">🚀 Getting Started (Essential)</h3>
|
||
<p>For first-time users, these are the essential variables to configure:</p>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><span class="c1"># Required: Model selection</span>
|
||
</span><span id="__span-0-2"><span class="nv">CAI_MODEL</span><span class="o">=</span><span class="s2">"alias1"</span><span class="w"> </span><span class="c1"># or gpt-4o, claude-sonnet-4.5, ollama/qwen2.5:72b</span>
|
||
</span><span id="__span-0-3">
|
||
</span><span id="__span-0-4"><span class="c1"># Recommended: Agent type (default CLI entry is orchestration_agent)</span>
|
||
</span><span id="__span-0-5"><span class="nv">CAI_AGENT_TYPE</span><span class="o">=</span><span class="s2">"orchestration_agent"</span><span class="w"> </span><span class="c1"># breadth-first + specialist tools; selection_agent = handoffs only</span>
|
||
</span><span id="__span-0-6"><span class="c1"># CAI_ORCHESTRATION_WORKER_MAX_TURNS=6 # per-worker turn cap when using orchestration_agent tools</span>
|
||
</span><span id="__span-0-7"><span class="c1"># CAI_ORCHESTRATION_MAS_HINT=true # optional multi-front nudge for orchestration_agent</span>
|
||
</span><span id="__span-0-8"><span class="c1"># CAI_AGENT_TYPE="redteam_agent" # pin a specialist when you know the toolkit</span>
|
||
</span><span id="__span-0-9">
|
||
</span><span id="__span-0-10"><span class="c1"># Optional but useful: Cost control</span>
|
||
</span><span id="__span-0-11"><span class="nv">CAI_PRICE_LIMIT</span><span class="o">=</span><span class="s2">"1"</span><span class="w"> </span><span class="c1"># Maximum spend in dollars</span>
|
||
</span></code></pre></div>
|
||
<p><strong>Related Documentation:</strong></p>
|
||
<ul>
|
||
<li><a href="../cai/getting-started/installation/">Installation Guide</a></li>
|
||
<li><a href="../cai/getting-started/configuration/">Configuration Guide</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="ctf-challenges">🏴 CTF Challenges</h3>
|
||
<p>For running Capture The Flag challenges in containerized environments:</p>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><span class="c1"># Challenge selection</span>
|
||
</span><span id="__span-1-2"><span class="nv">CTF_NAME</span><span class="o">=</span><span class="s2">"picoctf_static_flag"</span><span class="w"> </span><span class="c1"># Name of the CTF challenge</span>
|
||
</span><span id="__span-1-3"><span class="nv">CTF_CHALLENGE</span><span class="o">=</span><span class="s2">"web_exploitation_1"</span><span class="w"> </span><span class="c1"># Specific sub-challenge</span>
|
||
</span><span id="__span-1-4">
|
||
</span><span id="__span-1-5"><span class="c1"># Network configuration</span>
|
||
</span><span id="__span-1-6"><span class="nv">CTF_SUBNET</span><span class="o">=</span><span class="s2">"192.168.3.0/24"</span><span class="w"> </span><span class="c1"># Container subnet</span>
|
||
</span><span id="__span-1-7"><span class="nv">CTF_IP</span><span class="o">=</span><span class="s2">"192.168.3.100"</span><span class="w"> </span><span class="c1"># Container IP address</span>
|
||
</span><span id="__span-1-8">
|
||
</span><span id="__span-1-9"><span class="c1"># Execution mode</span>
|
||
</span><span id="__span-1-10"><span class="nv">CTF_INSIDE</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Run agent inside container</span>
|
||
</span></code></pre></div>
|
||
<p><strong>Best Practices:</strong></p>
|
||
<ul>
|
||
<li>Set <code>CTF_INSIDE=true</code> to run the agent inside the challenge container</li>
|
||
<li>Use <code>CAI_ACTIVE_CONTAINER</code> to manually specify which container to execute commands in</li>
|
||
<li>Combine with <code>CAI_STATE=true</code> to track discovered flags</li>
|
||
</ul>
|
||
<p><strong>Related Documentation:</strong></p>
|
||
<ul>
|
||
<li><a href="../benchmarking/jeopardy_ctfs/">CTF Benchmarks</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="reconnaissance-osint">🔍 Reconnaissance & OSINT</h3>
|
||
<p>For reconnaissance tasks using external tools:</p>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-2-1"><span class="c1"># C99.nl subdomain discovery</span>
|
||
</span><span id="__span-2-2"><span class="nv">C99_API_KEY</span><span class="o">=</span><span class="s2">"your-c99-api-key"</span><span class="w"> </span><span class="c1"># Enable C99 reconnaissance tool</span>
|
||
</span><span id="__span-2-3">
|
||
</span><span id="__span-2-4"><span class="c1"># Agent configuration for recon</span>
|
||
</span><span id="__span-2-5"><span class="nv">CAI_AGENT_TYPE</span><span class="o">=</span><span class="s2">"redteam_agent"</span><span class="w"> </span><span class="c1"># Or create custom recon agent</span>
|
||
</span></code></pre></div>
|
||
<p><strong>Reconnaissance Tools:</strong></p>
|
||
<ul>
|
||
<li><strong>C99 Tool</strong>: Subdomain discovery and DNS enumeration via C99.nl API</li>
|
||
<li>Configure <code>C99_API_KEY</code> to enable the C99 reconnaissance tool</li>
|
||
<li>See <a href="../tools/">Tools Documentation</a> for usage examples</li>
|
||
</ul>
|
||
<p><strong>Related Documentation:</strong></p>
|
||
<ul>
|
||
<li><a href="../tools/#c99-tool">Tools Documentation</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="compacted-memory-and-state">🧠 Compacted memory and state</h3>
|
||
<p>For carrying forward summarized context after <code>/compact</code>:</p>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><span class="c1"># State tracking</span>
|
||
</span><span id="__span-3-2"><span class="nv">CAI_STATE</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Enable network state tracking</span>
|
||
</span><span id="__span-3-3">
|
||
</span><span id="__span-3-4"><span class="c1"># Inject /compact summaries into new agent prompts</span>
|
||
</span><span id="__span-3-5"><span class="nv">CAI_COMPACTED_MEMORY</span><span class="o">=</span><span class="s2">"true"</span>
|
||
</span></code></pre></div>
|
||
<p><code>CAI_MEMORY</code> and related Qdrant-style variables are deprecated and ignored by core CAI; use <code>CAI_COMPACTED_MEMORY</code> only.</p>
|
||
<p><strong>Related documentation:</strong></p>
|
||
<ul>
|
||
<li><a href="../tui/advanced_features/">Advanced Features</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="security-safety">🛡️ Security & Safety</h3>
|
||
<p>For enabling security guardrails and controlling agent behavior:</p>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1"><span class="c1"># Security guardrails</span>
|
||
</span><span id="__span-4-2"><span class="nv">CAI_GUARDRAILS</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Prevent dangerous commands</span>
|
||
</span><span id="__span-4-3"><span class="nv">CAI_PRICE_LIMIT</span><span class="o">=</span><span class="s2">"1"</span><span class="w"> </span><span class="c1"># Maximum cost in dollars</span>
|
||
</span><span id="__span-4-4"><span class="nv">CAI_MAX_INTERACTIONS</span><span class="o">=</span><span class="s2">"inf"</span><span class="w"> </span><span class="c1"># Maximum allowed interactions</span>
|
||
</span><span id="__span-4-5">
|
||
</span><span id="__span-4-6"><span class="c1"># Debugging & monitoring</span>
|
||
</span><span id="__span-4-7"><span class="nv">CAI_DEBUG</span><span class="o">=</span><span class="s2">"1"</span><span class="w"> </span><span class="c1"># 0: minimal, 1: verbose, 2: CLI debug</span>
|
||
</span><span id="__span-4-8"><span class="nv">CAI_TRACING</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Enable OpenTelemetry tracing</span>
|
||
</span></code></pre></div>
|
||
<p><strong>Security Layers:</strong></p>
|
||
<ul>
|
||
<li><strong>Guardrails</strong>: Prompt injection detection and command validation</li>
|
||
<li><strong>Cost Limits</strong>: Prevent runaway API usage</li>
|
||
<li><strong>Interaction Limits</strong>: Control agent autonomy</li>
|
||
</ul>
|
||
<p><strong>Related Documentation:</strong></p>
|
||
<ul>
|
||
<li><a href="../guardrails/">Guardrails Documentation</a></li>
|
||
<li><a href="../tui/advanced_features/">TUI Advanced Features</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="performance-optimization">⚡ Performance Optimization</h3>
|
||
<p>For optimizing output, execution speed, and resource usage:</p>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-5-1"><span class="c1"># Output control</span>
|
||
</span><span id="__span-5-2"><span class="nv">CAI_BRIEF</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Concise output mode</span>
|
||
</span><span id="__span-5-3"><span class="nv">CAI_STREAM</span><span class="o">=</span><span class="s2">"false"</span><span class="w"> </span><span class="c1"># Disable LLM inference streaming (default: false)</span>
|
||
</span><span id="__span-5-4"><span class="nv">CAI_TOOL_STREAM</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Enable tool output streaming (default: true)</span>
|
||
</span><span id="__span-5-5">
|
||
</span><span id="__span-5-6"><span class="c1"># Context optimization</span>
|
||
</span><span id="__span-5-7"><span class="nv">CAI_ENV_CONTEXT</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Include environment in context</span>
|
||
</span><span id="__span-5-8"><span class="nv">CAI_MAX_TURNS</span><span class="o">=</span><span class="s2">"50"</span><span class="w"> </span><span class="c1"># Limit conversation turns</span>
|
||
</span><span id="__span-5-9"><span class="nv">CAI_CTX_TRUNC</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Truncate large outputs to save context</span>
|
||
</span><span id="__span-5-10"><span class="nv">CAI_DISPLAY_MAX_OUTPUT</span><span class="o">=</span><span class="s2">"false"</span><span class="w"> </span><span class="c1"># Show full output (set true to disable truncation)</span>
|
||
</span><span id="__span-5-11">
|
||
</span><span id="__span-5-12"><span class="c1"># Tool execution timeout</span>
|
||
</span><span id="__span-5-13"><span class="nv">CAI_TOOL_TIMEOUT</span><span class="o">=</span><span class="s2">"60"</span><span class="w"> </span><span class="c1"># Override default command timeouts (in seconds)</span>
|
||
</span><span id="__span-5-14"><span class="nv">CAI_IDLE_TIMEOUT</span><span class="o">=</span><span class="s2">"100"</span><span class="w"> </span><span class="c1"># Max seconds without output before terminating (default: 100)</span>
|
||
</span><span id="__span-5-15">
|
||
</span><span id="__span-5-16"><span class="c1"># Telemetry</span>
|
||
</span><span id="__span-5-17"><span class="nv">CAI_TELEMETRY</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Enable usage analytics</span>
|
||
</span></code></pre></div>
|
||
<p><strong>Streaming Configuration:</strong></p>
|
||
<ul>
|
||
<li><code>CAI_STREAM</code>: Controls LLM inference streaming (token-by-token display). Default: <code>false</code></li>
|
||
<li><code>CAI_TOOL_STREAM</code>: Controls tool output streaming (real-time command output). Default: <code>true</code></li>
|
||
<li>These are <strong>independent</strong> - you can have tool streaming enabled while LLM streaming is disabled</li>
|
||
</ul>
|
||
<p><strong>Performance Tips:</strong></p>
|
||
<ul>
|
||
<li>Enable <code>CAI_BRIEF</code> for concise outputs in automated workflows</li>
|
||
<li>Set <code>CAI_MAX_TURNS</code> to prevent infinite loops</li>
|
||
<li>Use <code>CAI_STREAM=false</code> (default) for faster LLM responses without token-by-token display</li>
|
||
<li>Use <code>CAI_TOOL_STREAM=true</code> (default) to see command output in real-time</li>
|
||
<li>Set <code>CAI_TOOL_TIMEOUT</code> to control command execution timeouts (default: 10s for interactive, 100s for regular commands)</li>
|
||
<li>Set <code>CAI_IDLE_TIMEOUT</code> to control how long a command can run without producing output before being terminated (default: 100s). Increase for slow network scans like nmap</li>
|
||
<li>Enable <code>CAI_CTX_TRUNC=true</code> when working with large files (JS/HTML/CSS) to prevent context overflow</li>
|
||
<li>Set <code>CAI_DISPLAY_MAX_OUTPUT=true</code> to see full tool output without truncation (useful for debugging format strings, large outputs)</li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="advanced-agent-configuration">🔧 Advanced Agent Configuration</h3>
|
||
<p>For specialized agents and complex workflows:</p>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-6-1"><span class="c1"># Support agent (meta-reasoning)</span>
|
||
</span><span id="__span-6-2"><span class="nv">CAI_SUPPORT_MODEL</span><span class="o">=</span><span class="s2">"o3-mini"</span><span class="w"> </span><span class="c1"># Model for support agent</span>
|
||
</span><span id="__span-6-3"><span class="nv">CAI_SUPPORT_INTERVAL</span><span class="o">=</span><span class="s2">"5"</span><span class="w"> </span><span class="c1"># Turns between support executions</span>
|
||
</span><span id="__span-6-4">
|
||
</span><span id="__span-6-5"><span class="c1"># Parallel execution</span>
|
||
</span><span id="__span-6-6"><span class="nv">CAI_PARALLEL</span><span class="o">=</span><span class="s2">"3"</span><span class="w"> </span><span class="c1"># Run 3 agent instances simultaneously</span>
|
||
</span><span id="__span-6-7">
|
||
</span><span id="__span-6-8"><span class="c1"># Specialized agents</span>
|
||
</span><span id="__span-6-9"><span class="nv">CAI_GCTR_NITERATIONS</span><span class="o">=</span><span class="s2">"5"</span><span class="w"> </span><span class="c1"># For bug_bounty_gctr agent</span>
|
||
</span></code></pre></div>
|
||
<p><strong>Specialized Agent Variables:</strong></p>
|
||
<ul>
|
||
<li><code>CAI_GCTR_NITERATIONS</code>: Controls Cut-The-Rope analysis frequency in GCTR agents</li>
|
||
<li><code>CAI_SUPPORT_MODEL</code>: Meta-agent for strategic planning</li>
|
||
<li><code>CAI_PARALLEL</code>: Swarm-style parallel agent execution</li>
|
||
</ul>
|
||
<p><strong>Related Documentation:</strong></p>
|
||
<ul>
|
||
<li><a href="../agents/">Agents Documentation</a></li>
|
||
<li><a href="../tui/teams_and_parallel_execution/">Teams & Parallel Execution</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="container-virtualization">🐳 Container & Virtualization</h3>
|
||
<p>For executing commands inside Docker containers:</p>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-7-1"><span class="c1"># Container targeting</span>
|
||
</span><span id="__span-7-2"><span class="nv">CAI_ACTIVE_CONTAINER</span><span class="o">=</span><span class="s2">"a1b2c3d4e5f6"</span><span class="w"> </span><span class="c1"># Docker container ID</span>
|
||
</span><span id="__span-7-3">
|
||
</span><span id="__span-7-4"><span class="c1"># Automatic with CTF</span>
|
||
</span><span id="__span-7-5"><span class="nv">CTF_INSIDE</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Auto-set CAI_ACTIVE_CONTAINER on CTF start</span>
|
||
</span></code></pre></div>
|
||
<p><strong>Container Execution:</strong></p>
|
||
<ul>
|
||
<li>When <code>CAI_ACTIVE_CONTAINER</code> is set, all shell commands execute inside that container</li>
|
||
<li>Automatically configured when starting CTF challenges with <code>CTF_INSIDE=true</code></li>
|
||
<li>Switch containers using <code>/virtualization</code> or <code>/virt</code> in the REPL</li>
|
||
</ul>
|
||
<p><strong>Related Documentation:</strong></p>
|
||
<ul>
|
||
<li><a href="../cai/getting-started/commands/">Commands Reference</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="tui-specific-configuration">🖥️ TUI-Specific Configuration</h3>
|
||
<p>For Terminal User Interface features and workflows:</p>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-8-1"><span class="c1"># TUI display</span>
|
||
</span><span id="__span-8-2"><span class="nv">CAI_STREAM</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Enable LLM inference streaming in TUI panels</span>
|
||
</span><span id="__span-8-3"><span class="nv">CAI_TOOL_STREAM</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Enable tool output streaming (default)</span>
|
||
</span><span id="__span-8-4"><span class="nv">CAI_BRIEF</span><span class="o">=</span><span class="s2">"false"</span><span class="w"> </span><span class="c1"># Full output for interactive sessions</span>
|
||
</span><span id="__span-8-5">
|
||
</span><span id="__span-8-6"><span class="c1"># TUI workflows</span>
|
||
</span><span id="__span-8-7"><span class="nv">CAI_PARALLEL</span><span class="o">=</span><span class="s2">"1"</span><span class="w"> </span><span class="c1"># Usually 1 for TUI, use Teams feature instead</span>
|
||
</span><span id="__span-8-8"><span class="nv">CAI_GUARDRAILS</span><span class="o">=</span><span class="s2">"false"</span><span class="w"> </span><span class="c1"># Consider enabling for team workflows</span>
|
||
</span></code></pre></div>
|
||
<p><strong>TUI Recommendations:</strong></p>
|
||
<ul>
|
||
<li>Set <code>CAI_STREAM=true</code> for better interactive LLM response experience</li>
|
||
<li>Keep <code>CAI_TOOL_STREAM=true</code> (default) to see command output in real-time</li>
|
||
<li>Use built-in Teams feature instead of <code>CAI_PARALLEL</code></li>
|
||
<li>Enable <code>CAI_GUARDRAILS</code> when coordinating multiple agents</li>
|
||
</ul>
|
||
<p><strong>Related Documentation:</strong></p>
|
||
<ul>
|
||
<li><a href="../tui/tui_index/">TUI Documentation</a></li>
|
||
<li><a href="../tui/getting_started/">TUI Getting Started</a></li>
|
||
</ul>
|
||
<hr />
|
||
<h3 id="debugging-development">🐛 Debugging & Development</h3>
|
||
<p>For debugging CAI internals and development:</p>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-9-1"><span class="c1"># Debug levels</span>
|
||
</span><span id="__span-9-2"><span class="nv">CAI_DEBUG</span><span class="o">=</span><span class="s2">"1"</span><span class="w"> </span><span class="c1"># 0: minimal, 1: verbose, 2: CLI debug</span>
|
||
</span><span id="__span-9-3">
|
||
</span><span id="__span-9-4"><span class="c1"># Tool visualization debugging</span>
|
||
</span><span id="__span-9-5"><span class="nv">CAI_DEBUG_TOOLS_VIZ</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Debug tool panel rendering and deduplication</span>
|
||
</span><span id="__span-9-6">
|
||
</span><span id="__span-9-7"><span class="c1"># Cache and message debugging</span>
|
||
</span><span id="__span-9-8"><span class="nv">CAI_SHOW_CACHE</span><span class="o">=</span><span class="s2">"true"</span><span class="w"> </span><span class="c1"># Show cache stats and full message history list</span>
|
||
</span><span id="__span-9-9">
|
||
</span><span id="__span-9-10"><span class="c1"># Pricing debugging</span>
|
||
</span><span id="__span-9-11"><span class="nv">CAI_DEBUG_PRICING</span><span class="o">=</span><span class="s2">"1"</span><span class="w"> </span><span class="c1"># Log pricing calculations to debug_pricing.txt</span>
|
||
</span></code></pre></div>
|
||
<p><strong>Debug Variables Explained:</strong></p>
|
||
<ul>
|
||
<li><code>CAI_DEBUG</code>: General debug output level (0-2)</li>
|
||
<li><code>CAI_DEBUG_TOOLS_VIZ</code>: Shows detailed info about tool call display, panel rendering, streaming state, and deduplication logic</li>
|
||
<li><code>CAI_SHOW_CACHE</code>: Displays prompt caching statistics and the complete message list sent to the model. Useful for debugging context issues</li>
|
||
<li><code>CAI_DEBUG_PRICING</code>: Writes detailed pricing calculations to <code>debug_pricing.txt</code> for cost analysis</li>
|
||
</ul>
|
||
<p><strong>When to Use:</strong></p>
|
||
<ul>
|
||
<li>Use <code>CAI_DEBUG_TOOLS_VIZ=true</code> when tool outputs are not displaying correctly or duplicating</li>
|
||
<li>Use <code>CAI_SHOW_CACHE=true</code> when debugging context window issues or cache behavior</li>
|
||
<li>Use <code>CAI_DEBUG_PRICING=1</code> when investigating cost discrepancies</li>
|
||
</ul>
|
||
<hr />
|
||
<h2 id="common-configuration-examples">💡 Common Configuration Examples</h2>
|
||
<h3 id="example-1-local-development-with-ollama">Example 1: Local Development with Ollama</h3>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-10-1"><span class="nv">CAI_MODEL</span><span class="o">=</span><span class="s2">"ollama/qwen2.5:72b"</span>
|
||
</span><span id="__span-10-2"><span class="nv">CAI_AGENT_TYPE</span><span class="o">=</span><span class="s2">"redteam_agent"</span>
|
||
</span><span id="__span-10-3"><span class="nv">CAI_PRICE_LIMIT</span><span class="o">=</span><span class="s2">"0"</span>
|
||
</span><span id="__span-10-4"><span class="nv">CAI_DEBUG</span><span class="o">=</span><span class="s2">"1"</span>
|
||
</span><span id="__span-10-5"><span class="nv">CAI_GUARDRAILS</span><span class="o">=</span><span class="s2">"false"</span>
|
||
</span></code></pre></div>
|
||
<h3 id="example-2-production-ctf-solving">Example 2: Production CTF Solving</h3>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-11-1"><span class="nv">CTF_NAME</span><span class="o">=</span><span class="s2">"hackthebox_challenge"</span>
|
||
</span><span id="__span-11-2"><span class="nv">CTF_INSIDE</span><span class="o">=</span><span class="s2">"true"</span>
|
||
</span><span id="__span-11-3"><span class="nv">CAI_MODEL</span><span class="o">=</span><span class="s2">"alias1"</span>
|
||
</span><span id="__span-11-4"><span class="nv">CAI_STATE</span><span class="o">=</span><span class="s2">"true"</span>
|
||
</span><span id="__span-11-5"><span class="nv">CAI_COMPACTED_MEMORY</span><span class="o">=</span><span class="s2">"true"</span>
|
||
</span><span id="__span-11-6"><span class="nv">CAI_GUARDRAILS</span><span class="o">=</span><span class="s2">"true"</span>
|
||
</span><span id="__span-11-7"><span class="nv">CAI_PRICE_LIMIT</span><span class="o">=</span><span class="s2">"5"</span>
|
||
</span></code></pre></div>
|
||
<h3 id="example-3-pentesting-with-cost-control">Example 3: Pentesting with Cost Control</h3>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-12-1"><span class="nv">CAI_MODEL</span><span class="o">=</span><span class="s2">"gpt-4o"</span>
|
||
</span><span id="__span-12-2"><span class="nv">CAI_AGENT_TYPE</span><span class="o">=</span><span class="s2">"redteam_agent"</span>
|
||
</span><span id="__span-12-3"><span class="nv">CAI_PRICE_LIMIT</span><span class="o">=</span><span class="s2">"2"</span>
|
||
</span><span id="__span-12-4"><span class="nv">CAI_MAX_INTERACTIONS</span><span class="o">=</span><span class="s2">"100"</span>
|
||
</span><span id="__span-12-5"><span class="nv">CAI_GUARDRAILS</span><span class="o">=</span><span class="s2">"true"</span>
|
||
</span><span id="__span-12-6"><span class="nv">CAI_BRIEF</span><span class="o">=</span><span class="s2">"false"</span>
|
||
</span></code></pre></div>
|
||
<h3 id="example-4-parallel-testing-non-tui">Example 4: Parallel Testing (Non-TUI)</h3>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-13-1"><span class="nv">CAI_MODEL</span><span class="o">=</span><span class="s2">"alias0-fast"</span>
|
||
</span><span id="__span-13-2"><span class="nv">CAI_PARALLEL</span><span class="o">=</span><span class="s2">"5"</span>
|
||
</span><span id="__span-13-3"><span class="nv">CAI_BRIEF</span><span class="o">=</span><span class="s2">"true"</span>
|
||
</span><span id="__span-13-4"><span class="nv">CAI_MAX_TURNS</span><span class="o">=</span><span class="s2">"20"</span>
|
||
</span><span id="__span-13-5"><span class="nv">CAI_STREAM</span><span class="o">=</span><span class="s2">"false"</span><span class="w"> </span><span class="c1"># LLM inference streaming off</span>
|
||
</span><span id="__span-13-6"><span class="nv">CAI_TOOL_STREAM</span><span class="o">=</span><span class="s2">"false"</span><span class="w"> </span><span class="c1"># Tool streaming off for parallel (auto-disabled)</span>
|
||
</span></code></pre></div>
|
||
<hr />
|
||
<h2 id="related-documentation">📚 Related Documentation</h2>
|
||
<ul>
|
||
<li><a href="../cai/getting-started/configuration/">Configuration Guide</a> - Basic setup and API keys</li>
|
||
<li><a href="../cai/getting-started/commands/">Commands Reference</a> - Available CLI commands</li>
|
||
<li><a href="../tui/tui_index/">TUI Documentation</a> - Terminal User Interface features</li>
|
||
<li><a href="../agents/">Agents Documentation</a> - Available agent types</li>
|
||
<li><a href="../guardrails/">Guardrails</a> - Security and safety features</li>
|
||
</ul>
|
||
<hr />
|
||
<h2 id="important-notes">⚠️ Important Notes</h2>
|
||
<h3 id="api-keys">API Keys</h3>
|
||
<p>CAI does NOT provide API keys for any model by default. Configure your own keys in the <code>.env</code> file:</p>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-14-1"><span class="nv">OPENAI_API_KEY</span><span class="o">=</span><span class="s2">"sk-..."</span><span class="w"> </span><span class="c1"># Required (can use "sk-123" as placeholder)</span>
|
||
</span><span id="__span-14-2"><span class="nv">ANTHROPIC_API_KEY</span><span class="o">=</span><span class="s2">"sk-ant-..."</span><span class="w"> </span><span class="c1"># For Claude models</span>
|
||
</span><span id="__span-14-3"><span class="nv">ALIAS_API_KEY</span><span class="o">=</span><span class="s2">"sk-..."</span><span class="w"> </span><span class="c1"># For alias1 (CAI PRO)</span>
|
||
</span><span id="__span-14-4"><span class="nv">OLLAMA_API_BASE</span><span class="o">=</span><span class="s2">"http://localhost:11434/v1"</span><span class="w"> </span><span class="c1"># For local models</span>
|
||
</span><span id="__span-14-5"><span class="nv">C99_API_KEY</span><span class="o">=</span><span class="s2">"your-api-key"</span><span class="w"> </span><span class="c1"># For C99.nl subdomain discovery tool</span>
|
||
</span></code></pre></div>
|
||
<p>See the <a href="../cai/getting-started/configuration/">Configuration Guide</a> for more details.</p>
|
||
<h3 id="setting-variables">Setting Variables</h3>
|
||
<p>There are three ways to configure environment variables:</p>
|
||
<p><strong>1. <code>.env</code> file (Recommended)</strong></p>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-15-1"><span class="c1"># Add to .env file</span>
|
||
</span><span id="__span-15-2"><span class="nv">CAI_MODEL</span><span class="o">=</span><span class="s2">"alias1"</span>
|
||
</span><span id="__span-15-3"><span class="nv">CAI_PRICE_LIMIT</span><span class="o">=</span><span class="s2">"1"</span>
|
||
</span></code></pre></div>
|
||
<p><strong>2. Command-line</strong></p>
|
||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-16-1"><span class="nv">CAI_MODEL</span><span class="o">=</span><span class="s2">"gpt-4o"</span><span class="w"> </span><span class="nv">CAI_PRICE_LIMIT</span><span class="o">=</span><span class="s2">"2"</span><span class="w"> </span>cai
|
||
</span></code></pre></div>
|
||
<p><strong>3. Runtime configuration</strong></p>
|
||
<p>Use slash commands during a session: <code>/env list</code>, <code>/env set …</code>, and the in-session help above (<code>/help</code>, <code>/help var …</code>). See <a href="../cai/getting-started/commands/">Commands Reference</a>.</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> |