usage-hud
输入框下方的用量面板:会按工具做动作的像素小螃蟹 + 三列对齐的模型/用量/状态网格(Windows / macOS / Linux)
何をするか
- プロンプトの上の帯・トーストを描く
- /hud を足す
- ツールの呼び出しを見張る
- classic.SessionStart・session.measure・session.start・turn.complete ほか 2 個にフックする
- ターンをまたいで自分の状態を持つ
良いところ
- ネットワークに出ない
- TypeScript で書かれている
- デスクトップ専用の分岐がある
- エラーを扱う
作り始めるためのコード
2 種類あります。上のデザインから modscode が書いた雛形と、その Mod 自身のコードのうち描いている部分です。
雛形(register.tsx)
import type { Register } from 'claude-code'
// Drawn like usage-hud by Ronan (band, toast), as modscode read it from the mod's code:
// https://modscode.com/gallery/ronanworks-usage-hud/
// Written by modscode from that reading, not copied from the mod: use it as you like.
// Each value below stands for one the mod works out at run time; put in your own.
export const register: Register = on => {
// the band above the prompt; what else goes there is drawn under it
on('ui.render', { component: 'AbovePrompt' }, async ($, e, next) => {
const { Box, Svg } = $.ui.resolve(e)
const crab = '…'
const dash = '…'
const pct = '…'
return (
<Box flexDirection="column">
<Box flexDirection="row" alignItems="center" columnGap={2}>
<Box flexShrink={0}>
<Svg source={`${crab}`} alt="用量面板的小螃蟹" />
</Box>
<Box flexGrow={1} flexShrink={1} minWidth={0} overflow="hidden">
<Svg source={`${dash}`} alt={`上下文 ${pct}%,5小时 ${pct}%,本周 ${pct}%`} />
</Box>
</Box>
{await next(e)}
</Box>
)
})
on('session.start', async ($, e, next) => {
const err = '…'
await $.ui.toast(`已打开项目文件夹`)
await $.ui.toast(`打开失败: ${err}`)
return next(e)
})
}
Mod 自身のコード
Mod のライセンス(MIT)に従って載せています。全文は下にあります。写すときは著作権表示を残してください。
usage-hud/hooks/register.tsx 1413〜1429 行 · バンド
on('ui.render', { component: 'AbovePrompt' }, async ($, e, next) => {
if (layout === 'off' || e.props.hasSurvey) return next(e)
if (e.surface === 'desktop') {
const els: any = $.ui.resolve(e)
return buildDesktop($, els, e.props.bodyColumns ?? 100, !!e.props.isWorking)
}
if (e.surface !== 'terminal' || position !== 'above') return next(e)
const els: any = $.ui.resolve(e)
const { Box, Text } = els
const view = await buildView($, els, e.surface, e.props.bodyColumns ?? 100, !!e.props.isWorking)
return (
<Box flexDirection="column">
<Text key="gap"> </Text>
{view}
</Box>
)
})usage-hud/hooks/register.tsx 912〜979 行 · バンド
async function buildDesktop($: any, els: any, cols: number, working: boolean) {
const { Box, Svg } = els
const s = await snapshot($, working)
const reset = (l?: Limit) => (l?.resetsAt ? durShort(Date.parse(l.resetsAt) - Date.now()) + ' 后重置' : '')
const ag = agentsNow ? ` +${agentsNow} 个子代理` : ''
// 客户端只显示到分钟: 每秒变一次会让图片每秒重换一次
const ran = s.now - turnStartedAt
const status: DashData['status'] = working
? { text: toolLabel(currentTool) + (ran >= 60_000 ? ' ' + durShort(ran) : '') + ag, tone: 'work' }
: agentsNow
? { text: agentsNow + ' 个子代理在跑', tone: 'agents' }
: lastTurnMs
? { text: '✓ 上一轮 ' + dur(lastTurnMs) + ',' + lastTurnTools + ' 次工具', tone: 'idle' }
: { text: '✓ 待命', tone: 'idle' }
const top = Object.entries(toolCounts)
.sort((a, b) => b[1] - a[1])
.slice(0, 3)
.map(([t, n]) => shortTool(t) + ' ' + n)
.join(' ')
const counted = tokState === 'ready' || tokState === 'failed'
const data: DashData = {
model: prettyModel(modelId),
effort,
project: project || '--',
branch: branch ? branch + (dirty ? ' *' + dirty : '') : '',
session: dur(s.now - (s.u.startedAt ?? s.now)),
cost: s.u.cost ? '$' + s.u.cost.usd.toFixed(2) : '',
ctx: { pct: s.pct, extra: tok(s.ctxTokens) + ' / ' + tok(s.ctxWindow) },
five: { pct: s.five?.percentUsed, extra: reset(s.five) },
week: { pct: s.week?.percentUsed, extra: reset(s.week) },
status,
tools: top,
tokenTotal: counted ? big(tokTotal(s.tk)) : '统计中..',
tokenOutput: counted ? big(s.tk.output) : '',
}
const sc = s.scene
// 可用宽度: 横栏格数 x 每格像素, 减去螃蟹和间距; 太窄就只放一行用量条
lastDesktopCols = cols
const crabScale = 5
const crabW = 16 * crabScale
// 估计的可用宽度; 故意多画 5% + 20 像素, 让客户端总是把它等比缩到正好贴满卡片, 右边缘和卡片对齐
const est = Math.round((cols || 100) * DESKTOP_PX_PER_COL) - crabW - 15
const dashW = Math.max(340, Math.min(1040, Math.round(est * 1.05) + 20))
const compact = layout === 'compact' || est < 380
// 螃蟹直接画在卡片上 (没有底板/边框); 当普通图片显示, SMIL 动画照样会动, 必须给明确宽高
const crab = crabSvg(
{
mode: sc.celebrating ? 'celebrate' : working ? 'work' : sc.sleeping ? 'sleep' : 'idle',
kind: sc.kind,
heat: lastPct >= 95 ? 'crit' : lastPct >= 80 ? 'hot' : 'ok',
agents: Math.min(3, agentsNow),
},
compact ? 3 : crabScale,
)
const crabSize = compact ? { w: 48, h: 21 } : { w: crabW, h: 7 * crabScale }
const dash = dashSvg(data, { compact, width: dashW })
return (
<Box key="hud-d-row" flexDirection="row" alignItems="center" columnGap={2}>
<Box key="hud-d-crab" flexShrink={0}>
<Svg key="crab-svg" source={crab} alt="用量面板的小螃蟹" width={crabSize.w} height={crabSize.h} />
</Box>
{/* 估计的宽度偏大时, 这个容器允许仪表盘等比缩小, 不会被截断 */}
<Box key="hud-d-dash" flexGrow={1} flexShrink={1} minWidth={0} overflow="hidden">
<Svg key="dash-svg" source={dash} alt={`上下文 ${data.ctx.pct ?? '--'}%,5小时 ${data.five.pct ?? '--'}%,本周 ${data.week.pct ?? '--'}%`} />
</Box>
</Box>
)
}ライセンスの全文(MIT)
MIT License Copyright (c) 2026 Ronan Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
コードが呼ぶもの
プログラム起動ファイル読み取り環境変数Claude を動かすツール呼び出し保存
コードから読み取ったデザイン
読み取ったコミットのソースから描いたもので、動かした結果ではありません。一覧は 3 回描き、条件はデスクトップアプリで描く最初の分岐を取り、動かしたときにだけ決まる値は仮の例(点線の下線)にするか省きます。色と書体はこのサイトのものです。
コードから読めること
2026-10-06 に読んだコミット e3330546eb4a のソースから。最初のまとまりが載せる条件で、残りは自分で判断するための材料です。後のコミットは、次に読むまで見ていません。
| 載せる条件: 確かめやすいコード | |
|---|---|
| 入口を読んだ | hooks/hooks.json が名指すモジュールをすべて読んだ。usage-hud/hooks/register.tsx |
| 解析できる | すべてのファイルが TypeScript か JavaScript として解析できる。2 ファイルを解析 |
| コードが Mod の中で完結 | import は Mod 自身のファイルかエンジンのモジュールだけ。パッケージも require もない。コードはすべて Mod の中 |
| 読める | 圧縮した行・eval・new Function・計算した道の import()・符号化した塊がない。圧縮・eval・符号化した塊なし |
| 呼び出しが見える | 通信とプログラム起動はその場で $.http.fetch・$.process.run と書き、他へ渡さない。外への呼び出しはすべてその場の $ で |
| 入れる前に自分で判断する材料 | |
| 描く場所 | コードから読んだ、描く先。ターミナル・デスクトップアプリ・両方・何も描かない(フックだけ: 見張りやプロンプトの書き換え)のどれか。出すだけで、外す理由にはしない。ターミナルとデスクトップアプリに描く(デスクトップ用の分岐あり) |
| 入れる手順 | リポジトリ自身の .claude-plugin/marketplace.json にこの Mod が載っていて、ページに書いた手順でそのマーケットプレイスから入れられるか。リポジトリの .claude-plugin/marketplace.json に載っており、そこから入れられる |
| Windows のプログラム | $.process で起動するプログラムが Windows にあるか(tail・date・open・osascript・/usr/… などは無い)。Windows にないプログラムを使わない |
| 通信 | fetch の送り先(https のホスト)がコードに書いてあるか。通信なし |
| プログラム | 起動するプログラムの名前がコードに書いてあり、シェル・インタプリタ・通信用の道具でないか。usage-hud/hooks/register.tsx:651 実行時に決まるプログラム; usage-hud/hooks/register.tsx:693 cmd.exe(シェル・インタプリタ); usage-hud/hooks/register.tsx:696 powershell.exe(シェル・インタプリタ); usage-hud/hooks/register.tsx:715 cmd.exe(シェル・インタプリタ); usage-hud/hooks/register.tsx:809 node(シェル・インタプリタ) |
| 読んで送る | ファイルや環境変数を読み、かつ通信するか。reads environment variables and files and reaches the network |
| ソースの鍵 | ソースに API キーや秘密鍵らしきものがあるか。ソースに鍵なし |
| ライセンス | オープンなライセンス(MIT・Apache-2.0・BSD・ISC・Unlicense・0BSD・CC0)で全文があれば、modscode にコードを載せる。違えばリンクだけ。MIT |
コードの文面を読んだだけで、安全の審査ではありません。動かしてはおらず、起動するプログラムの中で何が起きるかも見えません。入れる前の確認はあなたの役目です。 載せる条件
入れる
入れる前に、必ず自分で確かめてください。Mod はサンドボックスなしで、あなたの権限で動きます。modscode はこのコードの安全を保証しません。下のコードを読み(またはフォルダーで claude plugin validate .)、触るものを見て、読んだコミットを入れてください。
リポジトリがそのままマーケットプレイスです。このマーケットプレイスを足し(ターミナルでは次のコマンド、デスクトップアプリではプラグインの設定)、そこから Mod を入れます。
/plugin marketplace add ronanworks/claude-code-mods/plugin install usage-hud@claude-code-mods入るのはマーケットプレイスの最新のコミットで、ここで読んだもの(e3330546eb4a)と違うことがあります。入れる前に見比べてください。
Claude に聞く
modscode のコネクタを入れると、Claude がこのデザイン・コードが触るもの・コードを読んで、それをもとに作れます。たとえば:
modscode のデザイン「ronanworks-usage-hud」をコードごと読んで、同じようなペインを作って似たデザイン
-
▴Token OptimizerCheckpointCheckpointCheckpointbuildStart freshbuildStart freshbuildStart freshbuildCheckpointCheckpointCheckpointCheckpointCheckpointCheckpointCheckpointCheckpointCheckpointbuildbuildbuildTokens savedSaved Clean up tokens in 30 days (chat 2 this session)Claude に頼む…
-
plan-progress is on. A bar appears when Claude starts a task with several steps.Claude に頼む…
-
Claude に頼む…Fix loginRemoveCopy markdownacme/app · mainCopy linkCopy markdownbuild2h 10mbuild2h 10mbuild2h 10mHosted on uploads.sh, not committed to the repo.They will appear in a comment on the pull request once opened.
-
何をするか
- プロンプトの上の帯・欄を描く
- /progress を足す
- ツールの呼び出しを見張る(止めることがある)
- classic.SessionStart・prompt.compose・prompt.submit・session.start ほか 2 個にフックする
-
pixel-pet: your theme no longer reads (3). Showing the slime.Claude に頼む…pixel-pet:
-
Contextchat 2Context42%Agentbuild42%Agentbuild42%Agentbuild42%Agent· Weekly· Weekly· Weekly⏳ AgentContext⏳ AgentContext⏳ Agent+3 more agents runningContextClaude に頼む…