NUU Guide

This guide is for a person who is a member of an org, such as nuucognition. At the end, new Flints on this machine belong to the org, this computer is on the NUU Network with you as its owner, and the members of the org can see it.

An org is a group of people and machines that share Flints. A Flint with no org is local: it stays on this machine. You can work local for as long as you like, and join an org later. Read Quick Start first if you have not installed Flint.

Three things are separate. The org of this machine decides the org of each new Flint. The NUU Network lets you and your orgs reach this computer: a computer on the NUU Network belongs to a person, its owner, and the owner shares it with an org. The NUU account is you: it puts this computer on the NUU Network (nuu login, then nuu computer add), and it publishes shards to the shard registry. Flint works with no account; the NUU Network needs it.

What You Need

A NUU account that is a member of the org in NUU Orgs. The owner or an admin of the org invites you.
The org slug and the org id, for example nuucognition and a UUID. Ask the admin of your org.

There is no org secret: a computer joins the NUU Network with the sign-in of its owner.

The Steps

Step	Command	What it gives
1	`npm install -g @nuucognition/flint-cli`	The commands `flint` and `nuu`
2	`flint setup`	Your Name, the machine names, the agent default, and your Computer Flint
3	`flint login`	The NUU account: shard publishing, and the sign-in of step 5
4	`flint config org set <slug> --id <uuid>`	The org of this machine: new Flints belong to it
5	`nuu login`, then `nuu computer add`	This computer is on the NUU Network, owned by you
6	`nuu computer share <slug> --view` (or `--full`)	The members of the org see this computer (or use it)
7	`flint create "<name>"`	A Flint that the org can see

Step 1: Install

npm install -g @nuucognition/flint-cli

This installs flint and nuu. You type flint for your Flints. You type nuu for the NUU Network (steps 5 and 6). The steps 5 and 6 need nuu release 0.1.0 or newer: nuu --version shows it. See Quick Start for the full install.

Step 2: Set Up This Machine

flint setup

Setup needs internet access. It asks your Name and the machine display name, checks the tools, and makes the Computer Flint. See Setting Up a Machine for the seven steps.

The machine name (for example sam-laptop) is the short word for this machine in addresses, such as @nuucognition/flint/team-notes#sam-laptop. It comes from the machine display name (for example Sam Laptop).

At step 7, Obsidian opens your Computer Flint. Click Trust author and enable plugins one time. It is the only trust click on this machine: the Flints that you make later open with no prompt. The Computer Flint is private: other machines cannot read it through the network. See The Computer Flint.

Step 3: Log In

flint login

A NUU account publishes shards to the shard registry, and it is the owner of this computer on the NUU Network (step 5). flint login and nuu login use one sign-in on this computer. A login does not put this machine in an org.

Follow the prompts to finish the login. These commands manage the account:

flint auth-status   # Show the account status of this machine
flint logout        # Log out: revoke the login and remove the session

Only flint shard release needs the account and the org. It refuses with no login, and it refuses in a Flint with no org.

Step 4: Set Your Org

flint config org set nuucognition --id e17b42dd-1726-463c-861b-49d2a833c73e

The org is stored in the NUU config. Each new Flint on this machine belongs to this org. flint config org show shows it.

The org id is the truth; the slug is a name for it. You can leave out --id when a Flint of the org is on this machine. When the id is not known, the command stops and asks for --id <uuid>.

To remove the org of this machine later, run flint config org unset. Do not pass none to set: the command refuses it and names unset.

Step 5: Put This Computer on the NUU Network

nuu login
nuu computer add

nuu login signs you in (skip it when step 3 signed you in). nuu computer add puts this computer on the NUU Network with you as its owner, and starts the NUU client:

Adding this computer to the NUU Network as "sam-laptop"...
✓ sam-laptop is on the NUU Network. Its owner is you (Sam Rivera).
✓ The NUU client runs.
✓ sam-laptop is online. Release 0.1.0.

The NUU client publishes the Flints of this computer that are not hidden and not private, and it lets requests reach this computer. Add each computer once. When computer add prints ! The NUU client does not start again after a restart of this computer, run nuu client install-service: it installs the NUU client as a service of your user. nuu client status shows whether the NUU client runs.

nuu computer share nuucognition --view

Only you reach this computer until you share it. A share puts the computer into the org with a mode:

--view: the members of the org see this computer, its Flints that are not hidden, and their live sessions.
--full: the members can also start and message sessions. A session uses your files and your AI accounts on this computer, so --full asks you to confirm.

Keep a Flint out with nuu computer hide "<flint>". Refuse each request from the NUU Network at once with nuu computer lock. nuu computer unshare nuucognition stops the share.

Step 7: Create a Flint for the Org

flint create "Team Notes"

The new Flint belongs to the org of this machine. Its address is @nuucognition/flint/team-notes. When this computer is not on the NUU Network, the output names the next commands: nuu computer add, then nuu computer share <org> --view.

After the trust click in your Computer Flint, the new Flint opens in Obsidian with its plugins on. When the plugin of the new vault does not answer, for example on a machine with no Computer Flint, the Obsidian row has one more line: Click "Trust author and enable plugins" once in Obsidian.

To make a local Flint on this machine, run flint create "<name>" --org none. See Creating a Flint for the other options.

Check the Result

flint whoami
nuu whoami

flint whoami shows your Name, this machine, the org of this machine, and your NUU account. With no login, the Account row says not logged in (optional: flint login). With no org, the Org row says none (local).

nuu whoami shows you, this computer on the NUU Network, and your orgs:

You            Sam Rivera (signed in)
This computer  sam-laptop · yours · on the NUU Network · release 0.1.0
Your orgs      nuucognition (member)

nuu computer shows the state of this computer, its shares, its lock, and its hidden Flints. nuu computer list shows your computers and the computers that your orgs share with you. A member of the org sees this computer in the console of the NUU Network (https://network.nuucognition.com), under "Shared with you". In release 0.1.0 a member acts on it from the console: a request from a computer of another person is refused.

Flints You Already Have

A Flint that you made before step 4 is local. Its address starts with @/, for example @/flint/team-notes. To give it the org, run this command in the Flint:

flint org set nuucognition

The id of the Flint does not change. Its address changes from @/flint/<slug> to @nuucognition/flint/<slug>. flint org show shows the org and the address of the Flint. To make a Flint local again, run flint org set none in it. flint org set nuucognition --dry-run shows the plan and changes nothing. For a box and its owned members, run flint tinderbox org set nuucognition --apply in the box (see Using Tinderbox).

To work in a Flint of a colleague, clone it:

flint create --from <git url>

The clone keeps the org of the Flint.

Leave the Org

flint config org unset

New Flints on this machine are then local. The command prints what stays: your Flints keep their org, and the account does not change. The computer stays on the NUU Network and keeps its shares. To stop the share with the org, run nuu computer unshare <org>. To take the computer off the NUU Network, run nuu computer remove: its token ends at once.

Join Your Org