AI you can inspect and steer.
Footnote is a transparency-first AI framework for people who want more than a black-box answer. It pairs responses with provenance and trace metadata so you can understand what happened, challenge weak output, and guide behavior over time.
Built for human oversight, not "just trust me."
Demo · Quickstart · Docs · Contributing
Most AI products give you an answer and hide the reasoning context.
Footnote takes the opposite approach: make responses easier to inspect, easier to challenge, and easier to steer. The goal is to support better human judgment, not replace it.
With Footnote, you can:
- See how confident the AI is
- Check what information it used
- Understand the trade-offs behind an answer
- See what guardrails were applied
This starts the local backend + web app.
- Install dependencies:
pnpm installIf
pnpmis not available yet, runcorepack enableonce, then runpnpm install.
- Create a local env file from
.env.example.
Set at least these keys in .env for a useful local run:
OPENAI_API_KEY=...
INCIDENT_PSEUDONYMIZATION_SECRET=<generate-a-random-secret>Generate a secret with:
node -e "console.log(require('node:crypto').randomBytes(32).toString('hex'))"- Start backend + web:
pnpm dev- Open web app:
http://localhost:8080
- You ask Footnote a question.
- The backend generates a response using the configured model runtime.
- Footnote returns the answer with inspectable metadata (confidence, sources, trade-offs, and applied constraints).
Representative metadata shape:
{
"confidence": "medium",
"sources": ["..."],
"tradeoffs": ["..."],
"constraintsApplied": ["..."]
}TRACE shows five response qualities at a glance: Tightness, Rationale, Attribution, Caution, and Extent.
Learn more: TRACE decision record
If you want the Discord surface, set Discord credentials in .env and run:
pnpm start:allRequired Discord configuration includes:
DISCORD_TOKENDISCORD_CLIENT_IDDISCORD_USER_IDDISCORD_GUILD_IDS(preferred) orDISCORD_GUILD_ID(legacy fallback)
To enable VoltAgent runtime observability in VoltOps, set:
VOLTAGENT_PUBLIC_KEY=pk_...
VOLTAGENT_SECRET_KEY=sk_...You can run a vendored bot identity by setting:
BOT_PROFILE_IDBOT_PROFILE_DISPLAY_NAMEBOT_PROFILE_PROMPT_OVERLAYorBOT_PROFILE_PROMPT_OVERLAY_PATHBOT_PROFILE_MENTION_ALIASES(optional)
For precedence details, see docs/architecture/prompt-resolution.md.
Start here: Documentation Map
Docs are actively being improved as Footnote evolves. If something is unclear or hard to find, open a Discussion and we will point you to the right source.
Contribution docs are still in progress.
For now, please open an Issue or Discussion for non-trivial changes so we can align on scope early. Thoughtful critique, focused PRs, and experiments are welcome.
Footnote is pre-1.0 and moving quickly. Expect rapid iteration and occasional sharp edges while interfaces and workflows stabilize.
Footnote is dual-licensed under MIT and the Hippocratic License v3 (HL3-CORE).
See license strategy for details.