Skip to content

Commit 4438209

Browse files
committed
docs: Update README with new features and usage instructions
1 parent 9a09b85 commit 4438209

File tree

1 file changed

+31
-12
lines changed

1 file changed

+31
-12
lines changed

README.md

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This project is a reverse-engineered implementation of the GitHub Copilot API cr
55

66
## Project Overview
77

8-
A wrapper around GitHub Copilot API to make it OpenAI compatible, making it usable for other tools.
8+
A wrapper around GitHub Copilot API to make it OpenAI compatible, making it usable for other tools like AI assistants, local interfaces, and development utilities.
99

1010
## Demo
1111

@@ -14,7 +14,7 @@ https://github.com/user-attachments/assets/7654b383-669d-4eb9-b23c-06d7aefee8c5
1414
## Prerequisites
1515

1616
- Bun (>= 1.2.x)
17-
- GitHub account with Copilot Individual subscription
17+
- GitHub account with Copilot subscription (Individual or Business)
1818

1919
## Installation
2020

@@ -56,15 +56,24 @@ npx copilot-api --port 8080
5656

5757
The following command line options are available:
5858

59-
| Option | Description | Default |
60-
| ------------- | ---------------------- | ------- |
61-
| --port, -p | Port to listen on | 4141 |
62-
| --verbose, -v | Enable verbose logging | false |
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 |
6365

6466
Example usage:
6567

6668
```sh
69+
# Run on custom port with verbose logging
6770
npx copilot-api@latest --port 8080 --verbose
71+
72+
# Use with a Business GitHub account
73+
npx copilot-api@latest --business
74+
75+
# Enable manual approval for each request
76+
npx copilot-api@latest --manual
6877
```
6978

7079
## Running from Source
@@ -85,17 +94,27 @@ bun run start
8594

8695
## Usage Tips
8796

88-
To avoid rate limiting and optimize your experience:
89-
9097
- Consider using free models (e.g., Gemini, Mistral, Openrouter) as the `weak-model`
9198
- Use architect mode sparingly
9299
- Disable `yes-always` in your aider configuration
93-
- Be mindful that Claude 3.7 thinking mode consume more tokens
100+
- Be mindful that Claude 3.7 thinking mode consumes more tokens
101+
- Enable the `--manual` flag to review and approve each request before processing
102+
- If you have a GitHub Business account with Copilot, use the `--business` flag
103+
104+
### Manual Request Approval
105+
106+
When using the `--manual` flag, the server will prompt you to approve each incoming request:
107+
108+
```
109+
? Accept incoming request? › (y/N)
110+
```
111+
112+
This helps you control usage and monitor requests in real-time.
94113

95114
## Roadmap
96115

97116
- [ ] Manual authentication flow
98-
- [ ] Manual request approval system
117+
- [x] Manual request approval system
99118
- [ ] Rate limiting implementation
100-
- [ ] Token usage tracking and monitoring
101-
- [ ] Enhanced error handling and recovery
119+
- [x] Token counting
120+
- [x] Enhanced error handling and recovery

0 commit comments

Comments
 (0)