modscode EN

modscode / 図鑑 / plan-usage

plan-usage

Shows your Claude plan's session and weekly limits above the prompt, gives Claude a plan_usage tool to check them without a model call, and can pause a long-running session before the session limit and continue after it resets.

確かめやすいコードターミナル+デスクトップバンドトーストBox

何をするか

  • プロンプトの上の帯・トーストを描く
  • /plan-usage を足す
  • ツールの呼び出しを見張る(止めることがある)
  • classic.SessionStart・prompt.submit・session.measure・session.start ほか 2 個にフックする
  • ターンをまたいで自分の状態を持つ

良いところ

  • ネットワークに出ない
  • プロセスを起こさない
  • TypeScript で書かれている
  • デスクトップ専用の分岐がある

作り始めるためのコード

2 種類あります。上のデザインから modscode が書いた雛形と、その Mod 自身のコードのうち描いている部分です。

雛形(register.tsx)

register.tsx
import type { Register } from 'claude-code'

// Drawn like plan-usage by Brian Potter (band, toast), as modscode read it from the mod's code:
// https://modscode.com/gallery/potterdigital-plan-usage/
// 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 } = $.ui.resolve(e)
    return (
      <Box flexDirection="column">

        {await next(e)}
      </Box>
    )
  })

  on('session.start', async ($, e, next) => {
    const percentUsed = '…'
    const shownFrom = '…'
    await $.ui.toast(`Session limit at ${percentUsed}%: pausing once the running tool call finishes`)
    await $.ui.toast(`Plan usage: ${shownFrom}. Saved when this turn ends.`)
    return next(e)
  })
}

Mod 自身のコード

Mod のライセンス(MIT)に従って載せています。全文は下にあります。写すときは著作権表示を残してください。

hooks/register.tsx 399〜492 行 · バンド
  on('ui.render', { component: 'AbovePrompt' }, async ($, e, next) => {
    if (e.props.hasSurvey) return next(e)
    const current = (await $.state.get(READING)).value ?? null
    const pausing = (await $.state.get(PAUSE)).value ?? null
    const pauseOffUntil = (await $.state.get(OVERRIDE)).value ?? 0
    const onboarding = (await $.state.get(ONBOARDING)).value ?? null
    const now = await $.clock.now()
    const { Box, Text } = $.ui.resolve(e)
    const isNarrow = e.props.bodyColumns < 100
    // The band is shared: keep what the mods after this one draw (Claude Code's own notes included) under these lines.
    const theirs = await next(e)

    // The first-run choice, above the usage line. It needs a text field, which the terminal and the desktop app have.
    let choice = null
    if (onboarding !== null && (e.surface === 'terminal' || e.surface === 'desktop')) {
      const { Button, Input } = $.ui.resolve(e)
      choice =
        onboarding.step === 'choose' ? (
          <Box flexDirection="row" columnGap={2}>
            <Text>Plan usage: show your limits above the prompt</Text>
            <Button key="show-always" label="Always" hotkey="1" plain onPress={() => chooseShowAt($, 0)} />
            <Button key="show-50" label="From 50%" hotkey="2" plain onPress={() => chooseShowAt($, 50)} />
            <Button key="show-80" label="From 80%" hotkey="3" plain onPress={() => chooseShowAt($, 80)} />
            <Button key="show-other" label="Other" hotkey="4" plain onPress={() => askOtherPercent($)} />
            {onboarding.note === undefined ? null : <Text>{onboarding.note}</Text>}
          </Box>
        ) : (
          <Box flexDirection="row" columnGap={2}>
            <Input
              key="show-at"
              label="Plan usage: show limits from what percent"
              placeholder="0 to 100"
              value=""
              submitLabel="save"
              autoFocus
              onSubmit={(text: string) => submitOtherPercent($, text)}
            />
            {onboarding.note === undefined ? null : <Text>{onboarding.note}</Text>}
          </Box>
        )
    }

    let usage = null
    if (current === null) {
      if (showAt === 0) usage = <Text wrap="truncate-end">◌ Plan usage: no reading yet (it appears after the first reply)</Text>
    } else {
      const shown = BAND_KINDS.flatMap(kind => current.limits.filter(limit => limit.kind === kind && limit.percentUsed >= showAt))
      const isStale = now - current.readAt > STALE_MS
      const isOverridden = autoPause && pausing === null && now < pauseOffUntil
      // Below show_at, with nothing paused or overridden, the usage line steps aside.
      if (shown.length > 0 || pausing !== null || isOverridden) {
        usage = (
          <Box flexDirection="row" columnGap={3}>
            {pausing === null ? null : (
              <Text color={ORANGE} bold wrap="truncate-end">
                ⏸ PAUSED at {pausing.percentUsed}% · continues {time.at(pausing.resumeAt, now)}
              </Text>
            )}
            {shown.map(limit => {
              const look = lookOf(limit.percentUsed, warnAt)
              const at = resetsAtMs(limit)
              const resets =
                at === undefined
                  ? ''
                  : isNarrow
                    ? ` · ${formatIn(at - now)}`
                    : ` · resets ${time.at(at, now)} (${formatIn(at - now)})`
              return (
                <Box key={limit.kind} flexDirection="row" columnGap={1}>
                  <Text color={look.color} bold>
                    {look.icon} {look.word}
                  </Text>
                  <Text wrap="truncate-end">
                    {labelOf(limit.kind)} {limit.percentUsed}%{resets}
                  </Text>
                </Box>
              )
            })}
            {isOverridden ? <Text wrap="truncate-end">○ pause off until {time.at(pauseOffUntil, now)}</Text> : null}
            {isStale && shown.length > 0 ? <Text wrap="truncate-end">as of {time.at(current.readAt, now)}</Text> : null}
          </Box>
        )
      }
    }

    if (choice === null && usage === null) return theirs
    return (
      <Box flexDirection="column">
        {choice}
        {usage}
        {theirs}
      </Box>
    )
  })
ライセンスの全文(MIT)
MIT License

Copyright (c) 2026 Brian Potter

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 に読んだコミット da9a39dc5896 のソースから。最初のまとまりが載せる条件で、残りは自分で判断するための材料です。後のコミットは、次に読むまで見ていません。

載せる条件: 確かめやすいコード
入口を読んだhooks/hooks.json が名指すモジュールをすべて読んだ。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 のホスト)がコードに書いてあるか。通信なし
プログラム起動するプログラムの名前がコードに書いてあり、シェル・インタプリタ・通信用の道具でないか。プログラムを起動しない
読んで送るファイルや環境変数を読み、かつ通信するか。通信しない
ソースの鍵ソースに API キーや秘密鍵らしきものがあるか。ソースに鍵なし
ライセンスオープンなライセンス(MIT・Apache-2.0・BSD・ISC・Unlicense・0BSD・CC0)で全文があれば、modscode にコードを載せる。違えばリンクだけ。MIT

コードの文面を読んだだけで、安全の審査ではありません。動かしてはおらず、起動するプログラムの中で何が起きるかも見えません。入れる前の確認はあなたの役目です。 載せる条件

入れる

入れる前に、必ず自分で確かめてください。Mod はサンドボックスなしで、あなたの権限で動きます。modscode はこのコードの安全を保証しません。下のコードを読み(またはフォルダーで claude plugin validate .)、触るものを見て、読んだコミットを入れてください。

リポジトリがそのままマーケットプレイスです。このマーケットプレイスを足し(ターミナルでは次のコマンド、デスクトップアプリではプラグインの設定)、そこから Mod を入れます。

/plugin marketplace add potterdigital/plan-usage-mod
/plugin install plan-usage@potterdigital

入るのはマーケットプレイスの最新のコミットで、ここで読んだもの(da9a39dc5896)と違うことがあります。入れる前に見比べてください。

Claude に聞く

modscode のコネクタを入れると、Claude がこのデザイン・コードが触るもの・コードを読んで、それをもとに作れます。たとえば:

modscode のデザイン「potterdigital-plan-usage」をコードごと読んで、同じようなペインを作って

Claude から探す: MCP コネクタ

似たデザイン