Skip to content

Commit 450c998

Browse files
committed
docs: update usage example
1 parent c1bdf89 commit 450c998

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ npx copilot-api@latest
3535
With options:
3636

3737
```sh
38-
npx copilot-api --port 8080 --emulate-streaming
38+
npx copilot-api --port 8080
3939
```
4040

4141
## Running from Source
@@ -62,17 +62,18 @@ Runs the server in production mode with hot reloading disabled. Use this for dep
6262

6363
The server accepts several command line options:
6464

65-
| Option | Description | Default |
66-
| ------------- | ---------------------- | ------- |
67-
| --help, -h | Show help message | false |
68-
| --port, -p | Port to listen on | 4141 |
69-
| --verbose, -v | Enable verbose logging | false |
70-
| --log-file | File path for logging | - |
65+
| Option | Description | Default |
66+
| ------------- | ------------------------------------- | ------- |
67+
| --port, -p | Port to listen on | 4141 |
68+
| --verbose, -v | Enable verbose logging | false |
69+
| --log-file | File to log request/response details | - |
70+
71+
Note: The `--help, -h` option is automatically available through the underlying command-line framework.
7172

7273
Example with options:
7374

7475
```sh
75-
bun run start --port 8080 --emulate-streaming
76+
bun run start --port 8080 --verbose
7677
```
7778

7879
In all cases, the server will start and listen for API requests on the specified port.

0 commit comments

Comments
 (0)