Reference
Everything Northern Commander keeps is in one folder in your home, ~/.northern-commander/. These
pages say what each file in it holds, when it is written, and what you can safely do with it, and
Command line lists every command of ncmd, which reaches the
application from any terminal.
Finding the folder
| Key | Action |
|---|---|
| ⌘G | Go to folder… |
| ⇧⌘. | Show or hide hidden files |
- Its name starts with a dot, so a pane lists it only while hidden files are shown. Or press
⌘G and type
~/.northern-commander. - About shows where the settings file and the logs are.
- Nothing in it is sent anywhere. Reports send only what Support describes, and only once you have agreed.
A copy built from the source
A development build — one built from the source rather than downloaded — keeps its files in
~/.northern-commander-dev/ instead, so trying one never touches the settings of the copy you use
every day. The variable NC_DATA_DIRECTORY gives one run of a development build a folder of its own:
a full path, a path starting ~/, or a folder under home. A downloaded copy ignores it.
Two kinds of file
- Your files
- What you set up:
settings.json,key-bindings.json,favourites.json,user-menu.jsonand the saved searches. Each is changed on a screen of its own and is meant to be edited by hand as well. How to make the application yours with them is under Customization. - State files
- What the application keeps for itself: where you left off, histories, what you typed into fields, your answers about reports, and the logs. Nothing in them is meant to be edited; deleting one makes the application forget what it held.
Everything in the folder
In ~/.northern-commander/ |
Holds | Kind |
|---|---|---|
settings.json |
Every setting | Yours — see also the settings file |
key-bindings.json |
The keys you changed | Yours |
favourites.json |
Your favorite places | Yours |
user-menu.json |
Your own commands | Yours |
searches/ |
Saved searches, a file each | Yours |
session.json |
Where you left off | State |
history.json |
Where each pane has been, the commands you ran, and the files you agreed to run | State |
recents.json |
What you typed into fields that remember, and how the last archive was made | State |
consent.json |
Your answers about reports, updates and the license | State |
reports.json |
What reports are sent under | State |
greeting.json |
What the screens shown at start have said: Full Disk Access, What’s new, the overdue reminder | State |
backups.json |
What the last backup left out | State |
restore.json |
A restore waiting for the next start | State |
logs/ |
A log of each run | State |
crash-reports/ |
Reports of crashes, errors, freezes and stalls waiting for your answer | State |
shell-integration/ |
Scripts the built-in terminal’s shells read | State |
backups/ |
Backups, unless Backups folder says elsewhere | — |
Schemas
Each .json file at the top of the folder has a JSON schema, published at
https://northerncommander.com/schemas/<file>.schema.json: what each key means and the values it
takes. An editor given the schema checks the file and completes it as you type; each page links the
schema of every file it covers.
True of every .json file
- A file that is missing or is not JSON never stops the application. It is read as if it were not there, and the log says why.
- A write cut short leaves the file that was there. Each is written beside itself and then moved into place.
- Deleting one makes the application forget what it held, and a new one is written when there is something to keep. Quit first: a running copy holds most of them in memory, and writes them again.
- A backup holds your files, the histories, what you typed into fields and where you left off, in one zip. Your answers about reports, the logs and the shell scripts are never in one.