doc: document the dev socket

This commit is contained in:
KernelDeimos
2025-10-15 19:57:27 -04:00
committed by Eric Dubé
parent cd279f7355
commit 77b167eb0a

View File

@@ -0,0 +1,15 @@
## Backend - dev socket
The "dev socket" allows you to interact with Puter's backend by running commands.
It's a UNIX socket created in Puter's runtime directory
(typically `./volatile/runtime`, or `/var/puter` for production instances).
When in the runtime directory, you can connect to the socket with your tool
of choice. For example, using `nc` as well as `rlwrap` to get readline history:
```
rlwrap nc -U ./dev.sock
```
If it is successful you will see a message with instructions. At this point
you may enter a command. Enter the `help` command to see a list of commands.