Příkazová paleta

Klávesnicí ovládaný panel pro navigaci v Ceumu pomocí příkazů ve stylu shellu — vypisuje entity, přeskakuje na ně, ovládá časovač, maže, nabízí nápovědu. Otevírá se zpětným apostrofem.

CLI je klávesnicí ovládaný panel, který umožňuje pohybovat se v Ceumu a zúžit pracovní prostor pomocí krátkých příkazů ve stylu shellu. Jeho příkazy provádějí stejné operace, které MCP integrace zpřístupňuje vnějším nástrojům — panel je způsob, jak je spouštět přímo v aplikaci, a samostatný terminálový nástroj připojující se přes MCP je v plánu.

Otevření panelu

Stiskněte zpětný apostrof (`) kdekoli mimo textové pole. Panel vyjede zdola nahoru přes navigační lištu. Stisknutím klávesy Escape jej zavřete.

Uvnitř panelu najdete:

  • Vstupní pole příkazu s doplňováním tabulátorem.
  • Přepis vašich nedávných příkazů a jejich výstupu (posledních 100 záznamů).
  • Úchyt pro změnu výšky panelu.

Příkazy

CLI slouží především k výpisu a přeskakování na vaše data a k ovládání časovače. Hlavní rodiny příkazů jsou:

  • <entity> list (např. clients list, tasks list, invoices list) — vypíše klienty, projekty, úkoly, faktury, předplatná, transakce, dokumenty, události a vaše konfigurace stavů/typů/vztahů. Mnoho výpisů přijímá filtry, např. tasks list --projectId P-3, transactions list --type income nebo documents list --clientId C-1, a --columns pro výběr toho, co se zobrazí.
  • timer start|stop|resume|pause|status|discard|list — ovládejte běžící časovou relaci, aniž byste opustili klávesnici. Zastavení nahlásí název relace a uplynulou dobu.
  • <entity> get — zobrazí jednu fakturu nebo dokument podrobně.
  • clear — vymaže přepis.
  • help — přehled příkazů (viz níže).

Výsledky <entity> list jsou klikatelné: každý řádek odkazuje na odpovídající položku (nebo na její stránku úprav nastavení u konfiguračních řádků), takže CLI zároveň slouží jako rychlý způsob, jak se dostat hluboko do vašeho pracovního prostoru. Po kliknutí na jakýkoli odkaz se provede navigace a panel se zavře.

Získání nápovědy

help se přizpůsobuje tomu, jak konkrétní dotaz zadáte:

  • help — přehled seskupený podle rodiny příkazů ve třech zarovnaných sloupcích: kořenové podstatné jméno (zobrazené jednou na rodinu), podpříkaz a jeho parametry (např. rodina documents vypíše list, get, versions, delete pod jediným nadpisem documents, každý s jeho volbami).
  • help <family> — stejný seskupený výpis zúžený na jednu rodinu (např. help timer).
  • help <command> — úplné podrobnosti k jednomu příkazu, včetně datového typu každé volby a toho, zda je povinná (např. help transactions list).

Volby mají typy: --start <ISO datetime>, --amount <number>, --type <income|expense>. Když příkazu chybí povinná volba, chyba pojmenuje každou z nich — jednu na řádek — s jejím datovým typem, místo aby pouze uvedla „povinné“.

Gramatika příkazů

Tento přehled je generován ze samotných příkazů, takže vždy odpovídá tomu, co CLI skutečně přijímá. Povinné volby nemají závorky; volitelné jsou uzavřeny v [ ].

clear
clients list [--columns <id|name|status|email|company|uuid>] [--id <string>]
documents delete [--id <string>]
documents get [--id <string>]
documents list [--columns <id|name|description|clients|projects|updatedAt|uuid>] [--id <string>] [--projectId <string>] [--clientId <string>]
documents versions [--id <string>]
events create --title <string> --start <ISO datetime> --end <ISO datetime> [--description <string>]
events list [--columns <title|start|end|recurring|description|uuid>] [--from <date>] [--to <date>]
exit
help [command]
invoices delete [--id <string>]
invoices flag [--id <string>] [--description <string>]
invoices get <id> [--id <string>]
invoices list [--columns <id|invoiceNumber|client|amount|status|issueDate|dueDate|currency|flagged|uuid>] [--id <string>] [--clientId <string>]
invoices unflag [--id <string>]
mail logs list [--columns <to|subject|status|sentAt|templateType|uuid>]
mail templates create --name <string> --subject <string> --body <string> --template-type <message_client|send_invoice|send_overdue_reminder|send_project_email|send_task_email>
mail templates list [--columns <name|subject|templateType|uuid>]
projects list [--columns <id|name|status|client|uuid>] [--id <string>] [--clientId <string>]
relationship-types list [--columns <scope|typeId|name|enabled|order|color|uuid>] [--scope <project|task>]
statuses list [--columns <entityType|name|statusId|enabled|finished|order|color|uuid>] [--entity-type <client|project|task|invoice>]
subscriptions create --name <string> --cost <number> --billing-period <weekly|monthly|quarterly|yearly> --billing-date <string> [--currency <string>] [--tags <string>] [--notes <string>] [--inactive]
subscriptions list [--columns <name|cost|billingPeriod|billingsPerPeriod|billingDate|currency|active|uuid>]
task-types list [--columns <typeId|name|enabled|billable|standalone|embeddable|order|color|uuid>]
tasks list [--columns <id|name|status|type|deadline|uuid>] [--id <string>] [--projectId <string>] [--clientId <string>]
timer discard
timer list [--columns <name|startTime|endTime|status|task|uuid>]
timer pause
timer resume
timer start [--name <string>] [--taskId <string>]
timer status
timer stop
transactions create --date <date> --desc <string> --amount <number> --type <income|expense> [--currency <string>] [--tags <string>] [--clientId <string>] [--projectId <string>] [--taskId <string>]
transactions list [--columns <date|desc|amount|type|currency|client|project|uuid>] [--type <income|expense>] [--projectId <string>] [--clientId <string>]

Během běhu příkazu

Příkazy, které komunikují se serverem, zobrazují živý indikátor — malý otáčející se ukazatel a uplynulý čas v sekundách — dokud nedoběhnou, takže rozeznáte pomalý požadavek od zaseknutého.

Doplňování tabulátorem

Doplňování funguje stejně jako v shellu:

  • Jeden tabulátor — doplní nejdelší společnou předponu.
  • Dva tabulátory — zobrazí všechny možnosti.
  • Doplňuje klíčová slova příkazů, názvy přepínačů i jejich hodnoty — včetně vícehodnotových sloupců, takže tasks list --columns name,<Tab> nabídne zbývající sloupce.

Tipy a okrajové případy

  • Klikněte pro zaměření. Kliknutím kamkoli do prázdného prostoru panelu se zaměří vstupní pole příkazu, takže můžete začít psát, aniž byste museli mířit na řádek vstupu.
  • Je zpětný apostrof nepohodlný? Pokud rozložení vaší klávesnice ztěžuje dosah na zpětný apostrof, můžete CLI přepnout i pomocí akordového řetězce v sekci Klávesové zkratky.
  • Rychlý seznam je nablízku. Panel CLI vyjíždí zdola, zatímco panel Rychlý seznam vjíždí ze strany — nepřekrývají se.
  • Přepis je dočasný. Zavření panelu přepis zachová; opětovné načtení stránky jej vymaže.

Na mobilu

Není k dispozici v mobilní aplikaci — spravujte z webové aplikace.

Související články