From 88b2e34438e73bbc4dbf576797581297bd432bb6 Mon Sep 17 00:00:00 2001
From: Michael Pollmeier <michael@michaelpollmeier.com>
Date: Wed, 4 Dec 2024 17:10:31 +0100
Subject: [PATCH] document how to run queries against joern server

---
 docs.joern.io/content/server.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/docs.joern.io/content/server.md b/docs.joern.io/content/server.md
index e2acecae..3b24bce2 100644
--- a/docs.joern.io/content/server.md
+++ b/docs.joern.io/content/server.md
@@ -28,6 +28,24 @@ The hostname and port can also be specified:
 joern --server --server-host localhost --server-port 8081
 ```
 
+Run queries on the remote joern instance using `curl` and `jq`:
+```shell
+function joern-remote() {
+  QUERY="{\"query\": \"$@\"}"
+  curl --silent http://localhost:8080/query-sync -X POST -d $QUERY | jq --raw-output .stdout
+}
+
+$ joern-remote 'val foo = 42'
+> val foo: Int = 42
+
+$ joern-remote 'println(\"remote execution vector - this prints on the server\")'
+> 
+
+$ joern-remote 'importCode(\"/path/on/server\")'
+val res1: io.shiftleft.codepropertygraph.generated.Cpg = Cpg[Graph[45 nodes]]
+```
+
+
 A sample client is available for Python at:
 
 https://github.com/joernio/cpgqls-client-python#example-usage