Komentorivi

Näppäimistöllä ohjattava paneeli Ceumin navigointiin shell-tyylisillä komennoilla — listaa entiteettejä, hyppää niihin, hallitse ajastinta, tyhjennä, pyydä ohjeita. Avautuu gravisaksentilla.

Komentorivi on näppäimistöllä ohjattava paneeli, jonka avulla liikut Ceumissa ja rajaat työtilaasi lyhyillä, shell-tyylisillä komennoilla. Sen komennot käyttävät samoja toimintoja, jotka MCP-integraatio tarjoaa ulkoisille työkaluille — paneeli on sovelluksen sisäinen tapa suorittaa niitä, ja erillinen MCP:n kautta yhdistyvä komentorivityökalu on suunnitteilla.

Paneelin avaaminen

Paina gravisaksenttia (`) missä tahansa tekstikentän ulkopuolella. Paneeli liukuu ylös alhaalta navigointipalkin päälle. Paina Escape sulkeaksesi sen.

Paneelin sisältä löydät:

  • Komentokentän, jossa on sarkaintäydennys.
  • Litteroinnin viimeaikaisista komennoistasi ja niiden tulosteesta (viimeiset 100 merkintää).
  • Kahvan paneelin korkeuden muuttamiseen.

Komennot

Komentorivi on pääasiassa datan listaamiseen ja siihen hyppäämiseen sekä ajastimen hallintaan. Pääperheet ovat:

  • <entity> list (esim. clients list, tasks list, invoices list) — listaa asiakkaat, projektit, tehtävät, laskut, tilaukset, tapahtumat, dokumentit, tapahtumat ja tila-/tyyppi-/suhdemäärityksesi. Monet listat ottavat suodattimia, esim. tasks list --projectId P-3, transactions list --type income tai documents list --clientId C-1, ja --columns valitaksesi, mitä näytetään.
  • timer start|stop|resume|pause|status|discard|list — hallitse käynnissä olevaa aikaistuntoa poistumatta näppäimistöltä. Pysäyttäminen raportoi istunnon nimen ja kuluneen keston.
  • <entity> get — näytä yksi lasku tai dokumentti yksityiskohtaisesti.
  • clear — tyhjennä litterointi.
  • help — komentoviite (katso alla).

<entity> list -tulokset ovat napsautettavia: jokainen rivi linkittää vastaavaan kohteeseen (tai sen asetusten muokkaussivulle määritysrivien osalta), joten komentorivi toimii myös nopeana tapana hypätä syvälle työtilaasi. Minkä tahansa linkin seuraaminen navigoi ja sulkee paneelin.

Ohjeiden hakeminen

help mukautuu sen mukaan, kuinka tarkka olet:

  • help — yleiskatsaus ryhmiteltynä komentoperheen mukaan kolmessa kohdistetussa sarakkeessa: juurisubstantiivi (näkyy kerran perhettä kohden), alikomento ja sen parametrit (esim. documents-perhe listaa list, get, versions, delete yhden documents-otsikon alla, kunkin omine vaihtoehtoineen).
  • help <family> — sama ryhmitelty listaus rajattuna yhteen perheeseen (esim. help timer).
  • help <command> — täydet tiedot yhdestä komennosta, mukaan lukien kunkin vaihtoehdon tietotyyppi ja se, onko se pakollinen (esim. help transactions list).

Vaihtoehdoilla on tyyppi: --start <ISO datetime>, --amount <number>, --type <income|expense>. Kun komennosta puuttuu pakollinen vaihtoehto, virhe nimeää jokaisen niistä — yksi riviä kohden — tietotyyppinsä kanssa sen sijaan, että vain sanoisi "pakollinen".

Komentokielioppi

Tämä viite on luotu itse komennoista, joten se vastaa aina sitä, mitä komentorivi todella hyväksyy. Pakollisilla vaihtoehdoilla ei ole hakasulkeita; valinnaiset on kääritty merkkeihin [ ].

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>]

Komennon suorituksen aikana

Komennot, jotka osuvat palvelimeen, näyttävät elävän ilmaisimen — pienen pyörivän kuvakkeen ja kuluneen ajan sekunteina — kunnes ne valmistuvat, jotta erotat hitaan pyynnön jumiutuneesta.

Sarkaintäydennys

Täydennys toimii samoin kuin shellissä:

  • Yksi sarkain — täyttää pisimmän jaetun etuliitteen.
  • Kaksi sarkainta — näyttää kaikki vaihtoehdot.
  • Se täydentää komentojen avainsanat, lippujen nimet ja lippujen arvot — mukaan lukien moniarvoiset sarakkeet, joten tasks list --columns name,<Tab> tarjoaa jäljellä olevat sarakkeet.

Vinkkejä ja erikoistapauksia

  • Napsauta kohdistaaksesi. Paneelin tyhjän tilan minkä tahansa kohdan napsauttaminen kohdistaa komentokenttään, joten voit alkaa kirjoittaa tähtäämättä syöteriville.
  • Tuntuuko gravisaksentti hankalalta? Jos näppäimistöasettelusi tekee gravisaksentista vaikeasti tavoiteltavan, voit silti vaihtaa komentorivin käyttöön sointuketjun kautta kohdassa Pikanäppäimet.
  • Pikaluettelo on lähellä. Komentorivipaneeli nousee alhaalta, kun taas Pikaluettelo-paneeli liukuu sisään sivulta — ne eivät mene päällekkäin.
  • Litterointi on väliaikainen. Paneelin sulkeminen säilyttää litteroinnin; sivun lataaminen uudelleen tyhjentää sen.

Mobiilissa

Ei käytettävissä mobiilisovelluksessa — hallinnoi verkkosovelluksesta.

Aiheeseen liittyvät artikkelit