Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/acdeveloper-sci/fortriage/llms.txt

Use this file to discover all available pages before exploring further.

ForTriage is installed from source using the uv package manager. The only hard requirements are Python 3.10 or newer and uv itself — everything else, including the Forti4D analysis engine, is declared in pyproject.toml and installed automatically. AI Insights is entirely optional and requires a Google AI Studio API key only if you want to use the conversational analysis features.

Requirements

Before installing ForTriage, ensure you have the following:
  • Python 3.10 or newer — required by pyproject.toml (requires-python = ">=3.10"). Earlier versions are not supported.
  • uv package manager — ForTriage uses uv for dependency resolution and environment isolation. Install it from docs.astral.sh/uv.
  • Google AI Studio API key (optional) — required only for the AI Insights view. The rest of the dashboard works fully without it. Get a free key at ai.google.dev.

Install from source

1

Clone and install

Clone the repository and run uv sync to install all dependencies into an isolated environment:
git clone https://github.com/acdeveloper-sci/fortriage.git && cd fortriage && uv sync
uv sync reads pyproject.toml and installs all declared dependencies — including forti4d, which is pulled directly from its GitHub repository at the pinned release tag. No additional configuration is required.

Running the app

Once installed, launch the Streamlit dashboard with:
uv run streamlit run streamlit_app.py
Streamlit starts a local server and opens the dashboard automatically at http://localhost:8501. The sidebar navigation and Overview view load immediately; the other views (Drill-down, Executive Summary, Report Explorer, AI Insights) become active after you run an analysis.

AI Insights setup (optional)

This step is entirely optional. The Overview, Drill-down, Executive Summary, and Report Explorer views are fully functional without an API key. Only the AI Insights view requires one. See AI Insights for full documentation on using the conversational assistant.
To enable AI Insights, create a Streamlit secrets file and add your Gemini API key:
1

Create the secrets file

In the root of the cloned repository, create the .streamlit/ directory and a secrets.toml file inside it:
mkdir -p .streamlit
2

Add your API key

Open .streamlit/secrets.toml in any text editor and add the following line, replacing the placeholder with your actual key:
.streamlit/secrets.toml
GEMINI_API_KEY = "your-api-key-here"
Save the file. The next time you run uv run streamlit run streamlit_app.py, ForTriage will detect the key and enable the AI Insights view automatically.
AI Insights uses the gemini-3.5-flash-lite model via Google’s free-tier Gemini API. When you run an analysis or use the AI chat, aggregated metrics about your code (not the source code itself) are sent to the Gemini API. Review Google’s data terms before enabling AI Insights on confidential codebases.

Dependencies

The following packages are declared in pyproject.toml and installed automatically by uv sync:
PackageVersionRole
streamlitlatestInteractive dashboard framework — provides the UI, session state, sidebar navigation, and widget layer
pandaslatestTabular data handling — reads and manipulates the CSV reports produced by the Forti4D pipeline
forti4dv0.7.1 (git)Fortran static analysis engine — performs parsing, metrics calculation, risk scoring, and report generation
altair>=6.2.2Declarative charting library — powers the risk distribution chart and other visualizations in the dashboard
google-genai==2.14.0Google Generative AI SDK — used by the AI Insights view to communicate with the Gemini API
forti4d is installed directly from its GitHub repository at the v0.7.1 tag. It does not need to be installed separately — uv sync handles it automatically.

Build docs developers (and LLMs) love