Skip to content

Commit c72e5da

Browse files
committed
docs: update readme
1 parent b8603b2 commit c72e5da

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ Copilot API now uses a subcommand structure with these main commands:
8484
- `start`: Start the Copilot API server. This command will also handle authentication if needed.
8585
- `auth`: Run GitHub authentication flow without starting the server. This is typically used if you need to generate a token for use with the `--github-token` option, especially in non-interactive environments.
8686
- `check-usage`: Show your current GitHub Copilot usage and quota information directly in the terminal (no server required).
87+
- `debug`: Display diagnostic information including version, runtime details, file paths, and authentication status. Useful for troubleshooting and support.
8788

8889
## Command Line Options
8990

@@ -110,6 +111,12 @@ The following command line options are available for the `start` command:
110111
| --verbose | Enable verbose logging | false | -v |
111112
| --show-token | Show GitHub token on auth | false | none |
112113

114+
### Debug Command Options
115+
116+
| Option | Description | Default | Alias |
117+
| ------ | ------------------------------ | ------- | ----- |
118+
| --json | Output debug info as JSON | false | none |
119+
113120
## API Endpoints
114121

115122
The server exposes several endpoints to interact with the Copilot API. It provides OpenAI-compatible endpoints and now also includes support for Anthropic-compatible endpoints, allowing for greater flexibility with different tools and services.
@@ -179,6 +186,12 @@ npx copilot-api@latest auth --verbose
179186

180187
# Show your Copilot usage/quota in the terminal (no server needed)
181188
npx copilot-api@latest check-usage
189+
190+
# Display debug information for troubleshooting
191+
npx copilot-api@latest debug
192+
193+
# Display debug information in JSON format
194+
npx copilot-api@latest debug --json
182195
```
183196

184197
## Using the Usage Viewer

0 commit comments

Comments
 (0)