vitrinka.docs
VývojářCLI

Nástěnky, tagy a diagramy

Sada je archiv; nástěnka je plocha, do které lidé opravdu píšou. Každý push na nějakou už přistane — tohle jsou příkazy, které nástěnky tvarují, otevírají, plní a sdílejí a drží je dohledatelné.

Ze sady nástěnku

Push snímků už přistane na své nástěnce cesty, <project>-<branch>-<key>, a vypíše její adresu; push dokumentu přistane jako karta dokumentu na /a/<id>. Po board create sáhněte, jen když chcete jiný slug nebo název, případně větvící se strom --journey ze stejné sady:

vitrinka board create --title "Košík — třetí kolo"
PřepínačCo dělá
--title / --btitleNázev nástěnky.
--slugSlug nástěnky. Výchozí je <project>-<branch>-<key>, adresa sady.
--journeyPostaví větvící se strom cesty místo plochého flow.
--actorPřipsání přes X-Board-Actor. Výchozí je uložený operátor.
--rootKořen záznamu. Výchozí .vitrinka/screenshots.

Najít nástěnku

list filtruje podle tří os, pod kterými je nástěnka zařazená — projekt, podskupina a tag — plus podle typu.

vitrinka board list --project myapp --type journeys
vitrinka board view kosik-treti-kolo
PřepínačCo dělá
--projectJen nástěnky patřící tomuto projektu.
--subgroupJen nástěnky v této podskupině.
--typeJen nástěnky daného typu — brainstorm, docs, journeys…
--tagsOddělené čárkami. Předřaďte - a tag vyloučíte.
--matchJak tagy kombinovat: all (výchozí) nebo any.
--archivedZahrne i archivované nástěnky.

Otevřít nástěnku

board open otevře živou nástěnku kořene záznamu, pokud sada existuje, jinak vitrinka home. Režim QR je na to, jak dostat nástěnku na tablet bez psaní adresy.

vitrinka board open
vitrinka board open --qr      # naskenujte iPadem, anotujte Pencilem
vitrinka board open --print   # jen vypíše adresu
PřepínačCo dělá
--qrVykreslí adresu jako QR kód v terminálu místo otevření.
--printJen vypíše adresu.
--browserVynutí https adresu i když je nainstalovaná Vitrinka.app.

Otevřít v desktopové aplikaci

board edit zaostří běžící Vitrinka.app na soubor nebo projekt a zapíše repozitář do registru projektů, aby seznam v aplikaci zůstal aktuální. Funguje jen na macOS a vyžaduje desktopovou aplikaci Vitrinka, která se dodává odděleně od CLI; jinde, nebo bez ní, dostanete vypsaný deep link.

vitrinka board edit .
vitrinka board edit --print   # jen vypíše deep link

Dostat něco na nástěnku

upload na ni položí libovolné soubory jako karty. dump vysype celý adresář záběrů najednou — nástěnku založí, když chybí, nahraje každý obrázek v pořadí podle názvu a z render-audit audit.json (pokud v adresáři je) složí jednu kartu s ledgerem. import-chat publikuje přepis chatu — eve run nebo NDJSON — jako kartu s konverzací.

vitrinka board upload ./report.html ./notes.md --board checkout-pass-3
vitrinka board dump ./zabery/kolo-3 --board checkout-kolo-3
vitrinka board import-chat run.ndjson --board checkout-pass-3 --redact
Přepínač dump
--boardCílový slug. Bez něj: render-audit-<date>-<label>-<sha7>.
--projectVlastnický projekt při založení nástěnky (výchozí benchmarking).
--workspaceZapsat do tohoto workspace místo navázaného.
--label, --titleOznačení kola (výchozí: název adresáře) a titulek nástěnky.
Přepínač upload
--boardCílový slug. Povinný.
--sectionPřistane uvnitř pojmenovaného rámu sekce.
--anchor · --sidePřiloží se k id karty, vedle ní vpravo (right) nebo pod ni (below).
--create-sectionZaloží --section jako nový rám, i když se jeho název skoro shoduje s existujícím.

board cards rm karty zase sundá — měkce: skončí v koši nástěnky (záložka Trash), odkud je operátor může obnovit. Id berou seznamy s čárkami i rozsahy. Vaše vlastní karty jdou rovnou do koše, až 25 na jedno volání a 30 % nástěnky; karty někoho jiného nebo větší dávka potřebují --why s důvodem o nejméně 20 znacích.

vitrinka board cards rm checkout-pass-3 362-370
vitrinka board cards rm checkout-pass-3 412,415 --why "duplikáty z druhého kola, nahradily je snímky třetího"

Sdílení s lidmi zvenku

share vyrazí sdílecí odkaz na veřejné sdílecí doméně. Odkaz je zároveň klíč: kdo ho má, otevře nástěnku bez účtu. Každý odkaz sdílí celou nástěnku. --card jen určí, kde se otevře: na daném prvku jako dokument místo na plátně. Takhle se sdílí artefakt z jeho pohledu /a/<id>. Příjemce se ale může přepnout na nástěnku a přečíst každou kartu na ní, takže artefakty pro cizí oči drž na nástěnce, kde vedle nich není nic soukromého. Osobní nástěnky odkazy nevydávají.

vitrinka board share kosik-treti-kolo --mode annotate --expires 7d
vitrinka board share dokumentace --card 336
PřepínačCo dělá
--modeview (výchozí) nebo annotate, kdy držitelé odkazu můžou nechávat připomínky.
--expires24h, 7d, 30d (výchozí) nebo never.
--cardId prvku, na kterém se odkaz otevře jako dokument. Odkaz dál dává celou nástěnku.

Tagy

Třetí osa vedle projektu a podskupiny.

vitrinka tag add kosik-treti-kolo regrese platby
vitrinka tag list
vitrinka tag remove kosik-treti-kolo regrese

Diagramy

import rozparsuje soubor, který stejně udržujete — OpenAPI, SQL DDL nebo docker-compose — do diagramu; schema push lokálně prozkoumá živý Postgres a nahraje, co našel. Oba berou --section pro přistání uvnitř rámu a --rev pro revizi zdroje, kterou ukazuje mikroštítek ↻ na kartě.

vitrinka board diagram import docker-compose.yml --board checkout-pass-3
vitrinka board diagram schema push --db postgres://localhost/app --board checkout-pass-3   # psql běží lokálně; adresa nikdy neopustí stroj

Na této stránce