Skip to content

Commit f61d3d0

Browse files
committed
docs: Document --enterprise flag and clarify --business
1 parent 85d889e commit f61d3d0

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To install dependencies, run:
2626
bun install
2727
```
2828

29-
## Using with docker
29+
## Using with Docker
3030

3131
Build image
3232

@@ -78,6 +78,7 @@ The following command line options are available for the `start` command:
7878
| --port | Port to listen on | 4141 | -p |
7979
| --verbose | Enable verbose logging | false | -v |
8080
| --business | Use a business plan GitHub account | false | none |
81+
| --enterprise | Use an enterprise plan GitHub account | false | none |
8182
| --manual | Enable manual request approval | false | none |
8283
| --rate-limit | Rate limit in seconds between requests | none | -r |
8384
| --wait | Wait instead of error when rate limit is hit | false | -w |
@@ -100,9 +101,12 @@ npx copilot-api@latest start
100101
# Run on custom port with verbose logging
101102
npx copilot-api@latest start --port 8080 --verbose
102103

103-
# Use with a Business GitHub account
104+
# Use with a business plan GitHub account
104105
npx copilot-api@latest start --business
105106

107+
# Use with an enterprise plan GitHub account
108+
npx copilot-api@latest start --enterprise
109+
106110
# Enable manual approval for each request
107111
npx copilot-api@latest start --manual
108112

@@ -145,7 +149,7 @@ bun run start
145149
- Disable `yes-always` in your aider configuration
146150
- Be mindful that Claude 3.7 thinking mode consumes more tokens
147151
- Enable the `--manual` flag to review and approve each request before processing
148-
- If you have a GitHub Business account with Copilot, use the `--business` flag
152+
- If you have a GitHub business or enterprise plan account with Copilot, use the `--business` or `--enterprise` flag respectively
149153

150154
### Manual Request Approval
151155

src/main.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,12 @@ const start = defineCommand({
8484
business: {
8585
type: "boolean",
8686
default: false,
87-
description: "Use a business plan GitHub Account",
87+
description: "Use a business plan GitHub account",
8888
},
8989
enterprise: {
9090
type: "boolean",
9191
default: false,
92-
description: "Use a enterprise plan GitHub Account",
92+
description: "Use an enterprise plan GitHub account",
9393
},
9494
manual: {
9595
type: "boolean",

0 commit comments

Comments
 (0)