ķàþî îñšþéçţ

$ kapi inspect [flags] [FILE...]

▒ Ŕéàđ éàçĥ ƒîļé îñţö öñé ŕéçöŕđ þéŕ çöñţéñţ ƃļöçķ. Àñý ƒöŕḿàţ, ŵĥéţĥéŕ à Ŵöŕđ đöçüḿéñţ, à ĴŠÖÑ çàţàļöĝ, Ḿàŕķđöŵñ öŕ ĤŢḾĻ, ýîéļđš ţĥé šàḿé šĥàþé, šö àñ àĝéñţ öŕ à šçŕîþţ çàñ ŕéàđ çöñţéñţ àñđ šéñđ éđîţš ƃàçķ ţö ţĥé šàḿé ƃļöçķš ŵîţĥ ķàþî àþþļý:

ŕéƒ ţĥé ƃļöçķ'š ŕéƒéŕéñçé, {"doc", "block", "edition"}, ţö çöþý îñţö àñ öþéŕàţîöñ'š "àţ" ŕéṽ ţĥé ŕéṽîšîöñ öƒ ţĥé ƃļöçķ'š ţéẋţ, ţö šéñđ àš "îƒ_ḿàţçĥ" ţéẋţ ţĥé ţéẋţ, ŵîţĥ îñļîñé çöđéš àš <ẋ îđ="…"/> þļàçéĥöļđéŕš çöđéš éàçĥ îñļîñé çöđé ƃý ţĥé îđ îţš þļàçéĥöļđéŕ šĥöŵš: îţš ţýþé, îţš àţţŕîƃüţéš, àñđ ţĥé àţţŕîƃüţéš àñ éđîţ ḿàý çĥàñĝé šţŕüçţüŕéš éàçĥ þļüŕàļ öŕ šéļéçţ, ŵîţĥ ţĥé þàţĥ ţö éàçĥ ƃŕàñçĥ àñđ ţĥé ƃŕàñçĥ'š ţéẋţ éđîţîöñš ţĥé ƃļöçķ'š öţĥéŕ éđîţîöñš, éàçĥ ŵîţĥ îţš ŕéṽîšîöñ àñđ ţéẋţ, àñđ ţĥé šţàţüš ţĥé ƒîļé ŕéçöŕđš ƒöŕ îţ ŵĥéŕé îţ ķééþš öñé öþš ţĥé öþéŕàţîöñš ţĥé ƃļöçķ àççéþţš ŕöļé, ļéṽéļ ţĥé ƃļöçķ'š šţŕüçţüŕàļ ŕöļé (ĥéàđîñĝ, ļîšţ-îţéḿ, ţàƃļé-çéļļ, …) àñđ ñéšţîñĝ ļéṽéļ

Îñšîđé à þŕöĵéçţ (ţĥé öñé -þ ñàḿéš, öŕ ţĥé öñé ƒöüñđ ƒŕöḿ ţĥé ŵöŕķîñĝ đîŕéçţöŕý) à ƒîļé îš ñàḿéđ ƃý îţš þŕöĵéçţ-ŕéļàţîṽé þàţĥ àñđ ŕéàđ ŵîţĥ ţĥé ƒöŕḿàţ àñđ çöñƒîĝüŕàţîöñ ţĥé ŕéçîþé ƃîñđš, àñđ éàçĥ đéçļàŕéđ ţŕàñšļàţîöñ îš ļîšţéđ àḿöñĝ ţĥé éđîţîöñš. À ƒîļé öüţšîđé ţĥé þŕöĵéçţ îš ñàḿéđ ƃý îţš àƃšöļüţé þàţĥ. À ƃîļîñĝüàļ ƒîļé ŵĥöšé ŕéàđéŕ ĥàš ţö ƃé ţöļđ ţĥé ļàñĝüàĝé öƒ ţĥé ţŕàñšļàţîöñ îţ ĥöļđš, šüçĥ àš à ÞÖ çàţàļöĝ, ļîšţš îţ ŵîţĥ --ţàŕĝéţ-ļàñĝ. À šöüŕçé ƒîļé ŵĥöšé çöḿḿéñţš àŕé ŵĥàţ ķàþî éđîţš îñ îţ ļîšţš éàçĥ çöḿḿéñţ, ķéýéđ àš ķàþî çĥéçķ ŕéþöŕţš îţ (ƒüñç/Þàŕšé).

Þŕîñţš à ĴŠÖÑ àŕŕàý ƃý đéƒàüļţ; --öüţþüţ-ƒöŕḿàţ ýàḿļ éḿîţš à ÝÀḾĻ šéǫüéñçé, àñđ --ĵšöñļ šţŕéàḿš öñé ĴŠÖÑ öƃĵéçţ þéŕ ļîñé (ĴŠÖÑĻ) ƒöŕ þîþîñĝ îñţö à šçŕîþţ.

Þöšîţîöñàļ þàţĥš ţàķé ĝļöƃ þàţţéŕñš (** ŕéçüŕšéš) àñđ đîŕéçţöŕîéš, éẋþàñđéđ ƃý ķàþî îţšéļƒ. Îñšîđé à þŕöĵéçţ, ñö ƑÎĻÉ ḿéàñš ţĥé þŕöĵéçţ'š ţŕàçķéđ çöñţéñţ; ƑÎĻÉ "-" ŕéàđš šţàñđàŕđ îñþüţ. ▒

Çöḿḿàñđinspect

Ĝŕöüþadvanced

Ţŕý îţ

Ŕüñš îñ ýöüŕ ƃŕöŵšéŕ àĝàîñšţ à šḿàļļ šàḿþļé ƒîļé. Éđîţ ţĥé çöḿḿàñđ ƃéƒöŕé ŕüññîñĝ, öŕ þŕéšš Ŕüñ ţö éẋéçüţé îţ àš šĥöŵñ.

$ kapi inspect report.docx

Ƒļàĝš

Ƒļàĝ	Ţýþé	Đéƒàüļţ	Đéšçŕîþţîöñ
--encoding	string		▒ çĥàŕšéţ ţĥé îñþüţ îš ŕéàđ îñ; à ƃýţé-öŕđéŕ ḿàŕķ îñ ţĥé ƒîļé ŵîñš (đéƒàüļţ: ţĥé þŕöĵéçţ'š đéƒàüļţš.éñçöđîñĝ, ţĥéñ ÜŢƑ-8) ▒
--engine	string		▒ ƒöŕḿàţ éñĝîñé ƒöŕ đéţéçţéđ ƒîļéš: ñàţîṽé öŕ à þļüĝîñ ñàḿé (đéƒàüļţ: ñàţîṽé, ţĥéñ þļüĝîñš) ▒
--format , -f	string		▒ îñþüţ ƒöŕḿàţ (đéƒàüļţ: ŵĥàţ ţĥé ŕéçîþé ƃîñđš, éļšé àüţö-đéţéçţ ƃý éẋţéñšîöñ/çöñţéñţ) ▒
--jsonl	bool	false	▒ šţŕéàḿ öñé ĴŠÖÑ öƃĵéçţ þéŕ ļîñé (ĴŠÖÑĻ) îñšţéàđ öƒ à ĴŠÖÑ àŕŕàý ▒
--project , -p	string		▒ þàţĥ ţö à ķàþî.ýàḿļ þŕöĵéçţ ŕéçîþé öŕ îţš đîŕéçţöŕý (àüţö-đîšçöṽéŕéđ ƒŕöḿ çŵđ îƒ öḿîţţéđ) ▒
--render	stringSlice		▒ àļšö ŕéñđéŕ éàçĥ ƃļöçķ ţö ţĥéšé ƒöŕḿàţš (ĥţḿļ, ḿàŕķđöŵñ, àšçîîđöç) üñđéŕ "þŕöĵéçţéđ" ▒
--target-lang	string		▒ ţàŕĝéţ ļàñĝüàĝé (é.ĝ. ƒŕ, đé-ĐÉ); öñé þéŕ ŕüñ ▒

Ḿöŕé éẋàḿþļéš

$ kapi inspect --jsonl 'docs/**/*.md' | jq '{ref, rev}'

$ kapi inspect --output-format yaml report.dclg.xml

$ kapi inspect report.docx --render html,markdown # each block rendered per format

$ kapi inspect -p site/kapi.yaml site/docs/guide.md

cat page.html | kapi inspect -f html

← Ƃàçķ ţö ţĥé Çöḿḿàñđ Ŕéƒéŕéñçé