Dokumentace

Kaloko

Stáhnout
Markdown s obrázky (.zip)Složka pro Docusaurus (.zip)Složka pro VitePress (.zip)Složka pro MkDocs (.zip)HTML pro offline čtení (.zip)PDFNovinky jako JSON
Stránky

Příkazy CLI

Všechny příkazy CLI kaloko a co dělají. Spouštějí se jako npx kaloko <příkaz> v projektu, který má balíček nainstalovaný. npx kaloko help vypíše stejný seznam se všemi volbami.

Volby, které fungují všude: --run <id|složka> (nebo KALOKO_RUN) vybere běh, --config <soubor> konfiguraci, --json vypíše data pro skripty (Výstup pro skripty níže) a KALOKO_AGENT=<jméno> označí, co zapsal agent. kaloko help <příkaz> vysvětlí jeden příkaz, kaloko help export run jeden podpříkaz.

Nastavení projektu

PříkazCo dělá
kaloko initVytvoří kaloko.config.yml, nainstaluje skill pro Claude Code nebo Codex (--agent), pozná framework, dev server, jazyky a hlavní cesty a připraví první scénář; --docs=off|changelog|full založí changelog a složky dokumentace. --project, --project-name a --product pojmenují projekt v Kaloku. V repozitáři s více weby je vypíše a cesty nehádá: --site jeden vybere, --base-url načte stránky z běžícího webu (sitemapa, potom odkazy z úvodní stránky), --skeleton zapíše scénář s TODO
kaloko init --seo <web>Týdenní hlídání SEO a odpovědních enginů na veřejném webu: přečte robots.txt a sitemapy, pozná jazyky a největší obsahové rodiny (první úsek cesty, v každém jazyce přeložený) a zapíše qa/flows/seo-<web>.yml s jedním rotujícím stack krokem pro každou skupinu. --families, --limit (stránek z rodiny a jazyka za týden), --packs seo,aeo,a11y,perf, --env, --out, --force
kaloko loginPřihlásí tento počítač přes prohlížeč a uloží token (nejvýš na 30 dní) do ~/.config/kaloko/.env; s --print ho jen vypíše
kaloko doctorZkontroluje Node, Chrome, konfiguraci, prostředí, porty prohlížeče, token, klíč evaluátoru a nástroje pro aplikace; --fix si na macOS řekne o oprávnění pro snímání
kaloko draft <url…>Připraví první plán a scénář jen pro čtení pro veřejné stránky, s packy seo, a11y, perf a console
kaloko validate <soubor…>Zkontroluje scénáře proti schématu a jejich odkazy; --coverage porovná kritéria s akceptačním plánem; --json vypíše problémy každého souboru
kaloko scenariosVypíše scénáře, které konfigurace najde
kaloko ci github|gitlabNapíše workflow, které u každého pull requestu projde dotčené kroky na preview nasazení a napíše k němu komentář
kaloko ci github --releaseNapíše workflow, které zapíše každý release vydaný vaším nástrojem na releasy
kaloko ci preview-urlV CI najde adresu preview, pull request a jeho základ
kaloko ci planV CI nebo v sandboxu agenta: řekne kontrole Kaloko v pull requestu, kterých scénářů se commit týká

Průchod a snímání

PříkazCo dělá
kaloko startZaloží běh scénáře --scenario v prostředí --env a nastaví ho jako aktuální; --locales, --viewports, --browsers, --color-schemes, --devices a další určí, co se nasnímá; --states omezí stavy kroků, --token-modes režimy tokenů designu; --pii redact nebo pseudonymize skryje osobní údaje ve všech snímcích; --ref CC-2026-001 (lze opakovat, v CI KALOKO_REFS) uvede záznamy, ke kterým běh patří, --purpose dry_run, formal nebo smoke (KALOKO_PURPOSE) řekne, proč se šlo
kaloko walkSpustí kroky v Playwrightu, nasnímá je a vyhodnotí; --affected, --record, --heal, --stability N, --concurrency N, --ephemeral
kaloko capture --step <id>Nasnímá aktuální stránku pro krok; --state empty jako jeden z jeho stavů, --crop přiloží prvek, --image převezme obrazovku z jiného nástroje
kaloko open --step <id>Otevře adresu kroku ve sdíleném prohlížeči
kaloko mail --step <id>Zachytí e‑mail ze schránky prostředí, nebo uloženou zprávu přes --file
kaloko browser start|stop|statusJeden sdílený prohlížeč na prostředí, který ovládají agenti, skripty i lidé
kaloko browser installStáhne prohlížečová jádra (--browsers chromium,webkit,firefox)
kaloko devicesVypíše předvolby zařízení, které lze použít jako viewporty
kaloko session resetZačne jako nový návštěvník: smaže cookies a úložiště ve sdíleném prohlížeči
kaloko auth saveČlověk se jednou přihlásí (SSO, MFA) a průchod relaci použije znovu; kaloko auth list ukáže uložené relace
kaloko affectedŘekne, kterých kroků se změněné soubory týkají a proč; s --fail-if-none skončí kódem 1, když žádného (--check je starší název)
kaloko import <cesta>Rozloží screenshoty, reporty a trace z Playwrightu nebo průchod jiného agenta jako běh
kaloko statusUkáže, co aktuální běh nasnímal

Výsledky a kontrola

PříkazCo dělá
kaloko evaluateSpustí deterministické kontroly a sémantický evaluátor pro všechny snímky; --recheck po změně scénáře, --budget N nejvýš N placených dotazů na evaluátor
kaloko buildZapíše run.json a místní náhled
kaloko previewSestaví náhled a vypíše cestu k němu
kaloko shareNahraje běh do kaloko.app; --pr napíše komentář do pull requestu nebo merge requestu. V běhu, který skrývá osobní údaje, nahrávání zastaví nezamaskovaný e‑mail, telefon, rodné číslo nebo IBAN a vypíše krok a prvek (--allow-pii běh nahraje i tak); ostatní běhy se nahrají s upozorněním
kaloko reviewCo na sdíleném běhu ještě musí rozhodnout člověk, a odkaz do režimu kontroly
kaloko healthKondice běhu (kontroly z packů, které jen radí) a co se změnilo od minulého běhu; --remote pro sdílený běh, --fail-on error ukončí příkaz kódem 1, když jsou v kondici chyby
kaloko health adopt <krok>:<kontrola>Udělá z kontroly kondice kritérium přijetí kroku v souboru scénáře, beze změny nebo s --text
kaloko health pullZapíše do souboru scénáře kontroly, které lidé převzali na kaloko.app
kaloko feedbackOtevřené připomínky recenzentů, vrácené kroky jako první
kaloko commentKomentuje, odpovídá, uzavírá a znovu otevírá připomínky z terminálu
kaloko compareTextový rozdíl dvou běhů: stavy, verdikty, skóre a důkazy
kaloko stabilityNajde oblasti, které se mění při každém běhu; --apply je přidá do scénáře, --pull převezme oblasti nakreslené na kaloko.app
kaloko calibratePorovná sémantický evaluátor s hodnocením lidí a navrhne prahy
kaloko signoff <run-id>Stáhne podepsaný záznam o přijetí přijatého běhu; --package stáhne balíček dokladů kteréhokoli nahraného běhu (záznam, matice dohledatelnosti, auditní stopa, snímky, podepsaný manifest); --verify <soubor> ověří záznam nebo balíček i bez tokenu
kaloko evidence <run-id>Doklady běhu, nebo releasu s --release <verze> [--product p] (Business; --ref a --purpose ponechají jen jeho běhy jednoho záznamu nebo účelu): stav přijetí a podpisu, kritéria tak, jak se procházela, s odkazy na požadavky, výsledky, otisky snímků, rozhodnutí, podpisy, auditní stopa; --csv vypíše matici dohledatelnosti, --json celý dokument
kaloko video exportUdělá z videí běhu jedno video; kaloko video list, trace a tools ukážou videa, průběh kroků a nástroje
kaloko screensHledá v nejnovějších screenshotech všech kroků napříč vašimi flow
kaloko inboxVaše upozornění na kaloko.app

Sdílené běhy

PříkazCo dělá
kaloko projectsProjekty organizace
kaloko projects create <slug>Založí projekt s názvem, který lidé uvidí (--name "ECO Podcasty"), případně omezený nebo jako součást produktu; existující projekt odmítne a nepřejmenuje
kaloko projects rename <slug>Změní název, který lidé vidí; dělá to správce projektu
kaloko projects syncSrovná Kaloko s project:, project_name: a product: v konfiguraci: chybějící projekt založí, jinak pojmenovaný přejmenuje a přidá ho do produktu
kaloko runsSdílené běhy, u každého scénáře ten nejnovější; --all vypíše všechny, stránku po stránce až do konce; --limit N skončí po N a --cursor pokračuje odtamtud; --ref CC-2026-001 vypíše všechny běhy daného záznamu, --purpose formal jen formální běhy
kaloko trash <run-id…>Přesune běhy do koše; kaloko restore <run-id> jeden vrátí
kaloko prunePonechá nejnovější běhy každého scénáře a prostředí a ostatní vypíše ke smazání; --yes je přesune do koše
kaloko keep <run-id>Ponechaný běh nikdy nevyprší ani se neuklidí; --off ho uvolní
kaloko archive <scenario-id>Skryje vyřazený scénář ze seznamu; jeho běhy zůstanou
kaloko scenario move <scenario-id> --project <slug>Přesune scénář do jiného existujícího projektu i se všemi běhy, koncepty designu a obrazovkami, stejně jako Nastavení scénáře na jeho stránce v aplikaci. Přesun má přednost před project: v konfiguraci i ve scénáři: další sdílené běhy scénáře půjdou do nového projektu, dokud ho nepřesunete zpátky
kaloko publicZpřístupní sdílený běh bez přihlášení
kaloko export run|stepsrun stáhne sdílený běh jako zip; steps --scenario <id> nejnovější snímek každého kroku (volby --run a --scenario fungují dál)
kaloko export findingsSeznam oprav z lokálního běhu: každé nesplněné kritérium a health kontrola po stránkách a jazycích s důkazem, s edit_url a content_ref stránky a s příkazem, který ji projde znovu; s traffic v konfiguraci i kliknutí, zobrazení a relace stránky a impact, od největšího; --format csv|json, --locale, --step, --out

Jira, Linear a hostované běhy

PříkazCo dělá
kaloko issue createÚkol v Jiře nebo Linearu z vráceného kroku nebo nesplněného kritéria; kaloko issue list je vypíše
kaloko schedule addKaloko každý den nebo týden otevře stránky scénáře jen pro čtení a běh nasdílí; --health-alert error|warning|off určí, kdy zhoršená kondice upozorní tým
kaloko schedule list|run|pause|resume|removeSpráva naplánovaných běhů
kaloko schedule hook <id> [--remove]Adresa a tajemství, kterými nasazení nebo CI spustí běh na serveru Kaloka; tajemství se ukáže jednou
kaloko schedule export githubWorkflow pro GitHub Actions, které scénář pravidelně projde celým CLI

Produkty, changelog a dokumentace

PříkazCo dělá
kaloko products syncPošle produkty z konfigurace do Kaloka, aniž by zapsal release
kaloko products listProdukty, které v Kaloku čtete, a produkty z konfigurace, které tam ještě nejsou
kaloko products remove <product>Archivuje produkt: zmizí z Produktů, jeho novinky a dokumentace vrátí 404, vydání a dokumentace zůstanou uložené
kaloko products restore <product>Vrátí archivovaný produkt i s vydáními a dokumentací
kaloko changelog draftNapíše sekci Unreleased z pull requestů a změněných obrazovek; --apply ji zapíše do CHANGELOG.md
kaloko release [<verze>]Zapíše release se záznamem z changelogu, obrázky a dokumentací
kaloko docs publishPošle složku s dokumentací do Kaloka jako dokumentaci jedné verze
kaloko docs checkRozbité odkazy, zastaralé sekce, chybějící překlady a položky changelogu bez obrázku; při chybách skončí kódem 1
kaloko export docsDokumentace a changelog jako Markdown (výchozí), nebo s --format jako Docusaurus, VitePress, MkDocs, HTML, PDF či JSON; kaloko export --format <f> funguje dál

Design

PříkazCo dělá
kaloko syncVymění revize návrhu se společným konceptem (--pull, --push)
kaloko design lintZkontroluje složku s návrhem podle pravidel přenositelného HTML
kaloko design import figmaUdělá z framů ve Figmě designové kroky a z proměnných tokeny
kaloko historyVerze flow a revize kroku
kaloko spec [krok]Co postavit podle schváleného designového kroku: prvky, styly napojené na tokeny, stavy; --state empty pro jeden stav kroku
kaloko drift [krok]Čím se implementace liší od schváleného návrhu; dokud se liší, končí kódem 1
kaloko referenceUkáže nebo nastaví referenci designu a srovnávací běh
kaloko tokens pull|push|check|validateDesign tokeny projektu (DTCG)
kaloko branch list|create|mergeVětve konceptu návrhu
kaloko export live|designlive stáhne živé soubory verze do složky (předání vývoji), design verzi v otevřených formátech; --live a --design fungují dál

Výstup pro skripty

S --json zapíše příkaz, který vypisuje data, na stdout jediný JSON dokument a nic jiného; průběh, poznámky a varování jdou na stderr. Funguje u start, status, evaluate, build, share, validate, scenarios, runs, projects, review, feedback, inbox, auth list, browser status, ci preview-url, affected, prune, devices, doctor a u dalších příkazů, jejichž nápověda ho uvádí. kaloko share --json vypíše id běhu a jeho adresu:

url=$(npx kaloko share --json | jq -r .url)

Když příkaz s --json selže, poslední řádek na stderr vypadá takto: {"error":{"message":"Cannot reach https://kaloko.app (ENOTFOUND).","code":"unreachable","next":"…"}}. code je usage, unreachable, no_token, unauthorized, failed, nebo vlastní důvod služby (třeba plan).

Příkazy z novější verze

kaloko help --json vypíše všechny příkazy s podpříkazy a volbami jako JSON ({"version":"…","commands":{"<název>":{"flags":[…],"subcommands":{…}}}}); agent ho může číst místo textu nápovědy.

Když napíšete příkaz, podpříkaz nebo volbu, kterou vaše verze kaloko nezná, podívá se na /cli/latest.json služby, se kterou pracuje (kaloko.app, nebo KALOKO_URL): tam jsou příkazy nejnovější vydané verze a kaloko si je na den uloží do ~/.cache/kaloko. Jen když je ta verze novější než vaše a má přesně to, co jste napsali, řekne vám to místo hádání překlepu:

There is no command "projects" in this kaloko.
kaloko projects is in kaloko 0.16.0 (you have 0.15.0). Update: npm i -D kaloko@latest

Návratový kód zůstává 2 a s --json je ten řádek v next chyby. Bez připojení čeká nejvýš 1,5 s a vypíše totéž co dřív. KALOKO_NO_UPDATE_CHECK=1 nebo --offline kontrolu vypne. kaloko doctor také ukáže, že je k dispozici novější kaloko.

KódVýznam
0Hotovo
1Kontroly našly problémy, nebo příkaz selhal (docs check, drift, design lint, affected --fail-if-none a validate hlásí svá zjištění kódem 1)
2Chyba použití: neznámý příkaz nebo volba, chybějící argument
3Služba Kaloko není dostupná: počítač je offline, selhalo DNS, spojení bylo odmítnuto nebo přerušeno. Chybová odpověď služby je 1
4Chybí token, nebo je neplatný, prošlý či zrušený: spusťte kaloko login

Doby trvání

--timeout (mail), --wait (ci preview-url), --expires (share) a --older-than (prune) berou číslo ve své jednotce jako dřív (u prvních dvou sekundy, u ostatních dny), nebo číslo s s, m, h či d: --wait 10m, --expires 72h, --older-than 14d.

kaloko help vypíše všechno výše se všemi volbami.

Na této stránceNa této stránce