docs

Docs

The Quickstart and the Privacy page are written for this site. The rest is the app's built-in help, as shipped in quodeq 1.13.1, so the two never disagree.

Start with the Quickstart

Start here

  • Quickstart

    From install to your first findings, on your own machine. No account, nothing to sign up for.

  • Getting Started

    The first time you launch quodeq, a welcome opens with the two ways in: a repository to evaluate, or an evaluations…

  • AI Providers

    quodeq needs an AI model to read your code. There are three ways to supply one, and you can switch any time in Settings:

  • Command Line & CI

    The dashboard is one subcommand of the quodeq CLI. The rest run headless: scripted evaluations, pull-request reviews,…

  • Privacy and data

    quodeq has no account, no telemetry and no quodeq server. This page lists exactly what leaves your machine, and where…

  • Philosophy

    quodeq reads your code the way a reviewer would and reports both what is wrong and what is right. It is not a linter:…

Projects and runs

  • Repositories

    The Repositories tab is your home base. Every codebase you evaluate becomes a project with its own grade, score, and…

  • Running Evaluations

    The Evaluate tab is where you start, watch, and finish a run. The same screen handles configuration, live progress,…

  • Shared Repository

    An evaluations repository is a plain git repo where evaluations are published. It can be yours, to reach your results…

  • Git Access

    quodeq clones repositories with git. Before every clone it checks, in a few seconds, whether git can reach the…

Reading results

  • Overview

    The Overview tab is a project's landing page: the accumulated quality picture plus the fastest routes into the details.

  • Quality Dimensions

    quodeq evaluates code across six dimensions derived from the ISO/IEC 25010 software-quality standard, plus two…

  • Violations & Fix Plans

    The Violations tab is where you triage findings, read the evidence, and plan fixes. Active and dismissed findings…

  • Code Map

    The Map tab draws your codebase as shapes you can scan at a glance: two metrics crossed with three layouts.

  • History & Trends

    The History tab is your project's quality timeline. Every completed run lives there with its grade, score, and delta…

  • Compare

    The Compare tab ranks every project side by side. It appears in the sidebar once at least two projects have been…

The grade

  • Why This Grade

    A principle's score comes from four stages. Each stage reads one part of the grade formula, and every part can be…

  • Grade Formula

    The grade formula turns findings into scores and letter grades. You can tune every part of it: open Settings, find…

  • Custom Standards

    The Standards tab is where you decide what quality means for your project. Browse, edit, import, and create the rules…

In the app

  • Assistant

    The assistant is a chat panel that knows your project. It explains scores, digs into findings, and drafts standards…

  • Terminal

    A real shell inside the dashboard: your login shell, on your machine, with your tools. quodeq only hosts the window.

  • Settings

    Provider configuration, model overrides, server status, and appearance live in Settings. Most of it is set once and…

Releases

  • Changelog

    Every release, newest first, built from CHANGELOG.md word for word.