Skip to content
NRNSNRNSNRNS Help

Command reference

Every command below also accepts --workspace <id> and --team <KEY>, which override your saved defaults (see Authentication) for that one call. <ref> means a task reference — either a full TEAM-N like ENG-42, or a bare number like 42 if you have a default team set. Run nrn --help any time to see this list as it ships on your machine.

Auth

Section titled “Auth”
Command What it does
nrn auth login [--label <name>] [--no-open] Start the browser device-flow login.
nrn auth status Show whether you’re logged in, and where the token came from.
nrn auth logout Remove the local token. The grant itself stays until you revoke it in Settings.

Workspaces and teams

Section titled “Workspaces and teams”
Command What it does
nrn workspace list [--json] List the workspaces this login can access.
nrn workspace use <name-or-id> Set the default workspace for future commands.
nrn team list [--json] List teams in the current (or --workspace) workspace.
nrn team use <KEY> Set the default team, used to resolve bare task numbers like 42.

Projects

Section titled “Projects”
Command What it does
nrn project list [--json] List projects in the workspace.
nrn project view <slug> [--json] A project with its milestones, updates, and comments.
nrn project create --name <n> [--team <KEY>] [--description <d>] [--status <s>] [--start YYYY-MM-DD] [--target YYYY-MM-DD] Create a project. --status is one of planned, active, paused, completed, canceled.
nrn project update <slug> [--name <n>] [--description <d>] [--status <s>] [--start YYYY-MM-DD] [--target YYYY-MM-DD] Update a project’s own properties. Only the fields you pass change.

Project updates

Section titled “Project updates”
Command What it does
nrn update create --project <slug> --health <h> --body <text> Post a status update to a project. --health is one of on_track, at_risk, off_track.
nrn update list --project <slug> [--json] List a project’s status updates.

Milestones

Section titled “Milestones”
Command What it does
nrn milestone list --project <slug> [--json] Milestones in a project.
nrn milestone create --project <slug> --name <n> [--description <d>] [--target YYYY-MM-DD] Create a milestone.
nrn milestone update <milestoneId> [--name <n>] [--description <d>] [--target YYYY-MM-DD] Update a milestone.
nrn milestone archive <milestoneId> Archive a milestone.

Tasks

Section titled “Tasks”
Command What it does
nrn task view <ref> [--json] A task with its status, labels, comments, and other details.
nrn task create (--project <slug> or --parent <ref>) --title <t> [...] Create a task, or a sub-task with --parent. See Task create/update fields below.
nrn task update <ref> [...] Update a task. Only the fields you pass change. See Task create/update fields below.
nrn task list (--project <slug> or --parent <ref>) [--status <s>] [--assignee ...] [--milestone <id>] [--json] List tasks in a project, or a task’s sub-tasks with --parent.
nrn task comment <ref> <body...> (or --body <b>) Add a comment.
nrn task archive <ref> [<ref> ...] Soft-delete one or more tasks and their sub-tasks — an admin can restore them.
nrn task activity <ref> [--limit <n>] [--json] A task’s change history.
nrn task label <ref> (--add <name> or --remove <name>) Attach or detach one label by name. There’s no label create — see Statuses and labels below.

Task create/update fields

Section titled “Task create/update fields”

Both commands accept the same optional fields:

  • --title <t> — required on create.
  • --description <d>
  • --priority <p> — none, urgent, high, medium, low, or a number 0–4.
  • --status <s> — a status name from nrn status list.
  • --assignee me, --assignee none, or --assignee <name-or-email-or-userId>.
  • --milestone <id>
  • --stint <name-or-id> — on update only, --stint none clears it.
  • --due YYYY-MM-DD — on update only, --due none clears it.
  • --start YYYY-MM-DD — on update only, --start none clears it.
  • --estimate <n> — on update only, --estimate none clears it.

task create additionally takes exactly one of --project <slug> (a task in that project) or --parent <ref> (a sub-task, inheriting the parent’s project).

Relations and resources

Section titled “Relations and resources”
Command What it does
nrn task relate <A> (blocks, related, or duplicate) <B> Relate two tasks.
nrn task relations <ref> [--json] List a task’s relations, with ids for unrelate.
nrn task unrelate <relationId> Remove a relation.
nrn task link <ref> --url <url> [--title <t>] [--type <t>] Attach a PR, branch, or link to a task. --type is pr, branch, or link.
nrn task resources <ref> [--json] List a task’s linked resources, with ids for unlink.
nrn task unlink <resourceId> Remove a linked resource.

Statuses and labels

Section titled “Statuses and labels”
Command What it does
nrn status list [--team KEY] [--json] A team’s workflow states — the valid values for --status.
nrn label list [--team KEY] [--json] Workspace and team labels.

Labels are created and edited from the Tasks app (Settings → Labels), not the CLI — nrn can only list a workspace’s labels and attach or detach them on a task with task label.

Docs

Section titled “Docs”
Command What it does
nrn doc create --task <ref> [--title <t>] [--content <markdown>] Create a document and link it to a task in one step.
nrn doc update <docId> [--title <t>] [--content <markdown>] Replace a document’s title and/or content.
nrn doc view <docId> [--json] Print a document as markdown.
nrn doc link <ref> <docId> Link an existing document to a task.
nrn doc unlink <ref> <docId> Unlink a document from a task.
nrn doc list --task <ref> [--json] List a task’s linked documents.

See Task-linked docs for how these show up in the Docs app.

Members

Section titled “Members”
Command What it does
nrn member list [--json] Workspace members — names, emails, and the user ids --assignee accepts.

Inbox

Section titled “Inbox”
Command What it does
nrn inbox list [--unread] [--limit <n>] [--json] Your notification feed.
nrn inbox read <notificationId> (or --all) Mark one notification, or every unread notification in the workspace, as read.

Triage

Section titled “Triage”
Command What it does
nrn triage list [--limit <n>] [--json] The triage queue, oldest first.
nrn triage accept <ref> Move a task out of triage, into an unstarted status.
nrn triage decline <ref> Move a task out of triage, into a canceled status.
nrn triage snooze <ref> --until YYYY-MM-DD Hide a task from the queue until the given date — it stays in triage.

Stints

Section titled “Stints”
Command What it does
nrn stint list [--team KEY] [--json] A team’s stints (time-boxed iterations).
nrn stint current [--team KEY] [--json] The active stint and its progress.

Next steps

Section titled “Next steps”