Skip to main content

Module guidance

Module guidance 

Source
Expand description

Where to get credentials.

Printed when someone is stuck rather than on every run: a first login, a rejected token, an organisation that answers 403. Getting a Tracker token means creating an OAuth application and hand-assembling an authorize URL, which is not something anyone guesses, and the organisation id lives behind a page most people have never opened.

The blocks are written as markdown and rendered for a terminal, for the same reason issue descriptions are: a numbered procedure with a table in it reads as a procedure, not as punctuation. Where nobody is watching — a pipe, a log, a CI run — the markdown source goes out unrendered, because reflowed text with escape codes in it is worse to read in a log than the source was.

Constants§

ORG
How to find the organisation id, and which flavour it is.
TOKEN
How to obtain an OAuth token.

Functions§

block
Render one block for whoever is reading it.
full
Both blocks, for a first run.
login_help
The long help of auth login: what the command is, then the same two blocks, so --help answers the question without anyone having to fail first.