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.
Launching the TUI
Section titled “Launching the TUI”Run olympix with no arguments:
olympixThe TUI requires an interactive terminal (not piped output). If you need non-interactive automation, see Agent Mode.
Tool Selection Menu
Section titled “Tool Selection Menu”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| Key | Action |
|---|---|
↑ / ↓ | Navigate tools |
Enter | Launch selected tool |
1–5 | Quick-select by number |
q / Esc | Exit |
Live sessions
Section titled “Live sessions”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.
Interactive Tool Commands
Section titled “Interactive Tool Commands”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:
| Command | Description |
|---|---|
olympix static-analysis | Interactive static analysis — file selection, scan, results |
olympix unit-testing | Unit test session manager — list, reconnect, or start new |
olympix mutation-testing | Mutation test session manager — list, reconnect, or start new |
olympix fuzz-testing | Interactive fuzz test generator |
olympix bug-pocer | BugPocer session manager — see BugPoCer docs |
These commands accept the same workspace and path options as their analyze / generate-* counterparts:
# Launch static analysis on a specific workspaceolympix static-analysis -w /path/to/project
# Launch unit testing on a specific workspaceolympix unit-testing -w /path/to/projectAccess Tiers
Section titled “Access Tiers”Some tools require specific account tiers:
| Tool | Requirement |
|---|---|
| Static Analysis | Free |
| Mutation Testing | Premium |
| Unit Testing | Premium |
| Fuzz Testing | Premium + Private Alpha |
| BugPocer | Premium + 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.
Helpful Links
Section titled “Helpful Links”- Agent Mode — non-interactive JSON protocol for AI agent integrations
- BugPoCer — detailed BugPoCer documentation
- Analysis — static analysis and reporting
- Unit Test Generation — unit test generation guide
- Mutation Test Generation — mutation test generation guide