FAQ¶
Can I try noteui without setting anything up?¶
Yes. Run noteui --demo to launch the UI against a bundle of built-in sample
notes copied into a throwaway temporary directory. Your real notes directory
is not touched. The demo data is removed automatically when you quit.
See the Demo mode section of the usage guide for details about what is included.
Where are my notes stored?¶
By default, under $HOME/notes, unless you set NOTES_ROOT.
Does noteui use a database?¶
No. noteui works with normal files and directories.
What file types are supported?¶
.md.txt.org.norg
Does noteui change my existing files?¶
It works directly with your note files for operations like create, rename, move, delete, todo actions, and encrypted note workflows.
Where do deleted files go?¶
They are moved to the user trash.
Where is the config file?¶
If NOTEUI_CONFIG is not set, noteui looks in your user config directory under noteui/config.toml.
Where is noteui’s state stored?¶
By default in:
How do I change the editor used to open notes?¶
Set NOTEUI_EDITOR, or fall back to EDITOR.
Can I keep using my own editor and sync tools?¶
Yes. That is one of the main reasons noteui uses normal files on disk.
Where do I configure sync?¶
In the [sync] section of your config file. See the Sync guide and the Configuration reference.
Why does a note appear as remote-only?¶
That means the note exists on the sync server but has not been imported into the current notes root yet.
Use i to import the selected remote-only note or I to import all missing synced notes.
How do I resolve a sync conflict?¶
Select the conflicted synced note, press O to open the generated conflict copy, merge the content you want into the original note, then sync again.
The conflict copy is a safety file, not the canonical note path for future sync.
Where should I look for common problems?¶
Start with Troubleshooting. It covers editor launch problems, sync setup errors, remote-only notes, and contributor docs build issues.