Skip to content
Back to search

nmbrsCLI

SkillWorks with Claude CodeGitHub

Unofficial CLI for the Nmbrs Reporting (Visionplanner) public API, with a Claude skill. Safe for AI agents: every change is a plan you apply.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/ig-shadow-walker--nmbrscli/badge.svg)](/listings/ig-shadow-walker--nmbrscli)

HTML

<a href="/listings/ig-shadow-walker--nmbrscli"><img src="/api/listings/ig-shadow-walker--nmbrscli/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

These steps run a script from the network that findsafeskills does not scan.

You need about five minutes, and you must be an **adviser admin** in Nmbrs Reporting (to add an API connection).

Step 1: Create an API connection in Nmbrs Reporting

1. In Nmbrs Reporting, open the **adviser settings** and go to **Connect Center**. 2. Click **+ Connectie toevoegen** (add connection) and give it a name, e.g. `nmbrs CLI`. 3. In the **Callback URL** field, enter exactly:

   http://localhost:47615/callback

> ⚠️ **This is the step people miss.** It must be exactly this text: `http://` (not https), no trailing slash, > no spaces. Already have other callback URLs? Separate them with commas. Without it, the login page shows > **"Sorry, there was an error: invalid_request"**.

4. Save, open the connection, and go to the **Eigenschappen** (Properties) tab. Keep the **Client ID** and **Client Secret** at hand for step 3. Treat the secret like a password.

Step 2: Install nmbrs

**macOS or Linux:**

curl -fsSL https://github.com/ig-shadow-walker/nmbrsCLI/releases/latest/download/install.sh | sh

**Windows** (PowerShell, no administrator rights needed):

powershell -ExecutionPolicy Bypass -c "iex ((New-Object Net.WebClient).DownloadString('https://github.com/ig-shadow-walker/nmbrsCLI/releases/latest/download/install.ps1'))"

The installer checks the download against `SHA256SUMS`, puts `nmbrs` on your PATH and starts step 3 for you. Open a new terminal afterwards so the `nmbrs` command is found.

<details> <summary><b>The repository is private, or the one-liner gives a 404</b></summary>

The one-liners only work while the repository is public. If you have access through GitHub, download the release with the [GitHub CLI](https://cli.github.com) and install from that folder:

gh release download v0.1.0 --repo ig-shadow-walker/nmbrsCLI --dir ~/Downloads/nmbrs-release
NMBRS_DOWNLOAD_URL=~/Downloads/nmbrs-release sh ~/Downloads/nmbrs-release/install.sh

Or install the binary by hand. Pick the file for your computer (e.g. `nmbrs-darwin-arm64` on an Apple-silicon Mac):

mkdir -p ~/.local/bin
mv ~/Downloads/nmbrs-darwin-arm64 ~/.local/bin/nmbrs
chmod +x ~/.local/bin/nmbrs
xattr -d com.apple.quarantine ~/.local/bin/nmbrs 2>/dev/null   # macOS only
nmbrs setup

| Your computer | File | |---|---| | Mac with Apple silicon (M1 and newer) | `nmbrs-darwin-arm64` | | Mac with Intel | `nmbrs-darwin-x64` | | Linux x64 / ARM64 | `nmbrs-linux-x64` / `nmbrs-linux-arm64` (`-musl` for Alpine) | | Windows x64 / ARM64 | `nmbrs-windows-x64.exe` / `nmbrs-windows-arm64.exe` |

</details>

<details> <summary><b>Installer options</b></summary>

macOS/Linux: add them after `sh -s --`, e.g. `curl … | sh -s -- --dir ~/bin --no-setup`.

| Option | Environment variable | Meaning | |---|---|---| | `--version v0.1.0` | `NMBRS_VERSION` | Install a specific release (default: latest) | | `--dir <path>` | `NMBRS_INSTALL_DIR` | Where the binary goes (default `~/.local/bin`, Windows `%LOCALAPPDATA%\Programs\nmbrs`) | | `--no-setup` | `NMBRS_NO_SETUP=1` | Don't start `nmbrs setup` afterwards | | `--no-modify-path` | `NMBRS_NO_MODIFY_PATH=1` | Don't add the folder to your PATH | | | `NMBRS_DOWNLOAD_URL` | Download from another URL or a local folder |

</details>

Step 3: Run the setup

The installer starts it. Otherwise, run:

nmbrs setup

It walks you through everything:

Nmbrs Reporting CLI setup

This connects the `nmbrs` command to Nmbrs Reporting. You need an API connection from Connect Center
(adviser settings > Connect Center > + Connectie toevoegen; its Eigenschappen tab shows the Client ID
and Client Secret). Give that connection this Callback URL:

  http://localhost:47615/callback

Client ID: cfc8…
Client Secret (hidden): ****************
Checking the Client ID and Secret…
Log in to Nmbrs Reporting now (your browser opens)? [Y/n]
Install the Claude skill, so Claude Code knows how to use nmbrs? [Y/n]

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 429 lines · 2 findings marked
  1. <h1 align="center">nmbrs</h1>
  2. <p align="center">
  3. <b>Nmbrs Reporting on your command line, and in Claude Code.</b><br>
  4. Clients, client cards, dossiers, mappings, webhooks and digital signing, from one small tool that is safe to hand to an AI agent.
  5. </p>
  6. <p align="center">
  7. <img alt="version" src="https://img.shields.io/badge/version-0.1.0-6b5dff">
  8. <img alt="platforms" src="https://img.shields.io/badge/macOS%20%C2%B7%20Linux%20%C2%B7%20Windows-x64%20%26%20ARM64-010149">
  9. <img alt="license" src="https://img.shields.io/badge/license-MIT-green">
  10. </p>
  11. <p align="center">
  12. <a href="#-setup-in-3-steps">Setup</a> ·
  13. <a href="#-use-it-with-claude-code">Claude Code</a> ·
  14. <a href="#-commands">Commands</a> ·
  15. <a href="#-troubleshooting">Troubleshooting</a> ·
  16. <a href="docs/setup.md">Full setup guide</a> ·
  17. <a href="skill/nmbrs/reference.md">Command reference</a>
  18. </p>
  19. ---
  20. ```console
  21. $ nmbrs administrations list --fields name,clientIdentifier,cocNumber
  22. name clientIdentifier cocNumber
  23. -------------------- ---------------- ---------
  24. Bakkerij de Vries BV K1042 12345678
  25. Studio Noord K1077 87654321
  26. (2 rows)
  27. $ nmbrs dossiers list <administration-id> --filter year=eq:2025 --fields name,dossierType,status,dueDate
  28. name dossierType status dueDate
  29. ---------------------- ----------- ---------- -------------------------
  30. Jaarrekening 2025 CMP InProgress 2026-06-30T00:00:00+00:00
  31. (1 row)
  32. ```
  33. **nmbrs** is an unofficial, open-source command-line tool for **Nmbrs Reporting** (formerly Visionplanner), the
  34. financial reporting platform for accountancy firms. It covers the whole
  35. [public API](https://visionplanner.stoplight.io/docs/visionplanner-public-api-s) and comes with a
  36. [Claude skill](skill/nmbrs/SKILL.md), so you can ask Claude Code about your clients and dossiers in plain language.
  37. > **Heads-up:** this is for *Nmbrs Reporting* (reports, compilation and audit dossiers), not Nmbrs payroll.
  38. > It is not affiliated with or endorsed by Nmbrs or Visma.
  39. ## Contents
  40. - [What you get](#-what-you-get)
  41. - [Setup in 3 steps](#-setup-in-3-steps)
  42. - [Check that it works](#-check-that-it-works)
  43. - [Use it with Claude Code](#-use-it-with-claude-code)
  44. - [Commands](#-commands)
  45. - [How changes work: plan, then apply](#-how-changes-work-plan-then-apply)
  46. - [Your login and your data](#-your-login-and-your-data)
  47. - [Troubleshooting](#-troubleshooting)
  48. - [Reference: settings and exit codes](#-reference-settings-and-exit-codes)
  49. - [Update or uninstall](#-update-or-uninstall)
  50. - [Development](#-development)
  51. ## ✨ What you get
  52. - **One command to set up.** `nmbrs setup` asks for your Client ID and Secret, logs you in through the browser,
  53. remembers your firm (adviser) and installs the Claude skill.
  54. - **Log in once, then forget about it.** The login lasts 180 days and renews itself every time you use `nmbrs`.
  55. - **Nothing changes by accident.** Reading is instant. Every change is shown to you as a *plan* first and only
  56. happens when you run `nmbrs apply`.
  57. - **Built for AI agents.** `--json` output, clear exit codes, small answers with `--fields`, and a skill that tells
  58. Claude to check with you before it changes anything.
  59. - **Everything from the official spec.** Every command's `--help` lists its fields, required ones marked `*`.
  60. ## 🚀 Setup in 3 steps
  61. You need about five minutes, and you must be an **adviser admin** in Nmbrs Reporting (to add an API connection).
  62. ### Step 1: Create an API connection in Nmbrs Reporting
  63. 1. In Nmbrs Reporting, open the **adviser settings** and go to **Connect Center**.
  64. 2. Click **+ Connectie toevoegen** (add connection) and give it a name, e.g. `nmbrs CLI`.
  65. 3. In the **Callback URL** field, enter exactly:
  66. ```text
  67. http://localhost:47615/callback
  68. ```
  69. > ⚠️ **This is the step people miss.** It must be exactly this text: `http://` (not https), no trailing slash,
  70. > no spaces. Already have other callback URLs? Separate them with commas. Without it, the login page shows
  71. > **"Sorry, there was an error: invalid_request"**.
  72. 4. Save, open the connection, and go to the **Eigenschappen** (Properties) tab. Keep the **Client ID** and
  73. **Client Secret** at hand for step 3. Treat the secret like a password.
  74. ### Step 2: Install nmbrs
  75. **macOS or Linux:**
  76. ```bash
  77. curl -fsSL https://github.com/ig-shadow-walker/nmbrsCLI/releases/latest/download/install.sh | sh
    • Note: Pipes a downloaded script directly into a shell (curl | sh / wget | bash)
    • Line 99 on GitHub
  78. ```
  79. **Windows** (PowerShell, no administrator rights needed):
  80. ```powershell
  81. powershell -ExecutionPolicy Bypass -c "iex ((New-Object Net.WebClient).DownloadString('https://github.com/ig-shadow-walker/nmbrsCLI/releases/latest/download/install.ps1'))"
  82. ```
  83. The installer checks the download against `SHA256SUMS`, puts `nmbrs` on your PATH and starts step 3 for you.
  84. Open a new terminal afterwards so the `nmbrs` command is found.
  85. <details>
  86. <summary><b>The repository is private, or the one-liner gives a 404</b></summary>
  87. The one-liners only work while the repository is public. If you have access through GitHub, download the release
  88. with the [GitHub CLI](https://cli.github.com) and install from that folder:
  89. ```bash
  90. gh release download v0.1.0 --repo ig-shadow-walker/nmbrsCLI --dir ~/Downloads/nmbrs-release
  91. NMBRS_DOWNLOAD_URL=~/Downloads/nmbrs-release sh ~/Downloads/nmbrs-release/install.sh
  92. ```
  93. Or install the binary by hand. Pick the file for your computer (e.g. `nmbrs-darwin-arm64` on an Apple-silicon Mac):
  94. ```bash
  95. mkdir -p ~/.local/bin
  96. mv ~/Downloads/nmbrs-darwin-arm64 ~/.local/bin/nmbrs
  97. chmod +x ~/.local/bin/nmbrs
  98. xattr -d com.apple.quarantine ~/.local/bin/nmbrs 2>/dev/null # macOS only
  99. nmbrs setup
  100. ```
  101. | Your computer | File |
  102. |---|---|
  103. | Mac with Apple silicon (M1 and newer) | `nmbrs-darwin-arm64` |
  104. | Mac with Intel | `nmbrs-darwin-x64` |
  105. | Linux x64 / ARM64 | `nmbrs-linux-x64` / `nmbrs-linux-arm64` (`-musl` for Alpine) |
  106. | Windows x64 / ARM64 | `nmbrs-windows-x64.exe` / `nmbrs-windows-arm64.exe` |
  107. </details>
  108. <details>
  109. <summary><b>Installer options</b></summary>
  110. macOS/Linux: add them after `sh -s --`, e.g. `curl … | sh -s -- --dir ~/bin --no-setup`.
  111. | Option | Environment variable | Meaning |
  112. |---|---|---|
  113. | `--version v0.1.0` | `NMBRS_VERSION` | Install a specific release (default: latest) |
  114. | `--dir <path>` | `NMBRS_INSTALL_DIR` | Where the binary goes (default `~/.local/bin`, Windows `%LOCALAPPDATA%\Programs\nmbrs`) |
  115. | `--no-setup` | `NMBRS_NO_SETUP=1` | Don't start `nmbrs setup` afterwards |
  116. | `--no-modify-path` | `NMBRS_NO_MODIFY_PATH=1` | Don't add the folder to your PATH |
  117. | | `NMBRS_DOWNLOAD_URL` | Download from another URL or a local folder |
  118. </details>
  119. ### Step 3: Run the setup
  120. The installer starts it. Otherwise, run:
  121. ```bash
  122. nmbrs setup
  123. ```
  124. It walks you through everything:
  125. ```text
  126. Nmbrs Reporting CLI setup
  127. This connects the `nmbrs` command to Nmbrs Reporting. You need an API connection from Connect Center
  128. (adviser settings > Connect Center > + Connectie toevoegen; its Eigenschappen tab shows the Client ID
  129. and Client Secret). Give that connection this Callback URL:
  130. http://localhost:47615/callback
  131. Client ID: cfc8…
  132. Client Secret (hidden): ****************
  133. Checking the Client ID and Secret…
  134. Log in to Nmbrs Reporting now (your browser opens)? [Y/n]
  135. Install the Claude skill, so Claude Code knows how to use nmbrs? [Y/n]
  136. Your browser opens to log in to Nmbrs Reporting. If it doesn't, open this address: …
  137. Waiting for the login to finish (Ctrl-C to cancel)…
  138. ✓ Logged in to Nmbrs Reporting (production) as anna@kantoor.nl.
  139. ✓ Commands act for adviser 0b6c…
  140. ✓ Saved to ~/.config/nmbrs/credentials (only you can read it).
  141. The login lasts 180 days and renews itself whenever nmbrs is used.
  142. ✓ Claude skill installed in ~/.claude/skills/nmbrs.
  143. You're set. Try:
  144. nmbrs administrations list
  145. ```
  146. When your browser shows **"Logged in to Nmbrs Reporting. You can close this tab"**, you're done.
  147. <details>
  148. <summary><b>Special cases: sandbox, no browser, password manager, another callback URL</b></summary>
  149. | Situation | Run |
  150. |---|---|
  151. | Your API connection is in the **sandbox** | `nmbrs setup --sandbox` (setup also notices this itself) |
  152. | **No browser** on this machine (SSH, server) | `nmbrs setup --manual`: open the printed address anywhere, log in, then paste the address the browser lands on (it may say "can't connect"; the code is in the address) |
  153. | Secret from a **password manager** | `op read op://Vault/Nmbrs/secret \| nmbrs setup --client-id <id> --client-secret-stdin` |
  154. | Connect Center **won't accept** an `http://localhost` callback | Register an https URL you own (the page doesn't need to exist), then `nmbrs setup --redirect-uri https://your-site.nl/nmbrs-callback`; it switches to paste mode automatically |
  155. | Save credentials now, **log in later** | `nmbrs setup --no-login`, later `nmbrs login` |
  156. | Act for **another adviser** | `nmbrs setup --adviser-id <globalAdviserId>`, or `--adviser-id` on a single command |
  157. Run `nmbrs setup` again any time to change something; it offers to reuse what's saved.
  158. </details>
  159. ## ✅ Check that it works
  160. ```bash
  161. nmbrs auth test # refreshes the login and asks Nmbrs Reporting who you are
  162. nmbrs administrations list --limit 5 # your first five clients
  163. ```
  164. `nmbrs auth status` shows the environment, your adviser and when the login expires, without contacting the API.
  165. ## 🤖 Use it with Claude Code
  166. If you said yes to the skill during setup, Claude Code already knows how to use `nmbrs`. (Missed it? Run
  167. `nmbrs skill install`.) Just ask:
  168. - *"Which of our clients have a 2025 compilation dossier that isn't finished yet?"*
  169. - *"Show me the client card of Bakkerij de Vries."*
  170. - *"Which administrations had mapping changes since 1 November?"*
  171. - *"Change the website on the client card of Studio Noord to studionoord.nl."*
  172. - *"Register our signing portal as a webhook."*
  173. The skill makes Claude:
  174. - use `--json` and fetch only the fields it needs,
  175. - look up ids instead of guessing them,
  176. - **show you every change as a plan and only apply it after you say yes**,
  177. - send you to your own terminal for `nmbrs setup` / `nmbrs login`, so it never sees your Client Secret.
  178. Other agents (Cursor, Codex, your own scripts) can read [`skill/nmbrs/SKILL.md`](skill/nmbrs/SKILL.md) the same way,
  179. or install it anywhere with `nmbrs skill install --dir <folder>`.
  180. ## 📋 Commands
  181. | You want to… | Command |
  182. |---|---|
  183. | See who you're logged in as | `nmbrs whoami` |
  184. | List all clients | `nmbrs administrations list --all` |
  185. | Find a client | `nmbrs administrations list --name bakkerij` (or `--coc-number`, `--client-identifier`, `--id`) |
  186. | See a client's details (legal form, address, SBI…) | `nmbrs administrations list --id <administration-id>` |
  187. | Update a client card | `nmbrs administrations update-client-card <administration-id> --website https://…` |
  188. | Add a client | `nmbrs administrations create --name "Nieuw BV" --period-type month --start-fiscal-year january` |
  189. | See how a client's ledger maps to rubrics and periods | `nmbrs administrations mapping <administration-id>` |
  190. | Find clients whose mappings changed | `nmbrs administrations modified --since 2026-11-01T00:00:00+00:00` |
  191. | List a client's dossiers | `nmbrs dossiers list <administration-id>` |
  192. | Manage webhooks | `nmbrs webhooks list` · `show` · `create` · `update` · `delete` |
  193. | Get documents waiting for a signature | `nmbrs signing documents --request-id <id> --save-dir ./to-sign` |
  194. | Hand back signed documents | `nmbrs signing send-signed --request-id <id> --data-file signed.json` |
  195. | Anything else in the API | `nmbrs endpoints <words>` → `nmbrs describe <endpoint>` → `nmbrs api GET <path>` |
  196. **Handy options on every command:**
  197. | Option | What it does |
  198. |---|---|
  199. | `--json` | Machine-readable output: `{"ok": true, "data": …, "meta": …}` |
  200. | `--fields name,cocNumber` | Only these fields |
  201. | `--limit 10` | At most 10 results |
  202. | `--all` / `--page 2` / `--page-size 50` | Paging through long lists |
  203. | `--help` | Every option and field of a command, with examples |
  204. **Filtering and sorting dossiers:**
  205. ```bash
  206. nmbrs dossiers list <id> --filter year=eq:2025 # equal
  207. nmbrs dossiers list <id> --filter dossierType=in:CMP,ADT # one of several
  208. nmbrs dossiers list <id> --filter "name=like:jaarrekening" # contains
  209. nmbrs dossiers list <id> --sort -lastUpdatedDate # newest first
  210. ```
  211. Operations: `eq` `ne` `gt` `ge` `lt` `le` `like` `startswith` `endswith` `in`. Dossier types: `CMP` compilation,
  212. `ADT` audit, `TXI` income tax, `TXC` corporate tax, `CMP_FE` compilation (foreign entity).
  213. The complete list of commands, options and fields is in [skill/nmbrs/reference.md](skill/nmbrs/reference.md).
  214. ## 🛡️ How changes work: plan, then apply
  215. Anything that would change data in Nmbrs Reporting **sends nothing**. It shows you a plan instead:
  216. ```console
  217. $ nmbrs administrations update-client-card 2f1c… --website https://devries.nl
  218. Plan 6f2a91c0de (nothing has been sent yet)
  219. Update Client Card on Bakkerij de Vries BV, K1042
  220. ! Overwrites the client card (legal and contact details) of this administration.
  221. PATCH https://vpc-nl.reporting.nmbrs.com/public-api/v1/advisers/0b6c…/administrations/2f1c…/client-card
  222. {
  223. "website": "https://devries.nl"
  224. }
  225. To do it: nmbrs apply 6f2a91c0de (expires …)
  226. $ nmbrs apply 6f2a91c0de
  227. ```
  228. - The plan reads the current state first, so you see **which** client or webhook you're about to change, and it
  229. refuses if it doesn't exist.
  230. - Risky changes get a `!` warning (creating clients, overwriting client cards, webhooks, signing).
  231. - A plan works **once** and **expires after 15 minutes**. `nmbrs plans list` shows pending plans,
  232. `nmbrs plans discard <id>` throws one away.
  233. - Secrets (like a webhook's `callbackSecret`) are shown as `****`.
  234. ## 🔐 Your login and your data
  235. | What | Where | Notes |
  236. |---|---|---|
  237. | Client ID, Secret, environment, adviser | `~/.config/nmbrs/credentials` (Windows: `%APPDATA%\nmbrs\credentials`) | Readable only by you |
  238. | Your login (tokens) | `session.json` in the same folder | Readable only by you |
  239. | Pending plans | `plans/` in the same folder | Deleted after apply or 15 minutes |
  240. | Claude skill | `~/.claude/skills/nmbrs` | |
  241. - You log in as **yourself**, through Nmbrs Reporting's own login page (OAuth with PKCE). `nmbrs` only ever sees
  242. the resulting tokens, never your password.
  243. - The login lasts **180 days** and every command renews it. If it lapses, run `nmbrs login`.
  244. - The Client Secret is never accepted as a command-line argument, so it can't end up in your shell history.
  245. - Tokens are only sent to Nmbrs Reporting's own servers.
  246. - `nmbrs logout` revokes the login at Nmbrs Reporting and removes it from your computer.
  247. ## 🩺 Troubleshooting
  248. | You see | What to do |
  249. |---|---|
  250. | **"Sorry, there was an error: invalid_request"** on the Nmbrs Reporting page during login | The Callback URL is missing or slightly different. In Connect Center, set it to exactly `http://localhost:47615/callback` (http, no trailing slash), save, then run `nmbrs login` |
  251. | **"Sorry, there was an error: unauthorized_client"** | The Client ID isn't known in this environment. Check you copied it fully; for a sandbox connection use `nmbrs setup --sandbox` |
  252. | "did not accept that Client ID and Secret" | Copy both again from the Eigenschappen tab |
  253. | Setup waits and then says the login "did not come back within 5 minutes" | The browser login didn't finish, or the page showed an error (see the first row). Run `nmbrs login` to try again |
  254. | "Can't listen on localhost:47615" | Another program uses that port. Close it, or use `nmbrs login --manual` |
  255. | The browser doesn't open | Copy the address that `nmbrs` prints into your browser, or use `--manual` |
  256. | Exit code 3: "login expired" or `invalid_grant` | Run `nmbrs login`. This also happens if you copied your config folder to another machine and used it there |
  257. | Exit code 4: not authorized | Your user lacks rights for that client or adviser; an adviser admin can grant them |
  258. | "No adviser id is known" | Run `nmbrs setup` again, or add `--adviser-id <id>` |
  259. | `nmbrs: command not found` | Open a new terminal. Still missing? Add `~/.local/bin` to your PATH (setup prints the exact line) |
  260. Still stuck? Run the command again with `-v --json` and check the output; it never contains your secret or tokens.
  261. ## 📖 Reference: settings and exit codes
  262. <details>
  263. <summary><b>Environment variables</b> (override the saved settings; handy for CI and containers)</summary>
  264. | Variable | Meaning |
  265. |---|---|
  266. | `NMBRS_CLIENT_ID`, `NMBRS_CLIENT_SECRET` | The API connection |
  267. | `NMBRS_ENVIRONMENT` | `production` (default) or `sandbox` |
  268. | `NMBRS_ADVISER_ID` | The adviser (globalAdviserId) commands act for |
  269. | `NMBRS_REDIRECT_URI` | Callback URL for the login (default `http://localhost:47615/callback`) |
  270. | `NMBRS_CONFIG_DIR` | Where credentials, login and plans are kept |
  271. | `NMBRS_OUTPUT=json` | Always print JSON |
  272. | `NMBRS_API_URL`, `NMBRS_AUTH_URL` | Point at other servers (testing) |
  273. </details>
  274. <details>
  275. <summary><b>Exit codes</b> (scripts and agents can branch on these)</summary>
  276. | Code | Meaning |
  277. |---|---|
  278. | 0 | OK |
  279. | 1 | Bad input, or Nmbrs Reporting refused it |
  280. | 2 | A plan was made; nothing was sent |
  281. | 3 | Not set up, not logged in, or the login expired |
  282. | 4 | Not authorized |
  283. | 5 | Nmbrs Reporting unavailable, throttled or timed out (a change may or may not have happened) |
  284. | 6 | Not found |
  285. </details>
  286. <details>
  287. <summary><b>Supported platforms</b></summary>
  288. | | x64 | ARM64 |
  289. |---|---|---|
  290. | macOS 11+ | ✓ | ✓ (Apple silicon) |
  291. | Linux (glibc and musl/Alpine) | ✓ | ✓ |
  292. | Windows 10 1809+ / 11 | ✓ | ✓ |
  293. One self-contained binary per platform; nothing else to install.
  294. </details>
  295. ## 🔄 Update or uninstall
  296. - **Update:** run the install command again. Your settings and login are kept.
  297. - **Change credentials, environment or adviser:** `nmbrs setup`.
  298. - **Log out:** `nmbrs logout`.
  299. - **Uninstall:** delete the binary (`~/.local/bin/nmbrs`, or `%LOCALAPPDATA%\Programs\nmbrs` on Windows), the
  300. settings folder (`~/.config/nmbrs`, or `%APPDATA%\nmbrs`) and the skill (`~/.claude/skills/nmbrs`).
  301. ## 🛠️ Development
  302. ```bash
  303. bun install
  304. bun test # unit tests and a fake Nmbrs Reporting (login server and API); no network
  305. bun run typecheck
  306. bun run dev -- administrations list --help
  307. bun run sync-docs # rebuild catalog/endpoints.json from the published OpenAPI spec
  308. bun run reference # regenerate skill/nmbrs/reference.md (a test checks it's current)
  309. bun run install:local # build, install ~/.local/bin/nmbrs and link the skill
  310. ```
  311. The friendly commands are thin: [`src/registry.ts`](src/registry.ts) names them and maps each one to an endpoint in
  312. [`catalog/endpoints.json`](catalog/endpoints.json). Options, required fields, help and validation all come from
  313. the catalog.
  314. <details>
  315. <summary><b>Releasing</b></summary>
  316. 1. Bump `version` in `package.json` (and the badge at the top of this file), and add a `CHANGELOG.md` entry.
  317. 2. `bun test && bun run build:release` builds every platform, the installers and `SHA256SUMS` into `dist/release/`.
  318. To try the installer against them first:
  319. `NMBRS_DOWNLOAD_URL=dist/release sh install.sh --dir /tmp/nmbrs-try --no-setup`.
  320. 3. Commit, push, tag `v<version>` and push the tag.
  321. 4. Create a GitHub release for that tag (not a draft or pre-release, or the `latest` links won't find it) and attach
  322. every file in `dist/release/`. With the GitHub CLI:
  323. `gh release create v<version> dist/release/* --title v<version> --notes-file CHANGELOG.md`.
  324. Alternatively, Actions > Release > Run workflow with an existing release tag builds and uploads on GitHub.
  325. </details>
  326. ## License
  327. MIT. Not affiliated with or endorsed by Nmbrs or Visma; you connect it with your own API connection and log in as yourself.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.