rob/octoplex
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

fixup! doc: update README

Browse Source
This commit is contained in:
Rob Watson 2025-05-15 08:45:14 +02:00
parent 0e5a2c5375
commit bf8696037b
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -58,7 +58,7 @@ Unarchive the `octoplex` binary and copy it somewhere in your $PATH.
## Usage
Octoplex can run as a single process (all-in-one), or in separate client/server mode.
Octoplex can run as a single process (all-in-one), or in a client/server pair.
Mode|Pick this when you...
---|---
@ -71,15 +71,13 @@ Client/server|Want the server on a remote host (e.g., cloud VM) for long-running
$ octoplex run
```
Starts the Octoplex server and terminal UI in one process, right in your local console.
Starts the Octoplex server **and** the terminal UI in one process.
This is a great option to get started quickly!
Note: Docker must be running on the same machine.
_Docker must be running on the same machine._
### Client/server mode
1. **Start the server** (on the host you want to handle the streams):
1. **Start the server** (on the host that has Docker):
```bash
$ octoplex server start
@ -91,9 +89,9 @@ $ octoplex server start
$ octoplex client start # --host my.remotehost.com if on a different host
```
`client` is a lightweight TUI and does not require Docker to be installed.
`client start` is a lightweight TUI and **does not need Docker to be installed**.
3. **Stop the server** (and clean up and Docker resources) on the remote host:
3. **Stop the server** (and clean up any Docker resources) on the remote host:
```bash
$ octoplex server stop