Skip to content

Commit c62fc9f

Browse files
committed
docs: Update README to include usage instructions with npx
1 parent b69cc76 commit c62fc9f

1 file changed

Lines changed: 22 additions & 7 deletions

File tree

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,23 @@ To install dependencies, run:
2222
bun install
2323
```
2424

25-
## Running the Project
25+
## Using with npx
2626

27-
The project can be run in several ways:
27+
You can run the project directly using npx:
28+
29+
```sh
30+
npx copilot-api
31+
```
32+
33+
With options:
34+
35+
```sh
36+
npx copilot-api --port 8080 --emulate-streaming
37+
```
38+
39+
## Running from Source
40+
41+
The project can be run from source in several ways:
2842

2943
### Development Mode
3044

@@ -46,11 +60,12 @@ Runs the server in production mode with optimizations enabled and hot reloading
4660

4761
The server accepts several command line options:
4862

49-
| Option | Description | Default |
50-
| ------------------- | ----------------------------------- | ------- |
51-
| --help, -h | Show help message | false |
52-
| --emulate-streaming | Enable streaming response emulation | false |
53-
| --port, -p | Port to listen on | 4141 |
63+
| Option | Description | Default |
64+
| ------------------- | -------------------------------------------------------------- | ------- |
65+
| --help, -h | Show help message | false |
66+
| --emulate-streaming | Enable streaming response emulation | false |
67+
| --port, -p | Port to listen on | 4141 |
68+
| --logs | Write logs to the app directory (requires --emulate-streaming) | false |
5469

5570
Example with options:
5671

0 commit comments

Comments
 (0)