Skip to content

Commit 53b71aa

Browse files
committed
docs: Clarify --github-token usage
1 parent 3b673be commit 53b71aa

2 files changed

Lines changed: 12 additions & 13 deletions

File tree

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -73,16 +73,16 @@ Copilot API now uses a subcommand structure with two main commands:
7373

7474
The following command line options are available for the `start` command:
7575

76-
| Option | Description | Default | Alias |
77-
| -------------- | -------------------------------------------- | ------- | ----- |
78-
| --port | Port to listen on | 4141 | -p |
79-
| --verbose | Enable verbose logging | false | -v |
80-
| --business | Use a business plan GitHub account | false | none |
81-
| --manual | Enable manual request approval | false | none |
82-
| --rate-limit | Rate limit in seconds between requests | none | -r |
83-
| --wait | Wait instead of error when rate limit is hit | false | -w |
84-
| --github-token | Provide GitHub token directly | none | -g |
85-
| --vision | Enable vision capabilities | false | none |
76+
| Option | Description | Default | Alias |
77+
| -------------- | ----------------------------------------------------------------------------- | ------- | ----- |
78+
| --port | Port to listen on | 4141 | -p |
79+
| --verbose | Enable verbose logging | false | -v |
80+
| --business | Use a business plan GitHub account | false | none |
81+
| --manual | Enable manual request approval | false | none |
82+
| --rate-limit | Rate limit in seconds between requests | none | -r |
83+
| --wait | Wait instead of error when rate limit is hit | false | -w |
84+
| --github-token | Provide GitHub token directly (must be generated using the `auth` subcommand) | none | -g |
85+
| --vision | Enable vision capabilities | false | none |
8686

8787
### Auth Command Options
8888

@@ -156,8 +156,7 @@ bun run start
156156
When using the `--manual` flag, the server will prompt you to approve each incoming request:
157157

158158
```
159-
? Accept incoming request? (y/N)
159+
? Accept incoming request? > (y/N)
160160
```
161161

162162
This helps you control usage and monitor requests in real-time.
163-

src/main.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ const start = defineCommand({
109109
alias: "g",
110110
type: "string",
111111
description:
112-
"Provide GitHub token directly instead of using stored token",
112+
"Provide GitHub token directly (must be generated using the `auth` subcommand)",
113113
},
114114
vision: {
115115
type: "boolean",

0 commit comments

Comments
 (0)