Check a register on your own computer

Steps

1. Open a terminal (Terminal on a Mac, PowerShell on Windows) and run pip install governanceos (on a Mac, pip3 install governanceos).

   

2. Run goslint ui. If goslint asks to install openpyxl and PyYAML, the two libraries it needs to read spreadsheets, press Enter for yes. The goslint page opens in your browser.

   

3. Select Choose your register, or drop the file on the page. No register at hand? Select Try the Nebula Mutual sample.

4. Under Who supervises this register?, open each region and tick the rule packs for the regulators your register answers to. Then select Check my register.

5. Read the report under To fix, To review and Notes. Select Copy the report, Save the report (.txt) or Save the findings (JSON), then close the page. goslint stops a few seconds later.

   

Good to know

• goslint serves the page from your own computer, at 127.0.0.1, behind a one-time address. It answers only your browser, and your register stays in memory on your computer.
• If pip is not found, run python -m pip install governanceos (on Windows, py -m pip install governanceos; on a Mac, python3 -m pip install governanceos). If goslint is not found after the install, run python -m governanceos.goslint ui (on a Mac, python3 -m governanceos.goslint ui).
• If the browser does not open, copy the address goslint prints into your browser. Press Ctrl+C in the terminal to stop goslint at any time.
• Next review dates are checked as of today. To check them as of another day, open Next review dates as of before you check.
• goslint checks that fields are present, that next review dates have not passed, and where values come from. It does not check whether the values are true.
• At a terminal, goslint on its own asks a question at a time. Scripts use goslint lint register.xlsx --pack osfi-e23.
• Without Python, the same checks run free in your browser. Check a register in your browser

Where in the product

• Check a register in your browser
• Open-source tools
• Help

Nebula Mutual is a fictional institution constructed for illustration; any resemblance to a real organization is unintended.

Related guides

• Import a register from a spreadsheet

  Upload a CSV or XLSX register, map its columns, and import every row as a typed value.

• Read the import receipt and the findings

  See what an import wrote, then read the findings: typed versus produced, point in time, and re-assertion lapses.

• Verify a pack offline

  Download the verifier and the pack, check their SHA-256, run it with --key and the pack key hash you were sent, and read the result.