Skip to content

app-console-keys — console chassis and F-key framework

app-console-keys is the always-installed base chassis of os-console. All other console modules — email, content, SLM monitoring, and the rest — are optional cartridges that plug into the framework app-console-keys defines. The module is mandatory: an os-console binary built without it will not compile.

Naming note: "keys" in app-console-keys refers to keyboard function keys — the F1 through F12 strip that navigates between cartridge slots. It does not refer to cryptographic keys. Cryptographic pairing and machine-based authorization are implemented by system-gateway-mba, a separate crate.

The Cartridge trait

app-console-keys defines the Cartridge trait — the interface every app-console-* module must implement. The trait is minimal: a module declares which F-key slot it occupies, what to render when that slot is active, and how to handle keyboard input while active. The chassis handles everything else: slot registration, input dispatch, focus management, and the status bar.

Because cartridges are compiled directly into the os-console binary rather than loaded at runtime, the trait is a compile-time contract. A module that fails to implement it produces a build error, not a runtime failure.

The F-key navigation strip

The primary interface element managed by app-console-keys is the horizontal F-key tab strip at the top of the console. The strip shows one slot per registered cartridge. The active slot is highlighted; inactive slots are greyed when not installed.

The strip does not re-order slots at runtime. Each cartridge's slot position is fixed at the F-key number it claims. app-console-input is permanently fixed at F12 per SYS-ADR-10.

The status bar

The app-console-keys status bar runs along the bottom of the console and is always visible, regardless of which cartridge slot is active. It displays:

Component Content
Identity Username and tenant set during the pairing ceremony
Authorization state MBA LINK ACTIVE, MBA LINK INACTIVE <reason>, or MBA LINK PENDING
Active slot Name of the currently focused cartridge
SLM tier Tier A (local), Tier B (cloud burst), or Tier C (frontier API)
Session duration Elapsed time since console start

The tier indicator reflects the last routing decision made by the inference gateway. It does not poll the gateway — it updates when a request is routed.

Authorization client

app-console-keys maintains the outbound machine-based authorization connections to paired os-* services. Each pairing is independent: the console can hold an active link to os-totebox while the link to os-privategit is inactive.

When an authorization link is inactive, the affected cartridge degrades gracefully. Locally cached content remains accessible; backend requests fail with an explicit status rather than silently. No cartridge crashes the chassis when its backend is unreachable.

Configuration

Profile-based configuration is stored at ~/.config/os-console/config.toml. The configuration file controls which backend services the console attempts to pair with at startup, display preferences, and the SSH server port (if the SSH server feature is compiled in).

PDF rendering and graphics support

app-console-keys provides the graphics infrastructure used by cartridges that render images or PDFs. PDF pages are rendered to RGB bitmaps using the pdfium-render library. The display path uses the Kitty graphics protocol as the primary path, with Sixel encoding as a fallback, and an error message for terminal environments that support neither.

See also

  • console-os — the os-console product overview, including the F-key surface and operating modes
  • os-console-platform — the complete cartridge architecture and F-key map
  • app-console-input — the F12 mandatory input gate; always compiled alongside app-console-keys
  • machine-based-auth — the authorization mechanism the chassis client manages
  • three-ring-architecture — the Ring 1/2/3 architecture the authorization client connects to
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 →