LAMINARC(1)

πŸ“¦
version 1.3 Β· 2 versions
, in alpine 3.24, nixos 26.05, nixpkgs unstable

πŸ’… laminarc β€” the Laminar CI client app, explained by your bestie

okay so real quick, the man page name is laminarc and this is section 1, and honestly? she's iconic. let's get into it 🫢


✨ SYNOPSIS ✨

the receipts, verbatim, no cap:

laminarc queue JOB [PARAM=VALUE...] ...
laminarc start JOB [PARAM=VALUE...] ...
laminarc run JOB [PARAM=VALUE...] ...
laminarc set PARAM=VALUE...
laminarc show-jobs
laminarc show-running
laminarc show-queued
laminarc abort JOB NUMBER

like… look at all those little verbs. she contains multitudes πŸ’…


🌸 DESCRIPTION 🌸

so laminarc is basically the extrovert bestie of the group β€” she connects to a Laminar server and then does one of the following things for you. one (1) operation, that's the vibe:

  • queue β€” adds job(s) (with optional parameters, bestie) to the queue and returns immediately. she does not wait. she has places to be πŸ’¨
  • start β€” adds job(s) (with optional parameters) to the queue and comes back when the jobs begin execution. so she waits, but only barely. lowkey patient.
  • run β€” adds job(s) (with optional parameters) to the queue and comes back when the jobs complete execution. this one's committed fr. and heads up 🚨 the exit code will be non-zero if any of the runs does not complete successfully.
  • --next may be passed to queue, start or run in order to place the job at the front of the queue instead of at the end. front-of-the-line privileges, we love an icon who cuts the queue (consensually, via flag) πŸ‘‘
  • set β€” sets one or more parameters to be exported as environment variables in subsequent scripts, for the run identified by the $JOB and $RUN environment variables. this is primarily intended for use from within a job execution, where those variables are already set by the server. iykyk 🌈
  • show-jobs β€” lists jobs known to the server. little roster moment πŸ“‹
  • show-running β€” lists the currently running jobs with their numbers. numbers matter, remember them.
  • show-queued β€” lists the names and numbers of the jobs waiting in the queue. the line-up, if you will πŸŽ€
  • abort β€” manually aborts a currently running job by name and number. it's giving "we need to talk" πŸ’€
so which server does she connect to? the Laminar server to connect to is read from the LAMINAR_HOST environment variable. if that's empty, she falls back to LAMINAR_BIND_RPC, and finally defaults to unix-abstract:laminar. three chances, very forgiving queen πŸ™ˆ

πŸ¦‹ ENVIRONMENT πŸ¦‹

  • LAMINAR_HOST β€” address of server to connect. may be of the form IP:PORT, unix:PATH/TO/SOCKET or unix-abstract:NAME. three fits, pick your fav ✨
  • LAMINAR_BIND_RPC β€” the fallback server address variable. it is set by laminard during execution of scripts. she's the understudy but she's ready πŸ’œ

πŸŽ€ SEE ALSO πŸŽ€

  • laminard(8) β€” the other half of the duo. go say hi.

πŸ‘‘ AUTHORS πŸ‘‘

  • Oliver Giles created Laminar CI. founder energy, main character energy, no notes πŸ”₯
  • Dmitry Bogatov created this manual page for the Debian project (but it can be used by others). generous icon, sharing the manual with the whole group chat 🫢

and that's the page!! you read the whole thing, i'm so proud of you πŸ₯ΉπŸ’–

this printing of laminarc(1) is the Apr 04, 2019 edition β€” date stamped and everything, a little vintage vintage, and it's already slaying πŸŽ€βœ¨ bye bestie, go queue something 🌸

πŸ“¦ where this page comes from