CLI command

skarbiec star

Read, dismiss or reset the GitHub star request Skarbiec makes once after a person's fifth successful set or get on a terminal.

Invocation#

Shell
skarbiec star [status | dismiss | reset]

Purpose#

Read, dismiss or reset the GitHub star request Skarbiec makes once after a person's fifth successful set or get on a terminal.

Required inputs and options#

  • No verb means status. The request is kept per user in $XDG_STATE_HOME/skarbiec/onboarding.json, or ~/.local/state/skarbiec/onboarding.json without XDG_STATE_HOME.

Output and state effects#

  • Prints product, stage (counting, shown or dismissed), actions, threshold, repository and file. dismiss stops the request from being made again until a reset; reset sets the state aside and counts from zero. Neither reads nor changes the vault.

Refusals#

  • Every refusal is a declared cause of skarbiec.star or, for its command line, skarbiec.arguments under /docs/errors. An unknown verb (arguments-form-unknown), a second word (arguments-extra) or any flag (arguments-flag-unknown: `star takes no --<flag>, so it cannot do what the flag asks`) exits 2. A process with neither HOME nor XDG_STATE_HOME, or without USER, is refused naming the three variables (star-unplaced). A state file or directory this account cannot create or write is refused naming the file (star-state-unavailable), and a file that does not read as the request names star reset (star-state-damaged).