opencode-model-costs 0.5.2 → 0.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +5 -0
  2. package/README.md +18 -10
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,11 @@
3
3
  All notable changes to `opencode-model-costs` per released version, newest first.
4
4
  On every version bump, add an entry here at the top.
5
5
 
6
+ ## 0.5.3 — 2026-11-20
7
+
8
+ - Documented installing the plugin from npm globally or per project, pinning a
9
+ release, and configuring the footer for an npm installation.
10
+
6
11
  ## 0.5.2 — 2026-11-20
7
12
 
8
13
  - Fixed `/models-cost` so switching between globally configured and
package/README.md CHANGED
@@ -6,21 +6,27 @@ Compare input, output, and cache prices across models without leaving the [OpenC
6
6
 
7
7
  The screenshot uses the repository’s synthetic pricing fixture.
8
8
 
9
- ## Install from source
9
+ ## Install from npm
10
10
 
11
- This plugin targets **OpenCode 2.3.2**. Installing the pinned OpenTUI dependencies with npm requires **Node.js 26.4.0 or later**.
11
+ This plugin targets **OpenCode 2.3.2**. Run this command to install it and add it to your global OpenCode config. [OpenCode plugin commands](https://opencode.ai/docs/cli/commands/#plugin)
12
12
 
13
- 1. Download or clone this repository.
14
- 2. Run `npm ci` in the checkout.
15
- 3. Add the checkout’s absolute path to the `plugins` array in your project’s `opencode.json(c)`. For all projects, use your global OpenCode config instead.
13
+ ```sh
14
+ opencode plugin add opencode-model-costs
15
+ ```
16
+
17
+ Start or restart OpenCode and run `/models-cost`.
18
+
19
+ ### Install for one project
20
+
21
+ Add `opencode-model-costs` to the `plugins` array in the project’s `opencode.json` or `opencode.jsonc`.
16
22
 
17
23
  ```json
18
24
  {
19
- "plugins": ["/absolute/path/to/opencode-model-costs"]
25
+ "plugins": ["opencode-model-costs"]
20
26
  }
21
27
  ```
22
28
 
23
- Open OpenCode in your project and run `/models-cost`. From the checkout itself, the included [demo config](opencode.json) loads the plugin automatically. Run `opencode --standalone` there to try it with synthetic rates. The demo providers point to a loopback endpoint for browsing and session selection.
29
+ OpenCode installs the plugin from npm when it loads the configuration. To pin a release, use `opencode-model-costs@0.5.3` in the `plugins` array or as the argument to `opencode plugin add`. [OpenCode plugin configuration](https://opencode.ai/docs/build/plugins/#load)
24
30
 
25
31
  ## Browse and switch models
26
32
 
@@ -35,7 +41,7 @@ Open OpenCode in your project and run `/models-cost`. From the checkout itself,
35
41
 
36
42
  ## Configure the footer
37
43
 
38
- By default, the footer shows the current model’s base rates on a separate row below the prompt status line. It includes cache read and write when pricing is available and the line fits. On narrow terminals it shows input and output only. To hide it on OpenCode 2.3.2, set `footer: false` on the plugin entry in your terminal client’s `cli.json` (typically `~/.config/opencode/cli.json`). Use the same plugin path as in the install step.
44
+ By default, the footer shows the current model’s base rates on a separate row below the prompt status line. It includes cache read and write when pricing is available and the line fits. On narrow terminals it shows input and output only. To hide it on OpenCode 2.3.2, set `footer: false` on the plugin entry in your terminal client’s `cli.json` (typically `~/.config/opencode/cli.json`). Use the same package reference as in your `opencode.json(c)`.
39
45
 
40
46
  ![Prompt footer showing input, output, cache read, and cache write rates on their own row](docs/images/model-costs-footer.png)
41
47
 
@@ -43,7 +49,7 @@ By default, the footer shows the current model’s base rates on a separate row
43
49
  {
44
50
  "plugins": [
45
51
  {
46
- "package": "/absolute/path/to/opencode-model-costs",
52
+ "package": "opencode-model-costs",
47
53
  "options": { "footer": false }
48
54
  }
49
55
  ]
@@ -82,6 +88,8 @@ Use an array of cost entries for tiered pricing. A context tier adds `"tier": {
82
88
 
83
89
  ## Contribute
84
90
 
85
- See [CONTRIBUTING.md](CONTRIBUTING.md) for the development setup and hands-on verification steps. The [changelog](CHANGELOG.md) records releases.
91
+ To run from source, clone this repository and run `npm ci` with Node.js 26.4.0 or later. Run `opencode --standalone` in the checkout to try the included demo config with synthetic rates. To use the checkout in another project, add its absolute path to that project’s `plugins` array.
92
+
93
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for hands-on verification steps. The [changelog](CHANGELOG.md) records releases.
86
94
 
87
95
  Released under the [MIT License](LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "opencode-model-costs",
3
- "version": "0.5.2",
3
+ "version": "0.5.3",
4
4
  "description": "Compare model rates in the OpenCode TUI with an optional prompt footer.",
5
5
  "type": "module",
6
6
  "license": "MIT",