Skip to content

Commit 1e0db79

Browse files
author
mirkobrombin
committed
chore: document --socket flag
1 parent 4df9102 commit 1e0db79

2 files changed

Lines changed: 13 additions & 8 deletions

File tree

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,18 @@ Highly inspired by [host-spawn](https://github.com/1player/host-spawn).
1515

1616
First you have to start the socket server on your host machine:
1717

18-
```bash
19-
hrun start
20-
```
21-
22-
Then you can run commands from inside your container:
23-
24-
```bash
25-
hrun echo "Hello from your host machine"
18+
```text
19+
Usage: hrun [options] [command] [args...]
20+
21+
Options:
22+
-h, --help Display this help message.
23+
--start Start the server.
24+
--allowed-cmd Specify allowed command (can be used multiple times).
25+
--socket Specify an alternative socket path (default: /tmp/hrun.sock).
26+
27+
If command is "start", it starts the server with specified allowed commands.
28+
Otherwise, it starts the client and sends the command to the server.
29+
If no command is provided, it starts a shell on the host.
2630
```
2731

2832
## What's the point?

main.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Options:
4444
-h, --help Display this help message.
4545
--start Start the server.
4646
--allowed-cmd Specify allowed command (can be used multiple times).
47+
--socket Specify an alternative socket path (default: /tmp/hrun.sock).
4748
4849
If command is "start", it starts the server with specified allowed commands.
4950
Otherwise, it starts the client and sends the command to the server.

0 commit comments

Comments
 (0)