Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add escaping flags to skywire-cli exec documentation #841

Merged
merged 1 commit into from
Jul 9, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions cmd/skywire-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ $ skywire-cli visor add-rule (app <route-id> <local-pk> <local-port> <remote-pk>
##### Example

```
$ $ skywire-cli visor add-rule -h
$ skywire-cli visor add-rule -h
Adds a new routing rule

Usage:
Expand All @@ -210,7 +210,7 @@ $ skywire-cli visor add-tp <remote-public-key> [flags]
##### Example

```
$ $ skywire-cli visor add-tp -h
$ skywire-cli visor add-tp -h
Adds a new transport

Usage:
Expand Down Expand Up @@ -258,7 +258,7 @@ $ skywire-cli visor disc-tp (--id=<transport-id> | --pk=<edge-public-key>)
##### Example

```
$ $ skywire-cli visor disc-tp -h
$ skywire-cli visor disc-tp -h
Queries the Transport Discovery to find transport(s) of given transport ID or edge public key

Usage:
Expand Down Expand Up @@ -314,6 +314,13 @@ $ skywire-cli visor exec echo "hello world"
hello world
```

escape a flag

```
$skywire-cli visor exec echo -- "-a"
-a
```


#### gen config

Expand Down Expand Up @@ -594,7 +601,7 @@ $ skywire-cli visor ls-apps
##### Example

```
$ $ skywire-cli visor ls-apps
$ skywire-cli visor ls-apps
app ports auto_start status
skychat 1 true running
skysocks 3 true running
Expand Down Expand Up @@ -677,7 +684,7 @@ $ skywire-cli visor rm-rule <route-id>
##### Example

```
$ $ skywire-cli visor rm-rule -h
$ skywire-cli visor rm-rule -h
Removes a routing rule via route ID key

Usage:
Expand All @@ -695,7 +702,7 @@ $ skywire-cli visor rm-tp <transport-id>
##### Example

```
$ $ skywire-cli visor rm-tp -h
$ skywire-cli visor rm-tp -h
Removes transport with given id

Usage:
Expand All @@ -713,7 +720,7 @@ $ skywire-cli visor rule <route-id>
##### Example

```
$ $ skywire-cli visor rule -h
$ skywire-cli visor rule -h
Returns a routing rule via route ID key

Usage:
Expand Down