okf-tui 1.0.0

data/CHANGELOG.md

@@ -0,0 +1,239 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-08-15
+
+First release.
+
+### Added
+
+- **Six views over OKF bundles**: bundles, browse, search, graph, health, help.
+  It invents no analysis — okf owns the format, the model, and every question on
+  screen.
+- **It targets OKF v0.2, and reads v0.1 as well as okf does.** The rule is okf's
+  own and it decides every §5 surface below: v0.2 only added optional keys, so a
+  bundle that adopted none of them must not read as deficient. A v0.1 bundle
+  reads as v0.1 — no empty columns, no rows saying "unverified" about a family it
+  never had — and §13.1 does the rest, so a v0.1 `timestamp:` shows as the date
+  it records, with no actor invented for it because none was ever recorded. Which spec a bundle is on is asked of the bundle (`Bundle#okf_version`)
+  rather than assumed: the health view names v0.1 or v0.2 as declared, and calls a
+  bundle that declares neither conformant rather than guessing at a number.
+- **§5's provenance, on the concept you are reading.** The browse detail pane says
+  when a concept was generated and by whom, how many sources back it, when it
+  expires, and its status where that status is not the `stable` an absent one
+  already means. The trust tier is the one that needs a rule rather than a
+  presence check: §5.3 *derives* `unverified` for every concept that verified
+  nothing, so printing it unconditionally would paint a provenance verdict onto
+  documents that never made one. `Bundle::RowFilter.shows_trust?` is okf's
+  predicate — shared with its server and its graph page — and the graph facet
+  gates on the same call, so a tier is claimed in exactly one place or in none.
+- **`status` and `trust` are the graph's fourth and fifth facets**, offered only
+  where the bundle has something to say — a status needs one *declared* value,
+  since a column of `stable` is what an undeclared status already means, and
+  trust needs one tier okf is willing to claim. Narrowing goes through
+  `Bundle::RowFilter.matches?`, so the two folds that make this non-trivial are
+  okf's rather than a copy: an absent status reads `stable` here exactly as it
+  does under `--status`, and a tier folds both spellings. The count and the
+  narrowing read one predicate, so a facet selects precisely the rows it counted.
+- **Browse reads a bundle in spec order** — `index.md`, `log.md`, then each
+  directory — and renders concept bodies as markdown. `/` looks through whatever
+  has focus: a list filters, a document finds.
+- **Follow a markdown link out of the document you are reading**: `f` lists what
+  it points at, `1`–`9` or `Enter` goes there, `Esc` puts the body back. The list
+  comes from okf's own link extraction — the same one the graph builds edges
+  with — so a concept reads as its title and a dead link as not written yet.
+  Directory links (`[Decisions](decisions/)`, how every index points at its area)
+  follow to that directory's `index.md`.
+- **`Backspace` returns to wherever a jump started.** Shared by every jump, so
+  opening a search hit and following a concept out of the graph are reversible
+  too.
+- **Search spans every bundle in scope through one shared index**, so the scores
+  compare between them; submitted with `Enter` rather than run per keystroke. The
+  corpus is built once and held — measured over five registered bundles, 129
+  concepts between them: **392 ms** for the first query, then **12–16 ms** for
+  every one after. It is built on first use rather than at load — a session that
+  never searches should not pay to index bundles nobody opened — keyed on the
+  scope, and dropped on any reload, because a held index outliving the set it was
+  built from is a wrong answer rather than a slow one.
+- **`e` chooses how a query is asked** — `fuzzy`, `text` or `regexp`. okf's index
+  and scan disagree *by design*, so offering only the index would leave every term
+  glued to a symbol unfindable with nothing on screen saying so. Measured on okf's
+  own bundle: the index finds three of the five concepts that say `minifts` (a
+  backtick is not punctuation, so a word in a code span indexes as
+  `` `minifts` ``), and returns fourteen results for `OKF_HOME` where the scan
+  returns five, because it splits the term and matches the halves. `text` is okf's
+  own CLI default and has no tokenizer to get in the way; `regexp` is a capability
+  only the scan declares. The mode is named on screen beside the query rather than
+  living only in a keystroke, the hits are keyed on it so switching re-asks rather
+  than relabelling the previous engine's answer, and an unparseable pattern reports
+  itself instead of being rescued into "no matches" — which is indistinguishable
+  from a term that is genuinely absent. One held corpus serves all three; the scan
+  declares no `prepare`, so it reuses the documents rather than an index.
+- **A registry filter that matches nothing offers the search**, exactly as browse
+  does: `Enter` takes the term to view 3 and searches every bundle for it. A filter
+  over a dozen slugs is a narrow thing to be typing, and a term matching none of
+  them is usually a question about what the bundles *say*. Both panes have to be
+  empty, so a filter naming a group still accepts on `Enter`.
+- **The graph is navigable**: pick a type or tag to narrow it, or a concept to
+  open it. A concept whose type is blank or absent is named `Untyped` rather than
+  hidden — §9.2 requires a type, which makes those concepts exactly what a curator
+  is looking for, and okf's own graph index labels them the same way.
+- **`dir` is a third facet in the graph view.** okf 1.11.0 made the full directory
+  path a filter on six verbs and 1.12.0 deprecated the first-segment `--area` for
+  "losing every level below it". Selecting a directory reaches everything beneath
+  it, exactly as `--dir` does, and the counts are the subtree counts `okf dirs`
+  prints. Offered only where the bundle actually nests: at one level deep every dir
+  facet says what a top-level rollup says, which is what `--area` was deprecated
+  for being.
+- **Each bundle's standing** (conformance, curation) colours it wherever it is
+  named, and flags the health tab.
+- **Health is two panes: findings on the left, standing on the right.** One page
+  mixing a bounded summary with an unbounded findings list, list on top, drops the
+  dir traffic and the stats below the fold — and drops them further the more
+  findings a bundle has, which is exactly the bundle whose structure you opened the
+  view to read. The summary cannot be pushed away, and the two scroll apart: `Tab`
+  names which one the keys move. The right pane carries verdicts and numbers and
+  never a path, which is what lets it hold a fixed width; the errors behind its
+  counts are listed on the left, where the columns are. Below 112 columns the two
+  would each be too narrow for the paths a finding is *about*, so the same `Tab`
+  shows one at a time instead.
+- **Health says which checks did not run.** §5.5's freshness pair is clock-gated,
+  and the pure library runs neither unless handed one — so lint reports
+  `expired, stale not run — no clock supplied` rather than letting "lint clean"
+  stand for a verdict it did not earn. A check that quietly sat out is the one way
+  a health screen is worse than no health screen.
+- **The bundle's §5 posture, beside its verdicts.** `trust unverified 31` and
+  `status stable 22 · deprecated 1` — okf's own lint numbers, unedited, on the
+  pane built for numbers. Shown only where the bundle declared something, on the
+  same gate the facets use, and a tier the bundle has none of is dropped rather
+  than clipped: this pane holds a fixed width because its rows are short by
+  construction, and all three tiers with their counts is not.
+- **Hubs and directory traffic, on the health view.** `Bundle#hubs` ranks concepts
+  by inbound links and says which directories those links come from — the evidence
+  for "is this hub well homed?" A hub drawing its majority from outside its own
+  top-level dir is flagged, and where a single foreign dir carries that majority it
+  is named, because that is the better home the concept has already found.
+  `Bundle#skeleton` adds the same question one grain coarser: each directory's
+  internal, outbound and inbound traffic, with the internal share as a
+  **cohesion**, sorted so the directories with a case to answer come first. A
+  directory with no traffic at all reads `—` rather than a `0%` it did not earn.
+  Evidence, not verdicts: okf is explicit that near-zero cohesion under heavy
+  inbound can be a shared vocabulary doing its job.
+- **The directory arcs, under the cohesion table.** The table says how much of a
+  directory's traffic stays home; the arcs say where the rest of it goes, which is
+  the other half of `graph --traffic` and the half that names a pair. Narrowed to
+  the cut okf *fits to the bundle* — asked for rather than guessed, since okf
+  measured ten bundles at a fixed weight and got anywhere from 2 arcs to 136 — and
+  the row says how many of how many survived it, because a silently shortened list
+  reads as a complete one. Cohesion is still computed over every arc, which is
+  okf's rule and is asserted, so narrowing the picture never moves the evidence.
+- **Registry configuration in place** — `a` registers a bundle, `x` removes one,
+  `d` sets the default, `n` renames. Every write goes through okf's `Registry` and
+  is followed by a reload, so the screen shows what the file now says rather than
+  what memory believes. `okf registry init` is deliberately not offered: the
+  registry is resolved once at boot, so creating one mid-session would swap the
+  whole workspace out from under every open view rather than edit the one it is on.
+- **Registry groups are on screen, and one key scopes a search to one.** A group
+  is a named, recursive set of bundles — which is to say a named search scope, and
+  the scope is what this view already manages. Groups list under their own heading
+  with the bundles they resolve to; `Enter` makes a search cover exactly those, the
+  same set `okf search @group` merges into one ranking. The detail pane shows the
+  members as the registry records them *and* the bundles they resolve to, because
+  for a nested group those differ. A member naming nothing registered is called out
+  rather than dropped, and a hand-edited cycle — which okf refuses to create and
+  reports by declining to resolve — says so and refuses to be scoped rather than
+  silently covering nothing.
+- **Groups can be built and edited here too**, which takes the TUI to seven of
+  okf's eight `registry` verbs. `c` names the bundles now in scope as a new group,
+  because `◉` already means "these bundles" in this view; `+` adds, `-` removes,
+  `n` renames and `x` deletes. okf owns every cascade — a rename reaches every
+  member list that named the group, a delete drops it from all of them, and a group
+  left with no members is deleted.
+
+  **The bundles view is three panes** — the registry's bundles, its groups, and the
+  detail of whichever has focus — with `Tab` cycling and `Esc` stepping back out
+  one pane at a time. A heading inside the bundle list scrolls away: thirteen
+  registered bundles put the groups below the fold on a short terminal, which is no
+  way to show something you are meant to select.
+
+  Two panes also mean two selections at once, and that is what makes the editing
+  keys direct. Each acts on a row that is on screen: `+` in the bundles pane adds
+  the bundle under that cursor to the group selected below, `-` in the members pane
+  removes the member under that cursor, and `n`/`x` in the groups pane rename or
+  delete the selected group. Nothing consults the search scope except `c`, where
+  naming the bundles you have been searching together is the point. The groups pane
+  keeps its cursor while the bundles have focus, dimmed, so the row `+` acts on is
+  one the reader can point at — and the footer deliberately does not spell that
+  group's slug out, since naming an off-screen target claims a selection nothing on
+  screen agrees with.
+
+  The removal key reads a row for that reason above all. A `-` acting on the
+  *intersection* of the scope and the member list would act on a set with no row
+  on screen, so the key could not be predicted without computing it in your head,
+  and its most obvious misreading ("turn the scope off") would take a whole group
+  with it. Anything that can lose configuration asks first and names the
+  consequence — `x`,
+  and `-`, which says when the member being removed is the last one and the group
+  goes with it. `+`, `c` and `d` add or reorder, and do not ask.
+
+  A `+` has to change something visible, and what it changes is not the row: the
+  bundle detail pane lists every group that names the bundle — `in @docs
+  @everything` — and the status line names both sides of the write,
+  `@minimal joined @docs — 3 bundles`. An edit to a group that *is* the scope in
+  force re-applies that scope, in both directions, so set equality keeps holding
+  and the bundle just added does not read as out of scope on its own row. A group
+  nobody scoped is left alone, since re-scoping on every edit would replace a
+  hand-made selection.
+- **The status row is either asking you something or telling you something**, and
+  it wears yellow for the first and cyan for the second — one colour each tells the
+  two apart before a word is read. A flash can afford the mark because the next
+  keystroke clears it along with the message, so it cannot become permanent noise.
+- **Quitting is `q q`.** A single `q` ends a session on one stray keystroke; the
+  first press arms and says so, and any other key disarms it. `Ctrl-c` still quits
+  outright.
+- **`okf tui` is the entry point, and the only one — this gem ships no
+  executable.** okf dispatches through a command registry and finds extensions by
+  convention (any gem with `okf/plugin.rb` on its load path can register a verb),
+  so installing this gem is the whole installation: no configuration, and `okf
+  help` lists `tui` under `installed extensions:`. There is no second binary: one
+  that only aliased the verb would be one more name to install, document and keep
+  working, and two front ends are two argument grammars waiting to drift, with
+  each one passing its own tests while they disagree. What ships instead is one
+  adapter that carries argv and the streams and adds nothing else, which a test
+  pins by running the same invocation both ways and comparing the message.
+- **Every ref form okf's other multi-bundle verb takes**:
+  `@slug`, bare `@` for the registry default, `@group` fanned out to its members, a
+  vanished member skipped with a note, and `@all` refused by name as search's
+  alone. The grammar is *inherited* rather than copied — `OKF::TUI::Refs`
+  subclasses `OKF::CLI::Command` for okf's own resolver — so there is one copy of
+  it, and a test pins the seam so that okf moving it fails loudly instead of
+  quietly restoring "not a directory".
+- **A project-local `.okf-registry.json` resolves ahead of the global one**, the
+  same as every other okf verb, discovered by walking up from the working
+  directory; `OKF_NO_DISCOVERY=1` opts out and `$OKF_HOME` names the global one.
+  Reloads go through `Registry#reopen` so a local registry's relative paths keep
+  the anchor they are stored against. The library keyword mirrors okf's own rule:
+  `Workspace.new(cwd:)` opts in, and an embedding app that passes no cwd stays
+  global-only.
+
+### Requires
+
+- **Ruby >= 2.4**, the same floor as okf.
+- **`okf >= 2.0, < 3`** — the kernel release that ships OKF v0.2. A real floor and
+  not a formality: eleven okf capabilities are load-bearing here, and the gemspec
+  lists which and why. Most of them fail *silently* against an older okf — a
+  renamed field reads as nil, a missing method is rescued into "no matches" —
+  which is why the floor is stated rather than left to chance, and why the boot
+  checks stay: `OKF::TUI.search_capable?` and `.spec_capable?` refuse to start and
+  name the okf that answered, because resolution cannot stop a second one sitting
+  ahead of the intended one on the load path. The ceiling is earned rather than
+  conventional, and by the same evidence: an okf *major* is where the silent drift
+  comes from (`area` → `top_dir`, then `timestamp` → `generated_at`), so `< 3`
+  turns the next one into a resolution failure a maintainer sees instead of a
+  wrong number a reader believes.
+
+[1.0.0]: https://github.com/serradura/okf-gem/releases/tag/okf-tui/v1.0.0

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Rodrigo Serradura
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,10 @@
+OKF gem
+Copyright (c) 2026 Rodrigo Serradura
+
+Licensed under the Apache License, Version 2.0 (see LICENSE.txt).
+
+This product bundles the Open Knowledge Format (OKF) v0.1 specification
+(lib/okf/skill/reference/SPEC.md), authored by Google Cloud Platform and
+licensed under the Apache License, Version 2.0, Copyright (c) Google LLC.
+Source: https://github.com/GoogleCloudPlatform/knowledge-catalog
+Full license text: lib/okf/skill/reference/APACHE-2.0.txt

data/README.md

@@ -0,0 +1,194 @@
+# okf-tui
+
+A full-screen terminal UI for [Open Knowledge Format](https://github.com/serradura/okf-gem)
+bundles: read one, switch between many, configure the registry, and search
+across all of them at once. Built on the [TTY toolkit](https://ttytoolkit.org/components/).
+
+Installing it teaches `okf` a verb. There is no second command to learn and
+nothing else to set up:
+
+```bash
+gem install okf-tui
+okf tui                       # every bundle in your registry
+okf tui path/to/bundle ...    # those bundles, ad-hoc — the registry is left alone
+okf tui @handbook             # a registered bundle; bare @ is the default
+okf tui @backend              # a registry group, fanned out to its members
+OKF_HOME=/tmp/scratch okf tui # a different global registry
+okf help                      # lists `tui` under "installed extensions:"
+```
+
+This gem ships **no executable of its own** — deliberately. A second binary that
+only aliased `okf tui` would be one more name to install, document and keep
+working, and two front ends is two argument grammars waiting to drift. `okf`
+finds this gem because it ships `okf/plugin.rb`, the convention any gem can use
+to add a verb — see [extension points](https://github.com/serradura/okf-gem/blob/main/.okf/design/extension-points.md).
+
+The argument shape mirrors `okf server` exactly, because it is the same grammar:
+`@slug` names a registered bundle, bare `@` the registry default, `@group` fans out
+to its members, and `@all` is refused as `okf search`'s alone. Naming directories
+is an ad-hoc look at them and never enrols them in the registry — registering stays
+an explicit act, here the `a` key.
+
+## Six views
+
+| View | Answers |
+|------|---------|
+| **1 bundles** | What can I open, which is active, which is the default — the registry's groups, and all registry config |
+| **2 browse**  | What is in the bundle, in reading order — `index.md`, `log.md`, then each directory |
+| **3 search**  | Which concept covers X — across *every bundle in scope*, ranked together, in whichever of okf's engines answers it |
+| **4 graph**   | What shape is its knowledge — narrow by type, tag or dir, or pick a concept to go read |
+| **5 health**  | Is it legal, well curated, and well structured — findings on the left (`validate`, `lint`, hubs), standing on the right (dir cohesion, the arcs between dirs, stats) |
+| **6 help**    | The keys |
+
+Browse is where okf's §6 map lands too: `/index` narrows the list to the way in
+each directory authored, one row per directory, and opens the authored file.
+
+## Two axes, kept apart
+
+"Which bundle" is really two questions, and they move independently:
+
+- the **active bundle** (`●`) — what browse, graph and health are about. `Enter`
+  on a bundle changes it.
+- the **scope** (`◉`) — which bundles a search covers. `space` toggles one, `A`
+  all, `N` none, and `Enter` on a group makes it exactly that group's bundles.
+  `N` is how you start a fresh selection.
+
+So you can read one bundle while searching all of them. Opening a search hit
+that lives in a *different* bundle switches the active bundle to it.
+
+The scope is also what the search corpus is built over, and it is built **once** and
+held — the first query pays for it, the rest are effectively free. Changing the
+scope or reloading drops it, because an index that outlives the set it was built
+from gives a wrong answer rather than a slow one.
+
+`e` chooses how the query is asked, because okf's two engines disagree by design
+and each is wrong for what the other is right for:
+
+| Mode | Engine | Good for |
+|------|--------|----------|
+| `fuzzy` | full-text index | ranked results, forgives typos |
+| `text` | raw scan (okf's own default) | `$OKF_HOME`, `` `minifts` ``, `7.2.0` — terms the index tokenizer splits apart |
+| `regexp` | raw scan | a pattern over the same text |
+
+An unparseable pattern says so rather than quietly returning nothing.
+
+Search runs **one index over every scoped bundle**, which is what makes the
+scores comparable between them rather than only within one — the same thing
+`okf search @all` does.
+
+## `/` looks through whatever has focus
+
+One key, whichever thing the cursor is in:
+
+- **a list** — filters it. Bundles by slug or path, browse by title, id, type or
+  tag, graph by type, tag or concept id.
+- **a document** — the concept body, and the health and help pages — finds
+  within it and scrolls to the hit, with `n` / `N` stepping through the matches.
+
+Nothing grabs the field on arrival, so `1`–`6` mean the same thing everywhere.
+In search, `Enter` submits the query and `Esc` stops editing without leaving the
+view.
+
+When a browse filter matches nothing, `Enter` takes the term to the search view
+and runs it across every bundle — the filter reads metadata in one bundle, and
+search reads bodies across all of them.
+
+## `f` follows a link out of the page
+
+A bundle is a graph, and its markdown links are the edges. `f` lists the ones
+leaving the document you are reading — pick with `↑` `↓` and `Enter`, or press
+`1`–`9` to go straight there. `Esc` puts the body back where you left it, and
+`Backspace` returns you to wherever you jumped from.
+
+It reads as what is at the far end, not as the path it was written with: a
+concept by its title, a nested `index.md` by its area, and a link with nothing
+behind it as knowledge not written yet. That last one is `lint`'s to report, not
+an error to raise.
+
+The reserved files are where this earns its keep — an `index.md` is a list of
+links by design (§6) and `log.md` is a list of what changed where, so both become
+menus into the bundle. The trail is shared, so opening a search hit or following
+a concept out of the graph is undone by the same key.
+
+## The bundle wears its verdict
+
+A bundle is clean, has lint warnings, or is not conformant, and that one
+judgement drives its colour everywhere it is named — the header, the footer
+badge, its row in the registry, its detail pane. The **health tab carries it
+too**, so a problem is visible from any view without opening the tab.
+
+## Registry config
+
+In the bundles view: `d` default, `a` add, `n` rename, `x` remove (asks first),
+`r` reload. Each writes the registry file and re-reads from disk, so the screen
+shows what the file now says. Removing a bundle never touches the bundle on
+disk — the registry is a list of references.
+
+It edits your *configuration*, never your knowledge: there is no bundle writing
+anywhere in this gem. Authoring belongs to `okf` and its companion skill.
+
+**Groups.** A registry group is a named, recursive set of bundles — which is to
+say a named search scope. Groups list under their own heading, and `Enter` on one
+makes a search cover exactly its bundles: the same set `okf search @backend`
+merges into one ranking. The detail pane shows both the members the registry
+records and the bundles they resolve to, since for a nested group those differ.
+
+**The view has three panes**, and `Tab` cycles them: the registry's bundles, its
+groups, and the detail of whichever of the two has focus. `Esc` steps back out one
+pane at a time. Two panes means two selections at once, and that is what makes
+editing direct — every key acts on a row you can see:
+
+| Key | Pane | Does |
+|-----|------|------|
+| `Enter` | groups | make a search cover exactly this group's bundles |
+| `+` | bundles | the bundle under this cursor joins the group selected below |
+| `-` | members | remove the member under this cursor |
+| `n` / `x` | groups | rename or delete the group; okf cascades through every member list |
+| `c` | bundles | name the bundles now in scope as a new group |
+
+Anything that can lose configuration asks first and names what it is about to do —
+`x`, and `-`, which says when the member you are removing is the last one and the
+group goes with it. `+`, `c` and `d` add or reorder, and do not ask.
+
+**Which registry.** The same one every other `okf` verb run from the same
+directory resolves: a project-local `.okf-registry.json` when one is on the path
+up from here, and `$OKF_HOME` (default `~/.okf`) otherwise. `OKF_NO_DISCOVERY=1`
+forces the global one. The header names the file it read, so there is never a
+question which is in force. A workspace of directories named on the command line
+has no registry, and says so rather than pretending to configure one.
+
+## It invents no analysis
+
+`OKF::Bundle::Reader` and `OKF::Registry` are the only parts that touch disk;
+everything on screen is a pure call on the resulting in-memory bundles —
+`catalog`, `graph`, `validate`, `lint`, `directories`, `hubs`, `skeleton`,
+`Bundle::Search`. The TUI is one more shell over the same core the `okf` CLI and
+the graph server already use.
+
+That is a rule with teeth, not a slogan: the dir facet's counts are checked in CI
+against `okf dirs --json`, and the cohesion table against `okf graph --traffic`,
+row for row. If okf and this disagree about a number, the suite fails.
+
+It keeps okf's contracts visible too: `validate` and `lint` are separate
+sections because they answer different questions, reads are best-effort so an
+unreadable file is reported (`⊘ n unreadable`) rather than fatal, and a bad
+directory exits `2`, the usage-error code.
+
+## Requirements
+
+Ruby >= 2.4 — the same floor as okf, which takes it from rack: the tool should
+run on whatever Ruby the OS already ships. `okf >= 2.0` is the other requirement,
+and installing this gem pulls it in: every screen here answers with something the
+kernel's OKF v0.2 work published, and against an older one each would fail
+silently rather than loudly.
+
+## Development
+
+`bin/setup` to install, `bundle exec rake` to run the tests and RuboCop.
+`bundle exec okf tui` runs it from the checkout — okf is a bundle dependency, so
+the verb resolves the same way it does for a user. See [AGENTS.md](AGENTS.md)
+for the contracts a change has to keep.
+
+## License
+
+Apache-2.0.