From 77b167eb0a385c6428ba15e69ef434a69dbb638c Mon Sep 17 00:00:00 2001
From: KernelDeimos <7225168+KernelDeimos@users.noreply.github.com>
Date: Wed, 15 Oct 2025 19:57:27 -0400
Subject: [PATCH] doc: document the dev socket

---
 src/backend/doc/dev_socket.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 src/backend/doc/dev_socket.md

diff --git a/src/backend/doc/dev_socket.md b/src/backend/doc/dev_socket.md
new file mode 100644
index 00000000..c1880e69
--- /dev/null
+++ b/src/backend/doc/dev_socket.md
@@ -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.