Skip to content

How to use the F-key cartridge model

← All revisions

4dc9b9d6 · PointSav Digital Systems ·

feat(how-to): add 8 developer guides for Working in Console + Records & Storage tiles (EN+ES pairs)

View the full record as of this revision →

@@ -0,0 +1,88 @@
---
schema: foundry-doc-v1
title: "How to use the F-key cartridge model"
slug: use-f-key-model
category: how-to
content_type: how-to
type: how-to
status: active
last_edited: 2026-06-14
editor: pointsav-engineering
paired_with: use-f-key-model.es.md
---

The F-key model is the operator interface of `os-console`. Each F-key slot hosts a Cartridge — a self-contained module compiled into the binary that owns its rendering, keyboard handling, and lifecycle. Understanding the slot assignments and how each Cartridge works lets you move efficiently between platform functions without leaving the terminal.

For the Cartridge trait and how slots are compiled in, see [[app-console-keys]]. For navigation fundamentals, see [[navigate-console-tui]].

## Default slot assignments

| F-key | Cartridge | Primary function |
|---|---|---|
| F3 | Email | Read and compose messages; see [[app-console-email]] |
| F9 | SLM | Local inference and Doorman health dashboard; see [[app-console-slm]] |
| F12 | Input Machine | Human-verified record entry; mandatory per SYS-ADR-10; see [[app-console-input]] |

Slots not listed above are reserved or unloaded. A dimmed label in the navigation strip indicates the slot is unloaded in the current session.

## How a Cartridge works

A Cartridge is compiled into the `os-console` binary. It is not a plugin or runtime script. When you press an F-key, the binary hands control to the Cartridge registered for that slot.

Each Cartridge:
- Renders its own full-screen view in the slot area
- Handles keyboard events for that slot
- Reports to the status bar which slot is active
- Connects to the relevant platform service (email, SLM, ledger) using the active MBA connection

A Cartridge that cannot reach its backing service shows a status indicator in the slot area rather than failing silently.

## Using the Email Cartridge (F3)

1. Press **F3** to open the Email Cartridge.
2. The inbox list appears showing unread counts and sender summaries.
3. Navigate with arrow keys; press **Enter** to open a message.
4. Press **c** to compose a new message.

Outbound messages route through `service-email`. Direct SMTP connections are not used — the Cartridge acts as a Comm Diode, applying tenant communication policy before sending.

For detail on the email flow, see [[app-console-email]].

## Using the SLM Cartridge (F9)

1. Press **F9** to open the SLM Cartridge.
2. The Doorman health dashboard shows which inference tier (A, B, or C) is active and the entity count from the DataGraph.
3. Press **R** to manually refresh the health status.
4. Submit a prompt at the input line. The response streams into the slot area.

All inference requests route through Doorman. No prompt data leaves the operator's hardware.

For the inference architecture, see [[app-console-slm]] and [[doorman-protocol]].

## Using the Input Machine (F12)

The F12 slot is the human-in-the-loop gate required by SYS-ADR-10. It is the only path through which an operator-verified record can enter the WORM ledger.

1. Press **F12** to open the Input Machine.
2. Review the record or document displayed for verification.
3. Confirm or reject using the labelled key bindings shown in the navigation strip.

A confirmed record is written to the ledger immediately. A rejected record is routed to quarantine.

For the design rationale, see [[app-console-input]] and [[worm-ledger-architecture]].

## Key takeaways

- Each slot is compiled in at build time — there is no plugin runtime or slot hot-swap
- A Cartridge that loses its backing service degrades gracefully and shows a status indicator
- F12 cannot be reassigned; it is structurally the human-verification gate for the ledger
- The Comm Diode model in F3 means email routing applies tenant policy — you cannot bypass it from within the Cartridge

## See also

- [[app-console-keys]] — chassis architecture, Cartridge trait, status bar components
- [[app-console-email]] — Email Cartridge: inbox, reading, compose, and plain-text mode
- [[app-console-slm]] — SLM Cartridge: Doorman dashboard and local inference
- [[app-console-input]] — Input Machine: the F12 human-verification gate
- [[navigate-console-tui]] — overall TUI layout and slot navigation
- [[worm-ledger-architecture]] — the ledger that F12 writes into
Important Information

Important Information

Corporate structure. PointSav Digital Systems ("PointSav") is a trade name of Woodfine Capital Projects Inc. ("Woodfine"). PointSav does not itself offer, sell, or solicit any security. Any securities offering associated with Woodfine's real-property direct-hold solutions is made exclusively by Woodfine, and only by means of the applicable Private Placement Memorandum.

No investment advice. This wiki's content is provided for engineering, operational, research, and development purposes. Nothing on this wiki constitutes investment advice or a solicitation to invest in any Woodfine partnership or direct-hold solution.

Intellectual property. The PointSav name, trade name, wordmark, and marks, together with all current and future PointSav- and Totebox-branded products, services, and offerings — and the software, source code, documentation, design system, and all related materials — are proprietary to Woodfine and its affiliates, except for components identified as open source. No rights are granted except as expressly set out in a written license or agreement. See TRADEMARK.md in this repository for the full trademark notice.

Open source components. Portions of the platform are made available under permissive open-source licenses identified in the accompanying repository. Use of those components is governed by their respective license terms.

No warranty; informational use. Content on this wiki is provided for general informational purposes only and does not constitute a representation, warranty, or commitment with respect to product functionality, availability, pricing, or roadmap. Some articles describe planned or intended features, capabilities, and milestones — language such as "planned," "intended," "targeted," "may," and "expected" marks this forward-looking content, which is subject to change and does not constitute a commitment regarding future performance.

Confidentiality. Where an article describes an operational or deployment detail that is not intended for public disclosure, that article is not published on this wiki. Content here is general-purpose engineering documentation, not customer-specific configuration.

Jurisdiction. Woodfine Capital Projects Inc. is organized in British Columbia, Canada. References to the Sovereign Data Foundation on this wiki describe a planned or intended initiative only, not a current equity holder or active governance body.

Changes to this notice. PointSav may update this notice from time to time; the version posted on this page governs.

Not a filing system. This wiki is not a securities filing system, an electronic disclosure repository, or a substitute for SEDAR+ or any other regulatory filing system. Formal securities filings are made through the applicable regulatory filing system, not through this wiki.

Full disclaimer. This notice supplements, and does not replace, the full Disclaimers article. In the event of any conflict, the full Disclaimers article governs.

Read the full disclaimer →