diff --git a/docs/cli/man/xpipe-daemon-beacon.md b/docs/cli/man/xpipe-daemon-beacon.md new file mode 100644 index 0000000..b081afa --- /dev/null +++ b/docs/cli/man/xpipe-daemon-beacon.md @@ -0,0 +1,48 @@ +# xpipe daemon beacon + +

Name

+
+

xpipe-daemon-beacon - Send raw API requests to the XPipe daemon

+
+
+

Synopsis

+
+
+

xpipe daemon beacon [--port=<port>] <path>

+
+
+
+
+

Description

+
+
+

Send raw API requests to the XPipe daemon

+
+
+
+
+

Options

+
+
+
+
--port=<port>
+
+

The HTTP server port

+
+
+
+
+
+
+

Arguments

+
+
+
+
<path>
+
+

The path to send the API request to. E.g. /open or /version.

+
+
+
+
+
diff --git a/docs/cli/man/xpipe-daemon-mode.md b/docs/cli/man/xpipe-daemon-mode.md index 22c1a38..eb9bf99 100644 --- a/docs/cli/man/xpipe-daemon-mode.md +++ b/docs/cli/man/xpipe-daemon-mode.md @@ -8,7 +8,7 @@

Synopsis

-

xpipe daemon mode <mode>

+

xpipe daemon mode [--port=<port>] <mode>

@@ -21,6 +21,19 @@
+

Options

+
+
+
+
--port=<port>
+
+

The HTTP server port

+
+
+
+
+
+

Arguments

diff --git a/docs/cli/man/xpipe-daemon-start.md b/docs/cli/man/xpipe-daemon-start.md index 2b6b5a4..af69452 100644 --- a/docs/cli/man/xpipe-daemon-start.md +++ b/docs/cli/man/xpipe-daemon-start.md @@ -8,7 +8,7 @@

Synopsis

-

xpipe daemon start [<input>…​]

+

xpipe daemon start [--port=<port>] [<input>…​]

@@ -21,6 +21,19 @@
+

Options

+
+
+
+
--port=<port>
+
+

The HTTP server port

+
+
+
+
+
+

Arguments

diff --git a/docs/cli/man/xpipe-daemon-status.md b/docs/cli/man/xpipe-daemon-status.md index 21f55dc..b02fa47 100644 --- a/docs/cli/man/xpipe-daemon-status.md +++ b/docs/cli/man/xpipe-daemon-status.md @@ -8,7 +8,7 @@

Synopsis

-

xpipe daemon status

+

xpipe daemon status [--port=<port>]

@@ -20,3 +20,16 @@
+
+

Options

+
+
+
+
--port=<port>
+
+

The HTTP server port

+
+
+
+
+
diff --git a/docs/cli/man/xpipe-daemon-stop.md b/docs/cli/man/xpipe-daemon-stop.md index a238f53..d31d2f7 100644 --- a/docs/cli/man/xpipe-daemon-stop.md +++ b/docs/cli/man/xpipe-daemon-stop.md @@ -8,7 +8,7 @@

Synopsis

-

xpipe daemon stop [-f]

+

xpipe daemon stop [-f] [--port=<port>]

@@ -29,6 +29,10 @@

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.

+
--port=<port>
+
+

The HTTP server port

+
diff --git a/docs/cli/man/xpipe-daemon.md b/docs/cli/man/xpipe-daemon.md index b2f4b67..755409d 100644 --- a/docs/cli/man/xpipe-daemon.md +++ b/docs/cli/man/xpipe-daemon.md @@ -39,6 +39,10 @@

Stops the XPipe daemon if it is running.

+
beacon
+
+

Send raw API requests to the XPipe daemon

+
help

Displays help information about the specified command

diff --git a/docs/cli/man/xpipe-drain.md b/docs/cli/man/xpipe-drain.md deleted file mode 100644 index dabd4f2..0000000 --- a/docs/cli/man/xpipe-drain.md +++ /dev/null @@ -1,37 +0,0 @@ -# xpipe drain - -

Name

-
-

xpipe-drain - Reads the contents of a remote file and prints it to stdout.

-
-
-

Synopsis

-
-
-

xpipe drain <source> <path>

-
-
-
-
-

Description

-
- -
-
-
-

Arguments

-
-
-
-
<source>
-
-

The source connection

-
-
<path>
-
-

The file path

-
-
-
-
-
diff --git a/docs/cli/man/xpipe-launch.md b/docs/cli/man/xpipe-launch.md deleted file mode 100644 index 668dbf6..0000000 --- a/docs/cli/man/xpipe-launch.md +++ /dev/null @@ -1,35 +0,0 @@ -# xpipe launch - -

Name

-
-

xpipe-launch - Launches a specified shell connection in your existing terminal session

-
-
-

Synopsis

-
-
-

xpipe launch <id>

-
-
-
-
-

Description

-
-
-

Launches a specified shell connection in your existing terminal session

-
-
-
-
-

Arguments

-
-
-
-
<id>
-
-

The connection id.

-
-
-
-
-
diff --git a/docs/cli/man/xpipe-ls.md b/docs/cli/man/xpipe-ls.md deleted file mode 100644 index b0783d3..0000000 --- a/docs/cli/man/xpipe-ls.md +++ /dev/null @@ -1,20 +0,0 @@ -# xpipe ls - -

Name

-
-

xpipe-ls - List all stored connections and their ids

-
-
-

Synopsis

-
-
-

xpipe ls

-
-
-
-
-

Description

-
- -
-
diff --git a/docs/cli/man/xpipe-open.md b/docs/cli/man/xpipe-open.md index 6441036..96e87af 100644 --- a/docs/cli/man/xpipe-open.md +++ b/docs/cli/man/xpipe-open.md @@ -8,7 +8,7 @@

Synopsis

-

xpipe open [<input>…​]

+

xpipe open [-d=<directory>] [--port=<port>] [<input>…​]

@@ -21,6 +21,23 @@
+

Options

+
+
+
+
--port=<port>
+
+

The HTTP server port

+
+
-d, --directory=<directory>
+
+

Overrides the used data directory that should be used by the daemon, which by default is <User Home>/.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.

+
+
+
+
+
+

Arguments

diff --git a/docs/cli/man/xpipe-sink.md b/docs/cli/man/xpipe-sink.md deleted file mode 100644 index 63145c9..0000000 --- a/docs/cli/man/xpipe-sink.md +++ /dev/null @@ -1,37 +0,0 @@ -# xpipe sink - -

Name

-
-

xpipe-sink - Write the contents of stdin to a remote file.

-
-
-

Synopsis

-
-
-

xpipe sink <source> <path>

-
-
-
-
-

Description

-
- -
-
-
-

Arguments

-
-
-
-
<source>
-
-

The source connection

-
-
<path>
-
-

The file path

-
-
-
-
-
diff --git a/docs/cli/man/xpipe.md b/docs/cli/man/xpipe.md index 20cd07b..94e65e5 100644 --- a/docs/cli/man/xpipe.md +++ b/docs/cli/man/xpipe.md @@ -16,10 +16,12 @@

Description

-

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.

+

Command-line interface to interact with the XPipe daemon.

-

For a full reference, see either the man pages (local or online) or the help command, available via xpipe --help.

+

For a full reference, see either: +- The man pages (local with man xpipe or online at https://docs.xpipe.io/cli/man/) +- The command help, available via xpipe <command> --help

@@ -32,22 +34,6 @@

Opens the XPipe application

-
launch
-
-

Launches a specified shell connection in your existing terminal session

-
-
sink
-
-

Write the contents of stdin to a remote file.

-
-
drain
-
-

Reads the contents of a remote file and prints it to stdout.

-
-
ls, list
-
-

List all stored connections and their ids

-
daemon

Commands for controlling the XPipe daemon

@@ -71,7 +57,7 @@
1
-

Client error: one or more inputs were not correctly specified

+

Client error: One or more inputs were not correctly specified

2
@@ -79,7 +65,7 @@
3
-

Connection error: could either not start or communicate to the XPipe daemon

+

Connection error: Could either not start or communicate with the XPipe daemon