repospend 0.0.1 → 0.0.2

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 (2) hide show
  1. package/README.md +46 -7
  2. package/package.json +12 -7
package/README.md CHANGED
@@ -1,12 +1,18 @@
1
1
  # RepoSpend
2
2
 
3
- RepoSpend is a local dashboard for seeing where your AI coding usage is going.
3
+ [![npm version](https://img.shields.io/npm/v/repospend)](https://www.npmjs.com/package/repospend)
4
+ [![npm downloads](https://img.shields.io/npm/dm/repospend)](https://www.npmjs.com/package/repospend)
5
+ [![license](https://img.shields.io/npm/l/repospend)](./LICENSE)
6
+ [![node](https://img.shields.io/node/v/repospend)](https://www.npmjs.com/package/repospend)
7
+ [![CI](https://github.com/mehmetdemircs/RepoSpend/actions/workflows/ci.yml/badge.svg)](https://github.com/mehmetdemircs/RepoSpend/actions/workflows/ci.yml)
4
8
 
5
- It reads your local Codex data, groups work by Git repository, and shows the repos,
6
- sessions, models, commands, and days that are driving token usage and
7
- API-equivalent cost.
9
+ RepoSpend shows which repos, Codex sessions, models, and days are burning your AI
10
+ coding tokens.
8
11
 
9
- `0.0.1` is an early Codex-first release.
12
+ It runs locally, reads your Codex files read-only, and does not upload prompts or
13
+ telemetry.
14
+
15
+ RepoSpend is currently an early Codex-first release.
10
16
 
11
17
  ## Why RepoSpend?
12
18
 
@@ -31,7 +37,7 @@ That makes it easier to answer questions like:
31
37
  - Are command failures or repeated tool issues adding friction?
32
38
  - Which models and days are driving the total?
33
39
 
34
- ## Run It
40
+ ## Quick Start
35
41
 
36
42
  You can run RepoSpend without installing it globally:
37
43
 
@@ -53,6 +59,18 @@ prints the dashboard URL. By default it runs at
53
59
  RepoSpend requires Node.js `20` or newer. It uses `better-sqlite3`, so npm may
54
60
  install a native SQLite package for your platform.
55
61
 
62
+ ## What It Shows
63
+
64
+ RepoSpend helps you break down local Codex usage by:
65
+
66
+ - repo
67
+ - session
68
+ - day and hour
69
+ - model
70
+ - app/source, where detectable
71
+ - token type
72
+ - estimated API-equivalent cost
73
+
56
74
  ## Commands
57
75
 
58
76
  Most of the time you only need:
@@ -98,7 +116,7 @@ RepoSpend stores its own settings here:
98
116
  The Settings page includes a reset action for RepoSpend-owned files under
99
117
  `~/.repospend/`. It does not delete or edit anything under `~/.codex`.
100
118
 
101
- ## About Cost
119
+ ## Cost Estimates, Not Invoices
102
120
 
103
121
  RepoSpend shows **API-equivalent cost**.
104
122
 
@@ -144,6 +162,27 @@ pnpm build
144
162
  [http://127.0.0.1:4318](http://127.0.0.1:4318) and the dashboard on
145
163
  [http://127.0.0.1:2005](http://127.0.0.1:2005), with `/api` proxied locally.
146
164
 
165
+ ## Publishing
166
+
167
+ Most users should run RepoSpend with:
168
+
169
+ ```bash
170
+ npx repospend
171
+ ```
172
+
173
+ Maintainers publish by bumping the package version and pushing the resulting Git
174
+ tag:
175
+
176
+ ```bash
177
+ pnpm version patch
178
+ git push --follow-tags
179
+ ```
180
+
181
+ The npm package `repospend` must have npm Trusted Publishing configured for the
182
+ GitHub repository `mehmetdemircs/RepoSpend` and workflow file
183
+ `.github/workflows/publish.yml` (workflow filename `publish.yml` in npm
184
+ settings). No `NPM_TOKEN` is required for that workflow.
185
+
147
186
  ## Current Limits
148
187
 
149
188
  - Codex is the first supported data source.
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "repospend",
3
- "version": "0.0.1",
4
- "description": "Local-first AI usage and cost dashboard grouped by Git repository.",
3
+ "version": "0.0.2",
4
+ "description": "Local-first dashboard for tracking Codex and AI coding token usage by repo, session, model, and day.",
5
5
  "license": "Apache-2.0",
6
6
  "type": "module",
7
7
  "private": false,
8
8
  "repository": {
9
9
  "type": "git",
10
- "url": "git+https://github.com/mehmetdemircs/RepoSpend.git"
10
+ "url": "https://github.com/mehmetdemircs/RepoSpend"
11
11
  },
12
12
  "bugs": {
13
13
  "url": "https://github.com/mehmetdemircs/RepoSpend/issues"
@@ -40,11 +40,16 @@
40
40
  },
41
41
  "keywords": [
42
42
  "codex",
43
- "usage",
44
- "cost",
43
+ "openai-codex",
44
+ "ai-coding",
45
+ "developer-tools",
46
+ "token-usage",
47
+ "cost-tracking",
48
+ "local-first",
49
+ "cli",
45
50
  "dashboard",
46
- "sqlite",
47
- "local-first"
51
+ "typescript",
52
+ "sqlite"
48
53
  ],
49
54
  "engines": {
50
55
  "node": ">=20"