Guides¶
Task-oriented documentation for common operations.
Available Guides¶
| Guide | When to Use |
|---|---|
| Transports | Check and troubleshoot network transports |
| Identity Management | Manage your identity, password, and backups |
| Place Management | Create and manage rooms, capsules, and objects |
| Connecting Nodes | Connect to other Kunuleco nodes |
| Troubleshooting | Diagnose and fix common issues |
Where You Type Commands¶
You reach a Kunuleco node in one of two ways, and the node's commands (verbs) are the same in both.
- The Urchin client. In command mode you type a verb as it is. In chat mode you put
/in front of it (/look). Commands that belong to the client itself always start with/, such as/networkor/check-updates. - SSH. Connect with
ssh <user>@<host> -p 8122and sign in with your account's password. Type verbs with no prefix.
These guides write node verbs bare. The kunuleco program on the node's machine only starts the node. It has no
subcommands.
Quick Reference¶
Start Kunuleco¶
Launch Urchin. On the first run its setup wizard installs the node, Veilid, Tor and IPFS (kubo) and starts the node. Later launches find the installation and connect to it. See Installation.
Check Status¶
transport shows the state of each transport (mDNS, IPFS, Veilid, Tor). @node_processes shows which daemons are
running. In the client, /network opens the network view.
View Logs¶
The node writes node.log to its logs directory. On an installed node that is ~/.local/share/kunuleco/logs/ on Linux
and %LOCALAPPDATA%\Kunuleco\logs\ on Windows. The configuration reference covers
macOS. The daemon logs sit beside it (ipfs-daemon.log, tor-daemon.log, veilid-daemon.log), with installer.log and
server-stdout.log. The node prints the full list under LOG LOCATIONS when it starts. The logs can contain NUL
bytes, so search them with grep -a.
Get Help¶
help shows the getting-started set. help all lists every everyday verb, and help debug lists the diagnostic ones.
help client lists the Urchin client's own commands, and /help opens help in the client. The
User Manual has the full command reference.