Skip to content

Commit 469d235

Browse files
committed
docs: update share command documentation.
- Removed the mention about a new CMD terminal will be launched when using the command, as this behaviour has been removed. - Added the updated terminal output into the main code snippet. - Removed the `--debug` details as the flag has been removed.
1 parent f58488d commit 469d235

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1032,25 +1032,28 @@ $ valet sites
10321032
share Share the current working directory site with a publically accessible URL
10331033
[site] Optionally, specify a site
10341034
[-o|--options] Optionally, specify ngrok options/flags
1035-
[--debug] Allow error messages to output to the current terminal
10361035
```
10371036

10381037
```console
10391038
$ cd /d/sites/site1
10401039
$ valet share
1040+
Sharing site1.test...
1041+
1042+
To output the public URL, please open a new terminal and run `valet fetch-share-url site1.test`
10411043

10421044
$ valet share site1
1045+
Sharing site1.test...
1046+
1047+
To output the public URL, please open a new terminal and run `valet fetch-share-url site1.test`
10431048
```
10441049

10451050
Share your local site publically. ngrok will do all the magic for you and give you a publically accessible URL to share to clients or team members.
10461051

10471052
Before sharing a site with ngrok, you must first set the authtoken using Valet's [`set-ngrok-token` command](#authset-ngrok-token).
10481053

1049-
When using the command, a new CMD terminal will be launched with the ngrok information, including the public URL to share.
1050-
10511054
> [!NOTE]
10521055
>
1053-
> The URL won't be copied to the clipboard, however, in a separate terminal, you can use the [`fetch-share-url` command](#fetch-share-url).
1056+
> The public URL won't be displayed, however, in a separate terminal, you can use the [`fetch-share-url` command](#fetch-share-url) to get the url and copy it to the clipboard.
10541057
10551058
###### share --options
10561059

@@ -1063,10 +1066,6 @@ $ cd /d/sites/site1
10631066
$ valet share -o domain=example.com
10641067
```
10651068

1066-
> [!NOTE]
1067-
>
1068-
> If you're already sharing a project, and try to share another project simultaneously, the new cmd window may open for a split second and then close. This is due to ngrok failing silently, and won't output any error messages. To output the errors, pass the `--debug` flag to the command. This will cause ngrok to try to run in the current terminal instead of a new window, thus sending the error messages.
1069-
10701069
##### auth|set-ngrok-token
10711070

10721071
```

0 commit comments

Comments
 (0)