Skip to main content

Module tips

Module tips 

Source
Expand description

Discoverability tips (A17).

After a successful verb, the CLI may emit a one-line tip nudging the user toward a more powerful affordance. Tips are:

  • stderr only: piping heddle <verb> to other tools never includes tips.
  • never in --output json: scripted consumers don’t get advisory output.
  • once per session per repo: a session marker file at ~/.heddle/session/<repo-id>/tips-shown.toml records which tips have been shown so we don’t nag.
  • per-repo permanently suppressible via [ui.tips] enabled = false in .heddle/config.toml (or [ui.tips.suppress] keys = [...] to suppress individual tips).

Enums§

Tip

Functions§

maybe_emit
Emit a tip on stderr if it hasn’t been shown yet for this repo and the caller hasn’t suppressed tips. The as_json argument should be true when the verb is rendering JSON — tips are skipped there to keep scripted output clean. The quiet argument reflects the global --quiet flag and suppresses nonessential discoverability copy.
session_marker_dir
Identify the per-repo session marker directory. Hashes the canonical repo root path so distinct worktrees of the same repo don’t collide.