xpipe update

xpipe-io · Jun 29, 2024 · 3f81253 · 3f81253
1 parent 179779a
commit 3f81253
Show file tree

Hide file tree

Showing 12 changed files with 123 additions and 154 deletions.
diff --git a/docs/cli/man/xpipe-daemon-beacon.md b/docs/cli/man/xpipe-daemon-beacon.md
@@ -0,0 +1,48 @@
+# xpipe daemon beacon
+
+<h2 id="_name">Name</h2>
+<div class="sectionbody">
+<p>xpipe-daemon-beacon - Send raw API requests to the XPipe daemon</p>
+</div>
+<div class="sect1">
+<h2 id="_synopsis">Synopsis</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p><strong>xpipe daemon beacon</strong> [<strong>--port</strong>=<em>&lt;port&gt;</em>] <em>&lt;path&gt;</em></p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_description">Description</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>Send raw API requests to the XPipe daemon</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_options">Options</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1"><strong>--port</strong>=<em>&lt;port&gt;</em></dt>
+<dd>
+<p>The HTTP server port</p>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_arguments">Arguments</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1"><em>&lt;path&gt;</em></dt>
+<dd>
+<p>The path to send the API request to. E.g. /open or /version.</p>
+</dd>
+</dl>
+</div>
+</div>
+</div>
diff --git a/docs/cli/man/xpipe-daemon-mode.md b/docs/cli/man/xpipe-daemon-mode.md
@@ -8,7 +8,7 @@
 <h2 id="_synopsis">Synopsis</h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p><strong>xpipe daemon mode</strong> <em>&lt;mode&gt;</em></p>
+<p><strong>xpipe daemon mode</strong> [<strong>--port</strong>=<em>&lt;port&gt;</em>] <em>&lt;mode&gt;</em></p>
 </div>
 </div>
 </div>
@@ -21,6 +21,19 @@
 </div>
 </div>
 <div class="sect1">
+<h2 id="_options">Options</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1"><strong>--port</strong>=<em>&lt;port&gt;</em></dt>
+<dd>
+<p>The HTTP server port</p>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="sect1">
 <h2 id="_arguments">Arguments</h2>
 <div class="sectionbody">
 <div class="dlist">

diff --git a/docs/cli/man/xpipe-daemon-start.md b/docs/cli/man/xpipe-daemon-start.md
@@ -8,7 +8,7 @@
 <h2 id="_synopsis">Synopsis</h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p><strong>xpipe daemon start</strong> [<em>&lt;input&gt;</em>&#8230;&#8203;]</p>
+<p><strong>xpipe daemon start</strong> [<strong>--port</strong>=<em>&lt;port&gt;</em>] [<em>&lt;input&gt;</em>&#8230;&#8203;]</p>
 </div>
 </div>
 </div>
@@ -21,6 +21,19 @@
 </div>
 </div>
 <div class="sect1">
+<h2 id="_options">Options</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1"><strong>--port</strong>=<em>&lt;port&gt;</em></dt>
+<dd>
+<p>The HTTP server port</p>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="sect1">
 <h2 id="_arguments">Arguments</h2>
 <div class="sectionbody">
 <div class="dlist">

diff --git a/docs/cli/man/xpipe-daemon-status.md b/docs/cli/man/xpipe-daemon-status.md
@@ -8,7 +8,7 @@
 <h2 id="_synopsis">Synopsis</h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p><strong>xpipe daemon status</strong></p>
+<p><strong>xpipe daemon status</strong> [<strong>--port</strong>=<em>&lt;port&gt;</em>]</p>
 </div>
 </div>
 </div>
@@ -20,3 +20,16 @@
 </div>
 </div>
 </div>
+<div class="sect1">
+<h2 id="_options">Options</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1"><strong>--port</strong>=<em>&lt;port&gt;</em></dt>
+<dd>
+<p>The HTTP server port</p>
+</dd>
+</dl>
+</div>
+</div>
+</div>
diff --git a/docs/cli/man/xpipe-daemon-stop.md b/docs/cli/man/xpipe-daemon-stop.md
@@ -8,7 +8,7 @@
 <h2 id="_synopsis">Synopsis</h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p><strong>xpipe daemon stop</strong> [<strong>-f</strong>]</p>
+<p><strong>xpipe daemon stop</strong> [<strong>-f</strong>] [<strong>--port</strong>=<em>&lt;port&gt;</em>]</p>
 </div>
 </div>
 </div>
@@ -29,6 +29,10 @@
 <dd>
 <p>Attempts to forcefully kill the running xpipe daemon process. Note that if this option is specified, the daemon process will be killed instantly and no attempt at a graceful shutdown is made.</p>
 </dd>
+<dt class="hdlist1"><strong>--port</strong>=<em>&lt;port&gt;</em></dt>
+<dd>
+<p>The HTTP server port</p>
+</dd>
 </dl>
 </div>
 </div>

diff --git a/docs/cli/man/xpipe-daemon.md b/docs/cli/man/xpipe-daemon.md
@@ -39,6 +39,10 @@
 <dd>
 <p>Stops the XPipe daemon if it is running.</p>
 </dd>
+<dt class="hdlist1"><a href="xpipe-daemon-beacon"><strong>beacon</strong></a></dt>
+<dd>
+<p>Send raw API requests to the XPipe daemon</p>
+</dd>
 <dt class="hdlist1"><a href="xpipe-daemon-help"><strong>help</strong></a></dt>
 <dd>
 <p>Displays help information about the specified command</p>

diff --git a/docs/cli/man/xpipe-drain.md b/docs/cli/man/xpipe-drain.md
diff --git a/docs/cli/man/xpipe-launch.md b/docs/cli/man/xpipe-launch.md
diff --git a/docs/cli/man/xpipe-ls.md b/docs/cli/man/xpipe-ls.md
diff --git a/docs/cli/man/xpipe-open.md b/docs/cli/man/xpipe-open.md
@@ -8,7 +8,7 @@
 <h2 id="_synopsis">Synopsis</h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p><strong>xpipe open</strong> [<em>&lt;input&gt;</em>&#8230;&#8203;]</p>
+<p><strong>xpipe open</strong> [<strong>-d</strong>=<em>&lt;directory&gt;</em>] [<strong>--port</strong>=<em>&lt;port&gt;</em>] [<em>&lt;input&gt;</em>&#8230;&#8203;]</p>
 </div>
 </div>
 </div>
@@ -21,6 +21,23 @@
 </div>
 </div>
 <div class="sect1">
+<h2 id="_options">Options</h2>
+<div class="sectionbody">
+<div class="dlist">
+<dl>
+<dt class="hdlist1"><strong>--port</strong>=<em>&lt;port&gt;</em></dt>
+<dd>
+<p>The HTTP server port</p>
+</dd>
+<dt class="hdlist1"><strong>-d</strong>, <strong>--directory</strong>=<em>&lt;directory&gt;</em></dt>
+<dd>
+<p>Overrides the used data directory that should be used by the daemon, which by default is &lt;User Home&gt;/.xpipe. This allows you to operate on a separate set of connections in configurations. This option will only be applied if the daemon is not running yet.</p>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="sect1">
 <h2 id="_arguments">Arguments</h2>
 <div class="sectionbody">
 <div class="dlist">

diff --git a/docs/cli/man/xpipe-sink.md b/docs/cli/man/xpipe-sink.md
diff --git a/docs/cli/man/xpipe.md b/docs/cli/man/xpipe.md
@@ -16,10 +16,12 @@
 <h2 id="_description">Description</h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>Command-line interface to interact with the XPipe daemon. Note that the feature set of the CLI is not gigantic as XPipe is primarily designed to be used via the GUI.</p>
+<p>Command-line interface to interact with the XPipe daemon.</p>
 </div>
 <div class="paragraph">
-<p>For a full reference, see either the man pages (local or online) or the help command, available via xpipe --help.</p>
+<p>For a full reference, see either:
+- The man pages (local with man xpipe or online at <a href="https://docs.xpipe.io/cli/man/" class="bare">https://docs.xpipe.io/cli/man/</a>)
+- The command help, available via xpipe &lt;command&gt; --help</p>
 </div>
 </div>
 </div>
@@ -32,22 +34,6 @@
 <dd>
 <p>Opens the XPipe application</p>
 </dd>
-<dt class="hdlist1"><a href="xpipe-launch"><strong>launch</strong></a></dt>
-<dd>
-<p>Launches a specified shell connection in your existing terminal session</p>
-</dd>
-<dt class="hdlist1"><a href="xpipe-sink"><strong>sink</strong></a></dt>
-<dd>
-<p>Write the contents of stdin to a remote file.</p>
-</dd>
-<dt class="hdlist1"><a href="xpipe-drain"><strong>drain</strong></a></dt>
-<dd>
-<p>Reads the contents of a remote file and prints it to stdout.</p>
-</dd>
-<dt class="hdlist1"><a href="xpipe-ls"><strong>ls</strong>, <strong>list</strong></a></dt>
-<dd>
-<p>List all stored connections and their ids</p>
-</dd>
 <dt class="hdlist1"><a href="xpipe-daemon"><strong>daemon</strong></a></dt>
 <dd>
 <p>Commands for controlling the XPipe daemon</p>
@@ -71,15 +57,15 @@
 </dd>
 <dt class="hdlist1"><strong>1</strong></dt>
 <dd>
-<p>Client error: one or more inputs were not correctly specified</p>
+<p>Client error: One or more inputs were not correctly specified</p>
 </dd>
 <dt class="hdlist1"><strong>2</strong></dt>
 <dd>
 <p>Internal error: An internal error occurred in the XPipe daemon while executing the command</p>
 </dd>
 <dt class="hdlist1"><strong>3</strong></dt>
 <dd>
-<p>Connection error: could either not start or communicate to the XPipe daemon</p>
+<p>Connection error: Could either not start or communicate with the XPipe daemon</p>
 </dd>
 </dl>
 </div>