Skip to content

Commit c1a2d73

Browse files
committed
docs: Add rate limit and wait options to README
1 parent b13615c commit c1a2d73

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,14 @@ npx copilot-api --port 8080
5656

5757
The following command line options are available:
5858

59-
| Option | Description | Default | Alias |
60-
| ---------- | ---------------------------------- | ------- | ----- |
61-
| --port | Port to listen on | 4141 | -p |
62-
| --verbose | Enable verbose logging | false | -v |
63-
| --business | Use a business plan GitHub account | false | none |
64-
| --manual | Enable manual request approval | false | none |
59+
| Option | Description | Default | Alias |
60+
| ------------ | --------------------------------------------- | ------- | ----- |
61+
| --port | Port to listen on | 4141 | -p |
62+
| --verbose | Enable verbose logging | false | -v |
63+
| --business | Use a business plan GitHub account | false | none |
64+
| --manual | Enable manual request approval | false | none |
65+
| --rate-limit | Rate limit in seconds between requests | none | -r |
66+
| --wait | Wait instead of error when rate limit is hit | false | -w |
6567

6668
Example usage:
6769

@@ -74,6 +76,12 @@ npx copilot-api@latest --business
7476

7577
# Enable manual approval for each request
7678
npx copilot-api@latest --manual
79+
80+
# Set rate limit to 30 seconds between requests
81+
npx copilot-api@latest --rate-limit 30
82+
83+
# Wait instead of error when rate limit is hit
84+
npx copilot-api@latest --rate-limit 30 --wait
7785
```
7886

7987
## Running from Source

0 commit comments

Comments
 (0)