Éđîţ çöñţéñţ îñ àñý ƒöŕḿàţ, ƒàîţĥƒüļļý

Ĝöàļ: éđîţ ţĥé ţéẋţ îñšîđé à ƒîļé ŵîţĥöüţ ţöüçĥîñĝ îţš šţŕüçţüŕé (à Ŵöŕđ đöçüḿéñţ, à ĴŠÖÑ çàţàļöĝ, à Ḿàŕķđöŵñ ĝüîđé, öŕ àñý öţĥéŕ ƒöŕḿàţ kapi ŕéàđš). Ţĥé ŕéšüļţ îš ţĥé šàḿé ƒîļé (šàḿé ķéýš, šàḿé šţýļéš, šàḿé îñļîñé çöđéš) ŵîţĥ öñļý ţĥé þŕöšé çĥàñĝéđ. Ýöü (öŕ ýöüŕ àššîšţàñţ) đö ţĥé ŕéŵŕîţîñĝ; kapi þàŕšéš ţĥé ƒöŕḿàţ, éñƒöŕçéš à ƒàîţĥƒüļ ŕöüñđ-ţŕîþ, àñđ ŵŕîţéš ţĥé ŕéšüļţ ƃàçķ. kapi ñéṽéŕ šéñđš çöñţéñţ ţö à ḿöđéļ ţö ŕéŵŕîţé îţ, àñđ ñö þŕöĵéçţ, þŕöṽîđéŕ, öŕ çŕéđéñţîàļ îš ñééđéđ.

▶

Walkthrough videoPending recording

À šĥöŕţ ŵàļķţĥŕöüĝĥ îñšþéçţîñĝ à ƒîļé'š ƃļöçķš, þŕéṽîéŵîñĝ àñ éđîţ àš à đ, àþþļýîñĝ îţ îñ þļàçé, àñđ ṽéŕîƒýîñĝ ţĥé ŕéšüļţ ŵîţĥ à çĥéçķ, šĥöŵîñĝ ĥöŵ öñļý ţĥé ļéàƒ ţéẋţ çĥàñĝéš ŵĥîļé ţĥé ƒöŕḿàţ ŕöüñđ-ţŕîþš.

View scene script ↗

Đéšķţöþ

Ţĥé đéšķţöþ šĥöŵš ţĥé ƃļöçķš àñđ ṽéŕîƒîéš ţĥé ŕéšüļţ; ţĥé ŵŕîţé îţšéļƒ îš ţĥé ÇĻÎ'š öŕ àñ àššîšţàñţ'š apply.

1. Ŕéàđ ţĥé ƃļöçķš. Öþéñ ţĥé ƒîļé îñ ýöüŕ þŕöĵéçţ: Ƃļöçķš ļîšţš éàçĥ ţéẋţ ƃļöçķ àš ţĥé éñĝîñé ŕéàđš îţ; Þŕéṽîéŵ šĥöŵš ţĥé ŕéñđéŕéđ đöçüḿéñţ ŵîţĥ ţĥé šöüŕçé ↔ ţàŕĝéţ ţöĝĝļé.
2. Éđîţ ţŕàñšļàţéđ ţéẋţ îñ Ŕéṽîéŵ. Ƒöŕ ţàŕĝéţ-ļàñĝüàĝé üñîţš ţĥé éđîţ šüŕƒàçé îš ţĥé Ŕéṽîéŵ ǫüéüé: éđîţ, ţĥéñ àþþŕöṽé; ţĥé ŵŕîţé ļàñđš ţĥŕöüĝĥ ţĥé šàḿé ƒàîţĥƒüļ ŕöüñđ-ţŕîþ.
3. Ŕüñ šöüŕçé ŕéŵŕîţéš ţĥŕöüĝĥ apply. Đŕîṽé ţĥé îñšþéçţ → apply ļööþ ƒŕöḿ ţĥé ÇĻÎ ţàƃ öŕ à çöññéçţéđ àššîšţàñţ; ţĥéñ ŕéöþéñ Þŕéṽîéŵ ţö šéé ţĥàţ ĥéàđîñĝš, šţýļéš, àñđ îñļîñé çöđéš šüŕṽîṽéđ, àñđ ŕé-ŕüñ ţĥé Çĥéçķš ṽîéŵ ţö çöñƒîŕḿ ţĥé ĝàţé.

Àĝéñţ (Çļàüđé)

Ŵîţĥ kapi ŵîŕéđ àš àñ ḾÇÞ šéŕṽéŕ öŕ ţĥŕöüĝĥ ţĥé Àĝéñţ Šķîļļ, àšķ:

Šîḿþļîƒý ţĥé šéţüþ šéçţîöñ öƒ guide.md: šĥöŕţéŕ šéñţéñçéš, šàḿé ḿéàñîñĝ, ķééþ éṽéŕý ļîñķ.

Ţĥé àššîšţàñţ đŕîṽéš ţĥé ļööþ ţĥŕöüĝĥ šţŕüçţüŕéđ çàļļš: extract_content ţö ŕéàđ ƃļöçķš, apply_edits ţö ŵŕîţé ţĥé çĥàñĝé-šéţ ƃàçķ, check_file ţö çöñƒîŕḿ ţĥé ĝàţé. Ţĥé àššîšţàñţ îš ţĥé ŵŕîţéŕ; kapi éñƒöŕçéš ţĥé ŕöüñđ-ţŕîþ, đŕîƒţ-çĥéçķš éàçĥ éđîţ ƃý content_hash, àñđ ŕéĵéçţš àñ éđîţ ţĥàţ ŵöüļđ çöŕŕüþţ îñļîñé ḿàŕķüþ. Ñö ḿöđéļ îš çàļļéđ ƒöŕ ţĥé ŵŕîţé îţšéļƒ.

ÇĻÎ

Ŕéàđ ţĥé ƃļöçķš. kapi inspect ŕéţüŕñš öñé ŕéçöŕđ þéŕ çöñţéñţ ƃļöçķ: ţĥé text, ţĥé ƃļöçķ'š šţŕüçţüŕàļ ŕöļé, à šţàƃļé id, àñđ à content_hash:

kapi inspect guide.md --jsonl        # one JSON object per line

Ţŵö ƒîéļđš àñçĥöŕ àñ éđîţ: text ŕéñđéŕš îñļîñé çöđéš àš <x id="…"/> ţöķéñš; ķééþ éṽéŕý ţöķéñ îñ ýöüŕ éđîţéđ ţéẋţ (à þļàçéĥöļđéŕ îš <x id="1/"/>, à þàîŕéđ šþàñ öþéñš ŵîţĥ <x id="1"/> àñđ çļöšéš ŵîţĥ <x id="/1"/>). content_hash îš ţĥé ƃļöçķ'š îđéñţîţý; šéñđ îţ ƃàçķ šö kapi çàñ ţéļļ ţĥé ƃļöçķ îš šţîļļ ţĥé öñé ýöü ŕéàđ.

Éđîţ, ţĥéñ àþþļý. Þŕöđüçé öñé content éñţŕý þéŕ çĥàñĝéđ ƃļöçķ; kapi apply îš ţĥé öñé ŵŕîţé ṽéŕƃ:

{
  "kind": "content",
  "file": "guide.md",
  "id": "p3",
  "content_hash": "a1b2c3…",
  "text": "See the <x id=\"1/\"/> dashboard."
}

kapi inspect guide.md --jsonl > blocks.jsonl
# rewrite the "text" of the blocks you want changed (keeping every <x id="…"/>
# token) and save them as content entries to edits.jsonl (you do this; no command)
kapi apply edits.jsonl --diff             # preview as a unified diff, write nothing
kapi apply edits.jsonl                    # apply in place
kapi apply edits.jsonl --in-place=.bak    # apply, keeping a .bak

Ṽéŕîƒý. kapi check çöñƒîŕḿš ţĥé ŕéšüļţ ḿééţš ýöüŕ çöñţéñţ ŕüļéš: đéţéŕḿîñîšţîç, ŕéàđ-öñļý, éẋîţ 0 þàšš àñđ 3 öñ ĝàţé ƒàîļüŕé:

kapi check guide.md --max-chars 500 --forbid "utilize"

Ţĥé ţŵö ĝüàŕđš

apply ŵŕîţéš à ƃļöçķ öñļý ŵĥéñ ƃöţĥ ĝüàŕđš þàšš; à ƃļöçķéđ éđîţ ļéàṽéš ţĥàţ ƃļöçķ üñţöüçĥéđ àñđ îš ŕéþöŕţéđ, šö ñöţĥîñĝ îš šîļéñţļý çöŕŕüþţéđ:

• Đŕîƒţ ĝüàŕđ. À ƃļöçķ ŵĥöšé çüŕŕéñţ content_hash ñö ļöñĝéŕ ḿàţçĥéš ýöüŕ éñţŕý çĥàñĝéđ šîñçé ýöü îñšþéçţéđ îţ; ţĥé éđîţ îš ḿàŕķéđ šţàļé àñđ šķîþþéđ.
• Îñļîñé-çöđé ĝüàŕđ. Àñ éđîţéđ text ţĥàţ đŕöþš, îñṽéñţš, đüþļîçàţéš, öŕ üñƃàļàñçéš àñ <x id="…"/> ţöķéñ îš ŕéĵéçţéđ ŕàţĥéŕ ţĥàñ ŵŕîţţéñ ƃàçķ ŵîţĥ ƃŕöķéñ ḿàŕķüþ.

Éîţĥéŕ öüţçöḿé éẋîţš öñ ţĥé ĝàţé çöđé (3), đîšţîñçţ ƒŕöḿ àñ öþéŕàţîöñàļ éŕŕöŕ; ŕé-îñšþéçţ ţĥé àƒƒéçţéđ ƃļöçķš àñđ ŕéţŕý ŵîţĥ ƒŕéšĥ ĥàšĥéš. apply îš îđéḿþöţéñţ, àñđ ţĥé šàḿé çĥàñĝé-šéţ çàñ çàŕŕý àššéţ éđîţš (àñ àþþŕöṽéđ ţéŕḿ, à ṽöîçé ŕüļé; šéé Çŕéàţé çöñţéñţ) öŕ à kind:"review" éñţŕý (Ţĥé kapi ļööþ): öñé ŵŕîţé ṽéŕƃ, đéŕéñţ kindš.

Ŵĥàţ "ƒàîţĥƒüļļý" ḿéàñš

Öñļý ţĥé éẋţŕàçţéđ þŕöšé çĥàñĝéš; éṽéŕýţĥîñĝ öüţšîđé îţ (.docx çĥàŕàçţéŕ šţýļéš àñđ ţàƃļé ƃöŕđéŕš, ĴŠÖÑ ķéýš àñđ ñöñ-šţŕîñĝ ṽàļüéš, Ḿàŕķđöŵñ ĥéàđîñĝš àñđ ƒéñçéš) îš ŕéþŕöđüçéđ ƃýţé ƒöŕ ƃýţé. Ţĥîš îš ŵĥàţ ḿàķéš éđîţîñĝ ƃîñàŕý öƒƒîçé ƒöŕḿàţš (.docx, .pptx) šàƒé; kapi formats ḿàŕķš šüçĥ ƒöŕḿàţš faithful îñ îţš Éđîţ çöļüḿñ.

Îñ à þŕöĵéçţ

Îñ à kapi þŕöĵéçţ, kapi inspect àñđ kapi check ŕüñ àĝàîñšţ ţĥé ŕéçîþé'š đéçļàŕéđ çöñţéñţ ŵîţĥ ñö ƒîļé àŕĝüḿéñţ, àñđ kapi apply ļàñđš éđîţš àĝàîñšţ ţĥé ñàḿéđ ƒîļéš.

Ñéẋţ

• Çĥéçķš: ŕüļé ƒàḿîļîéš, þŕöƒîļéš, šçöŕîñĝ, àñđ ţĥé ĝàţé éẋîţ çöđéš.
• Çŕéàţé çöñţéñţ: ţĥé àüţĥöŕ → þàŕšé → çĥéçķ ļööþ àñđ ţĥé ḿîẋéđ çĥàñĝé-šéţ.
• Ƒééđ çöñţéñţ ţö ýöüŕ ÀÎ: ţĥé šàḿé àñçĥöŕéđ ƃļöçķš àš àñ îñĝéšţîöñ šţŕéàḿ.