Skip to content

Interactive Mode (TUI)

The Olympix CLI includes an interactive terminal UI that lets you launch any tool, monitor live sessions, and manage results — all from a single entry point.


Run olympix with no arguments:

Terminal window
olympix

The TUI requires an interactive terminal (not piped output). If you need non-interactive automation, see Agent Mode.


The main menu presents all available tools with keyboard navigation:

O L Y M P I X
Proactive Smart Contract Security
─────────────────────────────────
Select a tool to launch:
❯ [1] BugPocer - Interactive AI-powered security analysis
[2] Mutation Testing - Generate mutation tests to verify test suite effectiveness
[3] Unit Testing - Generate unit tests for OlympixUnitTest contracts
[4] Fuzz Testing - Generate fuzz tests for smart contract security
[5] Static Analysis - Scan contracts for vulnerabilities and security issues
KeyAction
/ Navigate tools
EnterLaunch selected tool
15Quick-select by number
q / EscExit

If you have active or recently completed sessions, they appear below the tool list. Select a session to reconnect directly — no need to navigate through the tool’s session picker first.

Sessions auto-refresh every 15 seconds while the menu is open.


Each tool also has its own dedicated command that launches directly into its interactive session manager. These are the same handlers the TUI dispatches internally:

CommandDescription
olympix static-analysisInteractive static analysis — file selection, scan, results
olympix unit-testingUnit test session manager — list, reconnect, or start new
olympix mutation-testingMutation test session manager — list, reconnect, or start new
olympix fuzz-testingInteractive fuzz test generator
olympix bug-pocerBugPocer session manager — see BugPoCer docs

These commands accept the same workspace and path options as their analyze / generate-* counterparts:

Terminal window
# Launch static analysis on a specific workspace
olympix static-analysis -w /path/to/project
# Launch unit testing on a specific workspace
olympix unit-testing -w /path/to/project

Some tools require specific account tiers:

ToolRequirement
Static AnalysisFree
Mutation TestingPremium
Unit TestingPremium
Fuzz TestingPremium + Private Alpha
BugPocerPremium + Private Alpha

If you don’t have access to a tool, the menu shows the requirement and prevents selection. Contact contact@olympix.ai to upgrade.