Glossary
The words ARKI docs use, one plain sentence each. The "formerly" column lists old names that still appear in older pages, so you can match them to the current word.
21 terms · link to one with /docs/glossary#<term>
| Term | What it means | Where to read | Formerly |
|---|---|---|---|
| plugin | What it meansA unit of an app that needs some services and provides others, and has five hooks: configure, boot, start, stop, dispose. | Where to readPlugin authoring | FormerlyPip |
| app | What it meansThe list of plugins you build with defineApp(name).use(a).use(b); the order of .use() is the boot order. | Where to readQuickstart | FormerlycreateDot(...) (a compatibility alias only) |
| feature | What it meansOne chain made with defineFeature(name) from @arki/dot/feature that holds a slice of your product: its needs, infra, usecases and entrypoints. | Where to readAgent guide | Formerly |
| usecase | What it meansA function inside a feature that does one thing your product does. | Where to readAgent guide | Formerly |
| action | What it meansA named operation an app exposes, listed in the manifest. | Where to readDiagnostics | Formerly |
| adapter | What it meansA /dot entry of a package (for example @arki/db/dot) that wraps the package as a plugin; @arki/dot never imports adapters. | Where to readAdapter authoring | Formerly |
| handle | What it meansA typed key a plugin uses to ask for a service or to provide one. | Where to readPlugin authoring | Formerly |
| service witness | What it meansA service<T>() marker that tells the compiler which type a service has, without a value at runtime. | Where to readPlugin authoring | Formerly |
| wire key | What it meansThe name under which a plugin provides a service; two providers of one key collide. | Where to readAgent guide | Formerly |
| manifest | What it meansThe static graph of an app (plugins, services, actions, dependencies, lifecycle); dot explain --json prints it. | Where to readDiagnostics | Formerly |
| diagnostic | What it meansA snapshot of a running app (per-plugin status, lifecycle, issues), each issue with a stable code and a remediation; dot doctor --json prints it. | Where to readDiagnostics | Formerly |
| app graph | What it meansThe picture of which plugins need which services; the manifest holds it. | Where to readAgent guide | Formerly |
| boot check | What it meansA run of dot doctor: it calls configure(), then boot(), reads the diagnostics, then dispose(), and never calls start(). | Where to readAgent guide | Formerly |
| failure | What it meansAn expected outcome returned as a value (made with defineFailure), not thrown; bugs and bad config still throw. | Where to read@arki/failure | Formerly |
| tier | What it meansA group of packages by role: Tier 1 is the app stack, Tier 2 is the standalone libraries. | Where to read | Formerly |
| leaf library | What it meansA Tier 2 package that depends on no other ARKI package at runtime, so it works on its own. | Where to read | Formerly |
| source-distributed | What it meansA package that ships TypeScript or CSS source, not a built bundle, because the app's bundler builds it. | Where to readRelease policy | Formerly |
| wave | What it meansA set of packages published together, in an order where dependencies come first. | Where to read | Formerly |
| candidate | What it meansThe frozen set of tarballs for a wave; the bytes checked are the bytes published. | Where to read | Formerly |
| mirror | What it meansA read-only GitHub repository (arki-labs/<name>) that holds one published package version; source and issues live at arki-labs/arki. | Where to read | Formerly |
| X-ray | What it meansA screen in a demo app that shows what the app really did, such as each action and the AI provider and cost of each call. | Where to read | Formerly |