claude-usage-explorer 1.0.0 → 1.0.1

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 (4) hide show
  1. package/.claude-plugin/marketplace.json +30 -5
  2. package/.claude-plugin/plugin.json +11 -5
  3. package/README.md +46 -14
  4. package/package.json +20 -1
package/.claude-plugin/marketplace.json CHANGED
@@ -1,5 +1,30 @@
1
- {
2
- "name": "claude-usage-explorer-marketplace",
3
- "owner": {"name": "Claude Usage Explorer contributors"},
4
- "plugins": [{"name": "claude-usage", "source": "./", "description": "Local Claude Code usage explorer"}]
5
- }
1
+ {
2
+ "name": "claude-usage-explorer-marketplace",
3
+ "description": "Local, read-only Claude Code token usage analytics and terminal tools",
4
+ "owner": {
5
+ "name": "IliasPol",
6
+ "url": "https://github.com/IliasPol"
7
+ },
8
+ "plugins": [
9
+ {
10
+ "name": "claude-usage",
11
+ "source": "./",
12
+ "description": "Explore Claude Code projects, sessions, token usage, model breakdowns and estimated costs locally",
13
+ "version": "1.0.0",
14
+ "author": {
15
+ "name": "IliasPol"
16
+ },
17
+ "homepage": "https://github.com/IliasPol/claude-usage",
18
+ "repository": "https://github.com/IliasPol/claude-usage",
19
+ "license": "MIT",
20
+ "category": "development",
21
+ "tags": [
22
+ "claude-code",
23
+ "usage",
24
+ "analytics",
25
+ "tokens",
26
+ "terminal"
27
+ ]
28
+ }
29
+ ]
30
+ }
package/.claude-plugin/plugin.json CHANGED
@@ -1,5 +1,11 @@
1
- {
2
- "name": "claude-usage",
3
- "description": "Interactive native Claude Code usage sidebar and standalone TUI",
4
- "version": "1.0.0"
5
- }
1
+ {
2
+ "name": "claude-usage",
3
+ "description": "Local, read-only Claude Code usage analytics with a native sidebar and standalone terminal UI",
4
+ "version": "1.0.0",
5
+ "author": {
6
+ "name": "IliasPol"
7
+ },
8
+ "homepage": "https://github.com/IliasPol/claude-usage",
9
+ "repository": "https://github.com/IliasPol/claude-usage",
10
+ "license": "MIT"
11
+ }
package/README.md CHANGED
@@ -1,31 +1,57 @@
1
1
  # Claude Usage Explorer
2
2
 
3
- A local, read-only usage explorer for Claude Code. Browse projects, sessions, agents and models, inspect token usage and estimated API-equivalent costs, and optionally view cached Claude Desktop plan-limit percentages. No external npm dependencies or telemetry.
3
+ **Explore Claude Code token usage, estimated API-equivalent costs, projects, sessions, and agents — locally.** Use a native Claude Code sidebar or a standalone terminal dashboard. No uploads, telemetry, or external npm dependencies.
4
4
 
5
- > **Release candidate:** v1.0.0. The standalone terminal UI is automated-test verified. Native Claude Code mod integration and the external-terminal launcher require final host verification before a stable release.
5
+ [![npm version](https://img.shields.io/npm/v/claude-usage-explorer.svg)](https://www.npmjs.com/package/claude-usage-explorer)
6
+ [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
6
7
 
7
- ## Requirements
8
+ ## Preview
8
9
 
9
- - Node.js 20+ (Node 22 recommended)
10
- - Claude Code with native Mods support for the sidebar
11
- - Local Claude Code JSONL transcript history
10
+ ### Native Claude Code sidebar
11
+
12
+ ![Claude Usage Explorer inside the Claude Code sidebar](docs/screenshots/native-sidebar.png)
13
+
14
+ Use `/usage-explorer` to inspect local usage without leaving your Claude Code session.
12
15
 
13
- ## Install the standalone CLI (npm)
16
+ ### Standalone terminal dashboard
14
17
 
15
- Once this package is published on npm, install it globally with Node.js 20+:
18
+ ![Claude Usage Explorer standalone terminal dashboard](docs/screenshots/standalone-tui.png)
19
+
20
+ Run `claude-usage tui` to explore projects, sessions, token usage, model breakdowns, and estimated costs.
21
+
22
+ ## Quick start
23
+
24
+ **Standalone CLI (Node.js 20+):**
16
25
 
17
26
  ```sh
18
27
  npm install -g claude-usage-explorer
19
28
  claude-usage tui
20
29
  ```
21
30
 
22
- Or run it without a global installation:
31
+ **Claude Code community plugin marketplace:**
32
+
33
+ ```sh
34
+ claude plugin marketplace add IliasPol/claude-usage
35
+ claude plugin install claude-usage@claude-usage-explorer-marketplace
36
+ ```
37
+
38
+ Then run `/usage-explorer` in a compatible Claude Code session.
39
+
40
+ ## Requirements
41
+
42
+ - Node.js 20+ (Node 22 recommended)
43
+ - Claude Code with native Mods support for the sidebar
44
+ - Local Claude Code JSONL transcript history
45
+
46
+ ## Standalone CLI: other ways to run
47
+
48
+ Run without a global installation:
23
49
 
24
50
  ```sh
25
51
  npx --yes --package claude-usage-explorer claude-usage tui
26
52
  ```
27
53
 
28
- **Note:** These commands will work only after the package is published to the npm registry. The GitHub repository alone does not publish an npm package. On Windows PowerShell, use `npm.cmd` and `claude-usage.cmd` if execution policy blocks the `.ps1` shims.
54
+ **Note:** On Windows PowerShell, use `npm.cmd` and `claude-usage.cmd` if execution policy blocks the `.ps1` shims.
29
55
 
30
56
  To run directly from a local checkout, use:
31
57
 
@@ -35,7 +61,13 @@ node ./bin/claude-usage.mjs tui
35
61
 
36
62
  Run the TUI in an **interactive terminal**, not inside a noninteractive Claude tool shell. The optional macOS/Linux installer `./scripts/install-command.sh` is still available for source checkouts but is not needed for npm installations.
37
63
 
38
- ## Run the native Claude Code sidebar
64
+ ## Claude Code plugin installation
65
+
66
+ Alternatively, from inside Claude Code use `/plugin marketplace add IliasPol/claude-usage`, followed by `/plugin install claude-usage@claude-usage-explorer-marketplace`.
67
+
68
+ This repository hosts a **community marketplace**, not an Anthropic-curated listing. After installation, use `/usage-explorer` in compatible Claude Code environments. Native mod/sidebar support may depend on the installed Claude Code version; if it is unavailable, the standalone `claude-usage tui` remains an option.
69
+
70
+ ## Native sidebar: local development
39
71
 
40
72
  Start Claude Code with the local plugin directory:
41
73
 
@@ -75,10 +107,10 @@ npm run check
75
107
 
76
108
  The GitHub Actions workflow tests on Windows, macOS and Ubuntu.
77
109
 
78
- ## Contributing and security
110
+ ## Contributing, security, and license
79
111
 
80
- See [CONTRIBUTING.md](CONTRIBUTING.md) and [SECURITY.md](SECURITY.md). Licensed under [MIT](LICENSE).
112
+ Contributions are welcome: see [CONTRIBUTING.md](CONTRIBUTING.md). Please report vulnerabilities following [SECURITY.md](SECURITY.md). This project is licensed under the [MIT License](LICENSE).
81
113
 
82
114
  ## Support
83
115
 
84
- If this project is useful, you can star the repository. GitHub Sponsors may be enabled later; no donation or payment service is required to use the project.
116
+ If Claude Usage Explorer is useful, consider [starring the repository](https://github.com/IliasPol/claude-usage). The tool is free and open source.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "claude-usage-explorer",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Local, read-only Claude Code usage analytics CLI and plugin",
5
5
  "type": "module",
6
6
  "bin": {
@@ -25,5 +25,24 @@
25
25
  "scripts/",
26
26
  "README.md",
27
27
  "LICENSE"
28
+ ],
29
+ "homepage": "https://github.com/IliasPol/claude-usage#readme",
30
+ "repository": {
31
+ "type": "git",
32
+ "url": "git+https://github.com/IliasPol/claude-usage.git"
33
+ },
34
+ "bugs": {
35
+ "url": "https://github.com/IliasPol/claude-usage/issues"
36
+ },
37
+ "keywords": [
38
+ "claude-code",
39
+ "claude",
40
+ "usage-tracker",
41
+ "token-usage",
42
+ "cost-tracking",
43
+ "terminal-ui",
44
+ "analytics",
45
+ "developer-tools",
46
+ "cli"
28
47
  ]
29
48
  }