Šķîþ ţö ḿàîñ çöñţéñţ

Ţéŕḿš ƃüñđļé (.terms.json)

À ţéŕḿš ƃüñđļé îš ţĥé þöŕţàƃļé, ļöššļéšš šéŕîàļîžàţîöñ öƒ à þŕöĵéçţ'š ţéŕḿîñöļöĝý: ţĥé çöñçéþţš à þŕöĵéçţ ĥàš àĝŕééđ öñ, ţĥéîŕ ţéŕḿš þéŕ ļöçàļé, àñđ ţĥé ŕéļàţîöñš ƃéţŵééñ ţĥéḿ.

À ţéŕḿš ƃüñđļé îš à çöḿḿîţţéđ, ĝîţ-ţŕàçķéđ ƒîļé, ļîķé ţĥé çöñţéñţ-ḿéḿöŕý ƃüñđļé ţĥé ŕéçîþé ƃîñđš. Îţ îš ţĥé ŕéṽîéŵ šüŕƒàçé, ţĥé àŕţîƒàçţ à þéŕšöñ ŕéàđš îñ à þüļļ ŕéǫüéšţ ŵĥéñ à ţéŕḿ çĥàñĝéš. Ţĥé ţéŕḿš ţàƃļéš îñ ţĥé þŕöĵéçţ šţöŕé (.kapi/work/store.db) àŕé ţĥé ĝîţîĝñöŕéđ îñđéẋ ţĥé ƃüñđļé çöḿþîļéš îñţö, ñéṽéŕ ţĥé öţĥéŕ ŵàý ŕöüñđ.

Îḿþļéḿéñţéđ îñ Ĝö àţ terms/ktb.

Ŵĥéñ kapi ŵŕîţéš öñé​

  • kapi terms export --format bundle: ţĥé éẋþļîçîţ éẋþöŕţ.
  • kapi pack: àš ţĥé terms.json ḿéḿƃéŕ îñšîđé à .kpz.

kapi terms import àççéþţš csv, tsv, json, tbx, öŕ bundle. Öñļý bundle îš ļöššļéšš; ţĥé ŕéšţ àŕé çöṽéŕéđ üñđéŕ ŵĥàţ ţĥé öţĥéŕ ƒöŕḿàţš đŕöþ.

Ţĥé ļööķüþ ļàđđéŕ​

Ŵĥéñ à ƒļöŵ ñééđš à þŕöĵéçţ'š ţéŕḿš àñđ ţĥé ŕéçîþé đöéš ñöţ ƃîñđ öñé éẋþļîçîţļý, kapi ļööķš ƒöŕ à çöñṽéñţîöñàļ ƃüñđļé îñ ţĥîš öŕđéŕ:

  1. <project-root>/.kapi/terms.json
  2. <project-root>/terms.json

Ţĥé çöñţéẋţ ĝŕàþĥ ƒîŕšţ. .kapi/ îš ŵĥéŕé ţĥé ŕéšţ öƒ à þŕöĵéçţ'š ĝöṽéŕñàñçé ļîṽéš (ţĥé ṽöîçé þŕöƒîļé, ţĥé ḿéḿöŕý šééđš, ţĥé üñîţ-šţàţé ŕéçöŕđ), àñđ ţéŕḿš àŕé öñé ñöđé öƒ ţĥàţ ĝŕàþĥ ŕàţĥéŕ ţĥàñ à ļööšé ƒîļé ƃéšîđé îţ. Îţ îš çöḿḿîţţéđ, šö à ƃüñđļé ķéþţ ţĥéŕé àþþéàŕš îñ à đ, ĝéţš ŕéṽîéŵéđ, àñđ šüŕṽîṽéš à ƒŕéšĥ çļöñé. Ţĥé ŕööţ ŕüñĝ îš ƒöŕ à þŕöĵéçţ ţĥàţ ŵöüļđ ŕàţĥéŕ ķééþ îţš ţéŕḿš àţ ţĥé ţöþ ļéṽéļ; ƃöţĥ àŕé çöḿḿîţţéđ, šö ţĥé öŕđéŕîñĝ îš àƃöüţ ŵĥéŕé à ŕéàđéŕ éẋþéçţš ţö ļööķ.

Ţĥé ŕéçîþé ƃîñđîñĝ ŵîñš öṽéŕ ƃöţĥ. Šéţţîñĝ terms_source îñ kapi.yaml ñàḿéš ţĥé ƒîļé éẋþļîçîţļý àñđ šķîþš ţĥé ļàđđéŕ éñţîŕéļý; îţ ƃîñđš àñý þàţĥ.

Çöñţéñţ ḿéḿöŕý ĥàš ñö éǫüîṽàļéñţ ļàđđéŕ​

À þŕöĵéçţ ĥàš öñé ţéŕḿš ƃüñđļé, šö à šîñĝļé çöñṽéñţîöñàļ ƒîļéñàḿé îš ḿéàñîñĝƒüļ. Çöñţéñţ ḿéḿöŕý îš þļüŕàļ: ţĥîš ŕéþöšîţöŕý'š öŵñ đöĝƒööđ ŕéçîþé ķééþš à šéþàŕàţé ḿéḿöŕý ƃüñđļé þéŕ šüŕƒàçé. À šîñĝļé ŵéļļ-ķñöŵñ memory.json àţ ţĥé þŕöĵéçţ ŕööţ ŵöüļđ ƒöŕçé éṽéŕý þŕöĵéçţ îñţö öñé ƃüñđļé, àñđ à ļàđđéŕ ţĥàţ ŕéšöļṽéđ ţö "ŵĥîçĥéṽéŕ öñé îš ƒîŕšţ" ŵöüļđ šîļéñţļý þîçķ ţĥé ŵŕöñĝ öñé.

Šö ţéŕḿš ĝéţš à ļàđđéŕ àñđ çöñţéñţ ḿéḿöŕý đöéš ñöţ.

Éñṽéļöþé​

{
  "schemaVersion": "1.0",
  "kind": "kapi-terms",
  "created": "2026-07-26T09:12:04Z",
  "generator": { "id": "kapi", "version": "1.2.3" },
  "concepts": [],
  "relations": []
}
ƑîéļđŢýþéÑöţéš
schemaVersionšţŕîñĝMAJOR.MINOR. Üñķñöŵñ ḿàĵöŕ ŕéĵéçţéđ; üñķñöŵñ ḿîñöŕ öƒ à ķñöŵñ ḿàĵöŕ àççéþţéđ.
kindšţŕîñĝÀļŵàýš kapi-terms.
createdšţŕîñĝŔƑÇ 3339. Öþţîöñàļ.
generatoröƃĵéçţ{id, version}. Öþţîöñàļ.
conceptsàŕŕàýŢĥé çöñçéþţš. Àļŵàýš þŕéšéñţ.
relationsàŕŕàýŔéļàţîöñš ƃéţŵééñ çöñçéþţš. Öḿîţţéđ éñţîŕéļý ŵĥéñ ţĥéŕé àŕé ñöñé.

concepts àñđ relations ŕéüšé ţĥé ţéŕḿš šţöŕé'š öŵñ ţýþéš đîŕéçţļý ŕàţĥéŕ ţĥàñ à þàŕàļļéļ ŵîŕé šţŕüçţ, šö ţĥé šéŕîàļîžàţîöñ çàññöţ đŕîƒţ ƒŕöḿ ţĥé ḿöđéļ îţ šéŕîàļîžéš.

Đéţéŕḿîñîšḿ​

Marshal þŕöđüçéš ƃýţé-šţàƃļé öüţþüţ: çöñçéþţš àñđ ŕéļàţîöñš šöŕţéđ ƃý îđ, ţéŕḿš ŵîţĥîñ à çöñçéþţ šöŕţéđ, ţîḿéšţàḿþš ñöŕḿàļîžéđ ţö ÜŢÇ, ĤŢḾĻ éšçàþîñĝ öƒƒ, ţŵö-šþàçé îñđéñţ, ţŕàîļîñĝ ñéŵļîñé. Ţŵö éẋþöŕţš öƒ ţĥé šàḿé šţöŕé àŕé ţĥé šàḿé ƃýţéš, šö à ƃüñđļé đš çļéàñļý àñđ çàñ ƃé ĥàšĥéđ àš à üñîţ, ŵĥîçĥ îš ŵĥàţ ļéţš îţ šîţ îñšîđé à .kpz üñđéŕ ţĥé þàçķàĝé'š Ḿéŕķļé ŕööţ.

Ŵĥàţ ţĥé öţĥéŕ ƒöŕḿàţš đŕöþ​

kapi terms export àļšö éḿîţš csv, json, àñđ tbx (tsv îš àççéþţéđ öñ import only). All three are lossy, and the JSON one is the easiest to mistake ƒöŕ ţĥé ƃüñđļé ƃéçàüšé ƃöţĥ àŕé ĴŠÖÑ:

  • --format json ŵŕîţéš {name, version, concepts} àñđ ñöţĥîñĝ éļšé. Îţ çàŕŕîéš ñö ŕéļàţîöñš àţ àļļ, àñđ îţš éñṽéļöþé ĥàš ñö kind ḿàŕķéŕ, šö îţ çàññöţ ƃé šñéđ, àñđ à ŕéàđéŕ çàññöţ ţéļļ ŵĥîçĥ šçĥéḿà îţ îš ĥöļđîñĝ. Îţ îš à çöñṽéñîéñçé éẋþöŕţ ƒöŕ šþŕéàđšĥééţš àñđ šçŕîþţš.
  • --format tbx îš ţĥé îñđüšţŕý îñţéŕçĥàñĝé ƒöŕḿàţ. Îţ ĥàš ñö ŕéþŕéšéñţàţîöñ ƒöŕ ţĥé çŕöšš-ļîñķš ţĥàţ ḿàķé à kapi çöñçéþţ üšéƒüļ îñšîđé kapi, ḿöšţ ñöţàƃļý ţĥé éñţîţý çŕöšš-ŕéƒéŕéñçéš çöñţéñţ ḿéḿöŕý üšéš.
  • --format csv îš ƒļàţ: öñé ŕöŵ þéŕ ţéŕḿ, ñö çöñçéþţ šţŕüçţüŕé àñđ ñö ŕéļàţîöñš.

Ŕéàçĥ ƒöŕ bundle ŵĥéñéṽéŕ ţĥé ƒîļé îš šţàýîñĝ îñšîđé kapi.

Ŵĥàţ îš đéļîƃéŕàţéļý ñöţ îñ îţ​

  • Ţĥé çöḿþîļéđ ŠǪĻîţé ţàƃļéš. Ţĥé ţéŕḿš ţàƃļéš îñ .kapi/work/store.db àŕé đéŕîṽéđ ƒŕöḿ ţĥé ƃüñđļé àñđ ŕéƃüîļţ öñ îḿþöŕţ.
  • Ḿàţçĥ šţàţé. Ŵĥîçĥ ƃļöçķš à ţéŕḿ ŵàš ƒöüñđ îñ îš à çĥéçķ ŕéšüļţ ŕàţĥéŕ ţĥàñ à þŕöþéŕţý öƒ ţĥé ţéŕḿîñöļöĝý; kapi terms occurrences ŕéàđš îţ ƒŕöḿ ţĥé þŕöĵéçţ'š ƃļöçķ çàçĥé.

Šéé àļšö​