iterate / mikrobloggeriet

0 stars 0 forks source link

`mblog`: First steps for a common CLI. Includes commands for `mblog` configuration (repo-path, editor and cohort) #18

Closed teodorlu closed 10 months ago

teodorlu commented 10 months ago

Jeg starter såvidt på felles CLI, med hvordan vi kan få til konfigurasjon av CLI-et så det funker for alle kohorter. Se cli-quickstart-new.md for:

Etter dette tenker jeg å sette meg i baksetet og hjelpe dere med det dere jobber på enn å implementere ting selv!

Jeg har ikke startet på kommandoer for å lage nye innlegg.

teodorlu commented 10 months ago

@olavm - Endret CLI-et til å "være som Git".

mblog config cohort: leser kohort mblog config cohort genai: setter kohort til å være genai.

JohanMartinEJohnsen commented 10 months ago

Synes også kanskje at noe av rekke følgen på readme'n kan diskuteres. Linje 33 kanskje burde komme helt til slutt etter eksempelet, og linje 43-44 burde komme etter linje 31.

teodorlu commented 10 months ago

Synes også vi kan vurdere å legge til det den returnerer om den har vært vellykket.

@JohanMartinEJohnsen Tanker om hvordan vi kan gjøre det? Jeg sliter litt med å finne noe som passer.

Her er en mulighet:

To install the CLI with bbin, run the following command from inside the directory, meaning where you cloned down the repository:

bbin install . --as mblog --main-opts '["-m" "mikrobloggeriet.cli"]'

Pay attention to the output of the command above. If it fails, you haven't installed the mblog CLI!

Jeg føler liksom at det er noe man må passe på alltid når man installerer et CLI?

Vi kan legge det til hvis det ville hjulpet deg å skjønne hvordan du skal installere. Som nevnt er hva som bør stå i dokumentasjonen her litt i blindsonen min -- jeg kjenner verktøyene vi bruker såpass godt at jeg ikke ser alle tingene som bør dokumenteres.

teodorlu commented 10 months ago

Synes også kanskje at noe av rekke følgen på readme'n kan diskuteres. Linje 33 kanskje burde komme helt til slutt etter eksempelet, og linje 43-44 burde komme etter linje 31.

Godt poeng, enig.

Her er ny tekst:

Configure mblog

mblog requires the following configuration for writing:

  1. Repo path: where you have cloned the mikrobloggeriet CLI.
  2. User cohort: the default cohort you are writing for.
  3. Editor: how you want to edit your text.

To configure repo path, user cohort and editor, run:

mblog config repo-path YOUR_REPO_PATH
mblog config cohort YOUR_COHORT
mblog config editor YOUR_EDITOR

When repo-path, cohort and editor are set, you can run mblog create to write a new post.

Det gir absolutt mening å tipse om mblog create til sist!

teodorlu commented 10 months ago

Takk for feedback!