Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

Commit 473983e

Browse files
committed
Move quick start before the command reference
1 parent 3c59d70 commit 473983e

File tree

1 file changed

+29
-27
lines changed

1 file changed

+29
-27
lines changed

README.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -27,33 +27,6 @@ Use **`vendor/bin/hyper-run`** as the execution path.
2727

2828
## Usage
2929

30-
```ShellSession
31-
mpyw@localhost:~$ hyper-run -h
32-
33-
Usage:
34-
hyper-run <options>
35-
36-
Example:
37-
hyper-run -S localhost:8000 -s localhost:44300
38-
39-
[Required]
40-
-S "<Host>:<Port>" of an HTTP server. Multiple arguments can be accepted.
41-
-s "<Host>:<Port>" of an HTTPS server. Multiple arguments can be accepted.
42-
43-
[Optional]
44-
-n The number of PHP built-in server clusters, from 1 to 20. Default is 10.
45-
-t Path for the document root. Default is the current directory.
46-
-r Path for the router script. Default is empty.
47-
-c Path for the PEM-encoded certificate.
48-
Default is "/Users/mpyw/.composer/vendor/mpyw/php-hyper-builtin-server/certificate.pem".
49-
50-
Restrictions:
51-
- The option -s is only supported on PHP 5.6.0 or later.
52-
- Access logs will not be displayed on Windows.
53-
54-
mpyw@localhost:~$
55-
```
56-
5730
### Quick start
5831

5932
```shell script
@@ -83,6 +56,35 @@ hyper-run -S localhost:8080 -s localhost:4000 -t src/app/www
8356
- `http://localhost:8080`
8457
- `https://localhost:4000`
8558

59+
### Command Reference
60+
61+
```ShellSession
62+
mpyw@localhost:~$ hyper-run -h
63+
64+
Usage:
65+
hyper-run <options>
66+
67+
Example:
68+
hyper-run -S localhost:8000 -s localhost:44300
69+
70+
[Required]
71+
-S "<Host>:<Port>" of an HTTP server. Multiple arguments can be accepted.
72+
-s "<Host>:<Port>" of an HTTPS server. Multiple arguments can be accepted.
73+
74+
[Optional]
75+
-n The number of PHP built-in server clusters, from 1 to 20. Default is 10.
76+
-t Path for the document root. Default is the current directory.
77+
-r Path for the router script. Default is empty.
78+
-c Path for the PEM-encoded certificate.
79+
Default is "/Users/mpyw/.composer/vendor/mpyw/php-hyper-builtin-server/certificate.pem".
80+
81+
Restrictions:
82+
- The option -s is only supported on PHP 5.6.0 or later.
83+
- Access logs will not be displayed on Windows.
84+
85+
mpyw@localhost:~$
86+
```
87+
8688
## Note for Windows users
8789

8890
Unfortunately, `cmd.exe` has no option to run via shebang `#!/usr/bin/env php`, so you need to create the following batch file in the proper directory.

0 commit comments

Comments
 (0)