Oko/Docs

Command reference

oko defects classes

Lists every shape that is a class or has reached the level with no class yet: its class, its open instances per product, how fast it grows and how far the class's mechanisms have landed and stand.

Invocation#

Command
oko defects classes [--json]

Inputs and options#

  • A shape is a class once it has as many open instances as the level Oko declares beside its source (2, in the words it was declared in, which every refusal quotes). An instance is a defect recorded with the shape that is not a class itself; whitespace and case do not make two shapes different. The class governing a shape is its open class, else the closed class that took its instances over: an open instance of a closed class's shape is a recurrence, which reopens that class (`oko defects reopen`), never a second class.
  • Shapes whose class has not landed every mechanism come first, then the fastest growing: the fewest seconds from the first instance to now per recorded instance.

Output and state effect#

  • Prints `<n> shape(s) at <level> open instances ("<words>") or held by a class`, then one line per shape: `class <id>`, `closed class <id> (its open instances are recurrences)` or `no class`, `<open> open of <recorded> recorded (<product> <count>, …)`, `one instance per <s>s`, `<causes> cause(s), <landed> of <needed> mechanisms landed` followed by `, incomplete`, `, not yet seen installed` or `, all installed since <time>`, or `no cause named`, and how many instances were recorded after the class's first mechanism landed.
  • --json prints `[{shape, class, closed, otherClasses, product, owner, instances, recorded, products, firstFound, newestFound, secondsPerInstance, mechanisms: {causes, needed, landed, allLanded, firstLanded, installedAt} | null, sinceMechanism, signals}]`, `signals` being the process signals a judgment attributed to the class (`attribute`). The native API's defects domain answers `classes {verb: "list"}` the same; OkoKit's `shapeClasses()` and Oko Desktop's Defects → Classes show it.

Refusals and safe exits#

  • An unreadable defect register or class register refuses with its path and cause; nothing is listed as empty in its place.

CLI reference#