keel Docs: Glossary, Fiqh Basis, Runbooks
These are the keel engine's own documents, rendered here at build time from CodeGateSoftware/keel. Nothing on this page is retyped or summarized by hand: if a pinned document moves or disappears upstream, this site's build fails loudly instead of showing something stale.
How this works
A manifest (engine-docs.manifest.json) pins each document's path in the engine repository. At every build — including the hourly rebuild — the fetch script downloads each one, rewrites relative links to point at their GitHub sources, and the build renders them. The build fails on purpose if any pinned path 404s.
Get started
Guides
-
Installing the desktop app
Why your computer warns you about keel's desktop builds — unsigned, because code-signing certificates cost money the project doesn't have — what macOS and Windows each show, and the install path that draws no warning at all.
-
Operator runbook
Operating a deployment: the account-level obligations no rail can enforce, upgrades, and the three deployment profiles.
-
Go-live runbook
The path to a first supervised live order — promotion, paper, and the human-in-the-loop steps.
Reference
-
Glossary
The single source for keel's vocabulary — every term a keel screen can show, defined here and nowhere else.
-
The fiqh basis
The Shariah reasoning keel encodes, ruling by ruling, each with its in-repo source — published so it can be audited and challenged.
-
Software Architecture Record
The system as verified, not as imagined — what keel is, the packages it ships in, the choices holding it up, and, issue by issue, what is not built yet.
-
The read-only MCP server
keel mcp: the eight read-only tools an assistant can call — doctor, capabilities, profiles, orders, veto_log, purification, trials, reports — and the fence, in six walls, that keeps them read-only.
Decisions
-
Decision 0001: the desktop update path
Why the desktop app never self-updates: updating means deliberately downloading the new installer — a trust posture chosen over an update channel that would itself need securing.
-
Decision 0002: SQLite persistence
Why persistence is SQLite with one writer per file — stated as load-bearing, not a limitation, with the named triggers that alone would reopen the question.
-
Decision 0003: the commands-layer survey
The measurement-first survey of the commands layer — what each module's role is, and why "larger than the engine" dissolved before the survey ran.
-
Decision 0004: monetisation is not now
Why keel does not monetise yet, and why affiliate links are a permanent no rather than a “not yet”: referral revenue would be a direct stake in the same fee schedule keel's credibility depends on assessing without one.
-
Decision 0005: options
Why keel does not trade options — refused on operational grounds, with the permissibility question expressly not reached, and the four facts that would reopen it.
Research & experiments
-
The research toolkit
The thirteen evidence modules keel research fronts — each with the question it answers and, to be read just as carefully, the question it refuses to answer.
-
Experiment: the honest result, restated
The full record of the measured result: no shipped rule family is net-positive at the taker fee actually paid — every number and the defects that forced a restatement.
-
Experiment: the hourly backtest
Why the hourly profile exists: the same rules measured on ONE_HOUR bars fire 49.4 signals per asset-year instead of 2.15.
-
Experiment: rule-family significance
Is any family's edge distinguishable from zero at the fee actually paid? Measured over every product's full cached history: none is, in any fee regime — the tool's job was to be able to say no, and it says no.
-
Experiment: the Optuna parameter study
An optimizer pointed at the rule families to see whether any candidate deserved the gauntlet: the promotion gate refused every cell, and the fitted winners were booked diagnostic-only — never auto-tuned lives.
-
Experiment: trailing vs static exits
The ratchet-only exit policy — wired, then measured against static exits at the fee actually paid: trailing makes both families clearly worse, so the defaults stay off. The capability exists; the measurement says not to turn it on.
-
Research: speculation risk sources (Lahlou)
Source review on the risk sources of speculation — part of the research corpus behind the fiqh basis.
-
Research: money management & fiqh sources
Source review on money management in trading and its fiqh treatment.