Skip to content

Commit 214ff9a

Browse files
Clarify README install and usage steps
Signed-off-by: Philipp Polterauer <45892981+PhilippPolterauer@users.noreply.github.com> Signed-off-by: Philipp Polterauer <45892981+PhilippPolterauer@users.noreply.github.com>
1 parent 48bdb73 commit 214ff9a

2 files changed

Lines changed: 61 additions & 46 deletions

File tree

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# OpenCode Quotas
1+
# OpenCode Quotas Plugin
22

3-
**The ultimate usage dashboard for your AI coding assistants.**
3+
**The ultimate usage dashboard plugin for your AI coding assistants.**
44

5-
**OpenCode Quotas** aggregates usage data from Antigravity, Codex, and GitHub Copilot into a single, beautiful dashboard injected directly into your OpenCode chat footer. Never hit a rate limit unexpectedly again.
5+
**OpenCode Quotas** is an OpenCode.ai plugin that aggregates usage data from Antigravity, Codex, and GitHub Copilot into a single, beautiful dashboard injected directly into your OpenCode chat footer. Never hit a rate limit unexpectedly again.
66

7-
![OpenCode Quotas Dashboard](docs/QuotaDisplay.png)
7+
![OpenCode Quotas](docs/QuotaDisplay.png)
88

99
> **Note**: This is a community-developed plugin and is not officially affiliated with OpenCode.ai.
1010
@@ -18,6 +18,9 @@
1818

1919
## Installation
2020

21+
### 1. Clone & Build
22+
Clone the repository into your OpenCode plugins directory and build it:
23+
2124
```bash
2225
# Clone into your plugins directory
2326
git clone https://github.com/your-org/opencode-quotas ~/.opencode/plugins/opencode-quotas
@@ -28,13 +31,25 @@ bun install
2831
npm run build
2932
```
3033

34+
### 2. Register the Plugin
35+
Add `opencode-quotas` to your OpenCode configuration file (typically `~/.opencode/config.json`) under the `plugins` array:
36+
37+
```json
38+
{
39+
"plugin": [
40+
"opencode-antigravity-auth",
41+
"opencode-quotas"
42+
]
43+
}
44+
```
45+
3146
## Usage
3247

33-
Once installed, a live quota summary is automatically appended to every assistant message footer.
48+
Once installed and registered, a live quota summary is automatically appended to every assistant message footer in OpenCode. No further action is required.
3449

35-
### CLI Mode
50+
### CLI Mode (Optional)
3651

37-
Check quotas directly from your terminal without sending a message:
52+
You can also use OpenCode Quotas as a standalone CLI tool to check quotas directly from your terminal:
3853

3954
```bash
4055
# Show all quotas

package.json

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
{
2-
"name": "opencode-quotas",
3-
"version": "0.0.1-beta",
4-
"description": "Opencode quota hub plugin for Antigravity and Codex",
5-
"main": "dist/index.js",
6-
"types": "dist/index.d.ts",
7-
"type": "module",
8-
"exports": {
9-
".": {
10-
"types": "./dist/index.d.ts",
11-
"import": "./dist/index.js"
2+
"name": "opencode-quotas",
3+
"version": "0.0.1",
4+
"description": "Opencode quota hub plugin for Antigravity and Codex",
5+
"main": "dist/index.js",
6+
"types": "dist/index.d.ts",
7+
"type": "module",
8+
"exports": {
9+
".": {
10+
"types": "./dist/index.d.ts",
11+
"import": "./dist/index.js"
12+
}
13+
},
14+
"packageManager": "bun@1.1.20",
15+
"bin": {
16+
"opencode-quotas": "./dist/src/cli.js"
17+
},
18+
"files": [
19+
"dist",
20+
"src",
21+
"README.md",
22+
"LICENSE"
23+
],
24+
"scripts": {
25+
"opencode-quotas": "bun src/cli.ts",
26+
"build": "tsc -p tsconfig.build.json",
27+
"typecheck": "tsc --noEmit"
28+
},
29+
"engines": {
30+
"node": ">=20"
31+
},
32+
"dependencies": {
33+
"@ai-sdk/provider": "^3.0.2",
34+
"@opencode-ai/plugin": "^1.1.3"
35+
},
36+
"devDependencies": {
37+
"@types/node": "^22.0.0",
38+
"js-yaml": "^4.1.1",
39+
"typescript": "^5.9.3",
40+
"yaml": "^2.8.2"
1241
}
13-
},
14-
"packageManager": "bun@1.1.20",
15-
"bin": {
16-
"opencode-quotas": "./dist/src/cli.js"
17-
},
18-
"files": [
19-
"dist",
20-
"src",
21-
"README.md",
22-
"LICENSE"
23-
],
24-
"scripts": {
25-
"opencode-quotas": "bun src/cli.ts",
26-
"build": "tsc -p tsconfig.build.json",
27-
"typecheck": "tsc --noEmit"
28-
},
29-
"engines": {
30-
"node": ">=20"
31-
},
32-
"dependencies": {
33-
"@ai-sdk/provider": "^3.0.2",
34-
"@opencode-ai/plugin": "^1.1.3"
35-
},
36-
"devDependencies": {
37-
"@types/node": "^22.0.0",
38-
"js-yaml": "^4.1.1",
39-
"typescript": "^5.9.3",
40-
"yaml": "^2.8.2"
41-
}
4242
}

0 commit comments

Comments
 (0)