Skip to content
NRNSNRNSNRNS Help

CLI overview

The nrn command line gives you the same access to NRNS Tasks that the web app has — projects, tasks, comments, labels, relations, and docs — from a terminal instead of a browser. It’s built for two kinds of use: people who prefer scripting over clicking, and agents (coding agents, CI jobs) that read and update tasks as part of their own work.

Installing the CLI

Section titled “Installing the CLI”

nrn isn’t available as a public download yet — a public release is coming soon. If your team has already set it up for you (for example, as part of an agent environment), the rest of this section covers how to use it day to day.

Check you’re set up

Section titled “Check you’re set up”

Once nrn is on your PATH, run:

nrn auth status

If you’re logged in, this prints where the token came from and which gateway it’s talking to. If not, it tells you to run nrn auth login — see Authentication for the full flow.

How it reaches NRNS Tasks

Section titled “How it reaches NRNS Tasks”

nrn doesn’t talk to the database directly. Every command goes through a single gateway endpoint that only accepts a fixed, deliberate list of operations — listing and viewing tasks, creating and updating them, managing labels, linking docs, and so on. If an action isn’t on that list, the gateway rejects it, regardless of what the command tries to send. That allowlist is also why a few things you can do in the web app aren’t available from the CLI: labels, for instance, can be listed and attached to or removed from a task, but not created — create labels from the Tasks app instead.

The CLI also only sees the workspace(s) your login was approved for — see Authentication for how that scoping works.

Where nrn stores things

Section titled “Where nrn stores things”

Config, including your token, is saved at ~/.config/nrn/config.json with owner-only file permissions. Three environment variables override it when set — useful for CI, where you don’t want an interactive login flow at all:

  • NRN_TOKEN — use a token directly instead of the saved one.
  • NRN_CONVEX_SITE_URL — point at a different gateway.
  • NRN_CONFIG_PATH — use a different config file location.

Next steps

Section titled “Next steps”