@cxmyu/ccglance 1.0.1 → 1.0.3

package/README.md

@@ -1,67 +1,23 @@
+<div align="center">
+
 # ccglance
 
-> A fast, zero-dependency, multi-line status line for [Claude Code](https://docs.anthropic.com/en/docs/claude-code) — model, effort, context, cache, git and session, all at a glance.
+**A fast, zero-dependency, multi-line status line for [Claude Code](https://docs.anthropic.com/en/docs/claude-code)**
+
+model · effort · context · cache · git · session — all at a glance
 
 [![Node.js >= 22](https://img.shields.io/badge/node-%3E%3D22-3c873a)](https://nodejs.org/)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
 
-English | [简体中文](./README.zh-CN.md)
+[English](./README.md) · [简体中文](./README.zh-CN.md) · [GitHub](https://github.com/CxMYu/CcGlanceLine)
 
-Repository: [github.com/CxMYu/CcGlanceLine](https://github.com/CxMYu/CcGlanceLine)
+![ccglance preview](./docs/assets/preview.png)
 
-`ccglance` uses the JSON that Claude Code pipes to its status-line command
-on stdin as its primary data source; the session `status` segment reads only
-the transcript tail when enabled. It's written in
-**TypeScript** and ships as compiled JavaScript with **zero runtime
-dependencies** (Node standard library only).
+</div>
 
-## Preview
+> **stdin-first · zero runtime dependencies · fixed emoji style** — renders the JSON Claude Code pipes to its status-line command; only the `status` segment reads a bounded transcript tail. Written in TypeScript, shipped as compiled JavaScript; runs on Node.js ≥ 22 or Bun.
 
-![ccglance preview](./docs/assets/preview.png)
-
-Generated from `ccglance preview`.
-
-## Features
-
-- **Compact multi-line layout** — runtime, quota and project/session state are
-  separate logical rows; empty rows disappear.
-- **Zero runtime dependencies** — Node standard library only; TypeScript is a
-  build-time tool, never shipped in the published package.
-- **stdin-first** — core segments consume the JSON Claude Code provides; status
-  reads a bounded transcript tail only when used.
-- **Rich context block** — usage %, this-turn input/output tokens, tokens left.
-- **Prompt-cache block** — cache hit rate, read/write tokens.
-- **Git segment** — branch, clean/dirty/conflict glyph, ahead/behind counts,
-  using one bounded `git status` call plus a short local cache.
-- **Session segment** — elapsed time plus lines added/removed.
-- **Claude Code version + update hint** — shows the `version` field from
-  Claude Code stdin and appends `↑latest` when the 4h local cache reports a
-  newer Claude Code release. Refresh runs after stdout and never blocks.
-- **Additional session context** — 5h/7d rate-limit quota, USD cost and
-  worktree name next to the git branch when Claude Code provides it.
-- **Responsive multi-line layout** — probes the terminal width
-  (`CCGLANCE_WIDTH` → `COLUMNS` → TTY → `tput`/`stty`) and wraps each row into
-  as many lines as fit, down to a minimum of **one segment per line** so
-  nothing gets hidden; display-width aware (CJK/emoji safe).
-- **Fixed built-in style** — no user config file and no external style file;
-  the status line uses ccglance's own emoji-first style.
-
-## Requirements
-
-- Node.js **>= 22**
-- `git` on `PATH` (optional — only for the git segment)
-
-Claude Code compatibility:
-
-| Claude Code CLI | ccglance behavior |
-|---|---|
-| >= 1.0.71 | Basic status-line stdin support |
-| >= 2.1.80 | Subscription quota row when official `rate_limits.five_hour` / `rate_limits.seven_day` fields are present |
-| >= 2.1.153 | Preferred terminal-width sizing through `COLUMNS` / `LINES`; older versions fall back to TTY width or 80 columns |
-
-The quota row is subscription-only. Claude.ai Pro/Max-style sessions can expose
-`rate_limits`; API-key, Bedrock, Vertex, and other usage-based sessions usually
-do not, so ccglance hides the quota row instead of inferring one.
+**Docs:** [Overview](./docs/overview.md) · [Segments & icons](./docs/segments.md) · [Development](./docs/development.md)
 
 ## Install
 
@@ -71,6 +27,7 @@ do not, so ccglance hides the quota row instead of inferring one.
 npm install -g @cxmyu/ccglance          # npm
 yarn global add @cxmyu/ccglance         # or yarn
 pnpm add -g @cxmyu/ccglance             # or pnpm
+bun add -g @cxmyu/ccglance              # or bun
 ```
 
 Behind a slow registry? Use a mirror:
@@ -145,75 +102,6 @@ On Windows use a full path, e.g. `node D:\\path\\to\\ccglance\\dist\\cli.js`.
 > command needs no path at all. `"padding": 0` drops Claude Code's default leading
 > indent so the row starts at the left edge.
 
-## Status line at a glance
-
-Three logical rows; any row with no data disappears:
-
-1. **Runtime** — 🤖 model · 🧠 effort · status · 🚀 fast · ⚡️ context · 💾 cache · 🎯 style
-2. **Quota** *(subscription sessions only)* — 📊 Hour / Week rate-limit meters
-3. **Project / session** — 📁 dir · 🌿 git · 🏷️ session name · ⏱️ session · 💰 cost · 💩 version
-
-**Full reference** — every segment's stdin source, all icon meanings, rate-limit
-moon-phase levels, session-status icons and color semantics — lives in
-**[docs/segments.md](./docs/segments.md)**.
-
-## How it works
-
-On every redraw Claude Code runs your status-line `command` and pipes a JSON
-object to its **stdin** (model, effort, context window, cost, workspace,
-version, …). `ccglance` reads that once via `fs.readFileSync(0)`, formats its
-fixed rows, and **prints them first**. The `status` segment reads only a
-bounded transcript tail. The version segment synchronously
-reads only a tiny local cache; after stdout is written, ccglance refreshes the
-Claude Code latest-version cache in a detached background process when it is
-older than 4 hours. If the JSON can't be parsed it exits silently so it can never
-break the CLI. Text from stdin, transcript, and git is sanitized before being
-printed so terminal control sequences cannot escape the status line. The main
-external calls are local `git` (single bounded status call with a short cache),
-bounded transcript-tail reads, and the post-render detached npm registry check.
-
-## Development
-
-Source build, tests, benchmark, source layout, contribution practices and git
-cache internals live in **[docs/development.md](./docs/development.md)**. Quick start:
-
-```bash
-git clone https://github.com/CxMYu/CcGlanceLine.git
-cd CcGlanceLine
-npm install        # devDeps + prepare build
-npm test           # build + node:test
-```
-
-## Cache Files
-
-ccglance stores only disposable runtime caches: git status, transcript-derived
-status, and the Claude Code latest-version check. Files are grouped under
-`git/`, `transcript/`, and `version/`.
-
-Caches live under Claude Code's own config directory on every platform, so they
-travel with your Claude setup and are trivial to clear:
-
-```text
-~/.claude/ccglance/
-├── git/          # git status snapshots (one per repo)
-├── transcript/   # transcript-derived session status
-└── version/      # Claude Code latest-version check
-```
-
-If you set `CLAUDE_CONFIG_DIR` to relocate Claude Code's config, ccglance places
-its caches under that directory instead. Deleting the whole `ccglance/` folder is
-safe — every file is regenerated on the next render.
-
-Git cache behavior (cache key, `HEAD` fallback, 20-minute TTL, detached refresh,
-atomic writes) is documented in
-[docs/development.md](./docs/development.md#git-cache-internals).
-
-## Related Projects
-
-- [CCometixLine](https://github.com/Haleclipse/CCometixLine) — high-performance Rust status line with an interactive TUI config and themes
-- [ccstatusline](https://github.com/sirmalloc/ccstatusline) — configurable status line with powerline styling
-- [claude-powerline](https://github.com/Owloops/claude-powerline) — lightweight powerline-style status line
-
 ## Contributing
 
 Issues and pull requests are welcome. For code changes, run `npm run typecheck`,

package/README.zh-CN.md

@@ -1,56 +1,23 @@
+<div align="center">
+
 # ccglance
 
-> 面向 [Claude Code](https://docs.anthropic.com/en/docs/claude-code) 的轻量多行状态栏 —— 模型、effort、上下文、缓存、git、会话,一眼尽览。TypeScript 编写、运行时零依赖。
+**面向 [Claude Code](https://docs.anthropic.com/en/docs/claude-code) 的快速、零依赖多行状态栏**
+
+模型 · effort · 上下文 · 缓存 · git · 会话 —— 一眼尽览
 
 [![Node.js >= 22](https://img.shields.io/badge/node-%3E%3D22-3c873a)](https://nodejs.org/)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
 
-[English](./README.md) | 简体中文
-
-仓库：[github.com/CxMYu/CcGlanceLine](https://github.com/CxMYu/CcGlanceLine)
-
-`ccglance` 以 Claude Code 通过 stdin 传入的 JSON 为主数据源；`status`
-段只在启用时读取 transcript(会话记录)尾部。它用 **TypeScript** 编写,以编译后的
-JavaScript 发布,**运行时零依赖**(仅用 Node 标准库)。
-
-## 预览
+[English](./README.md) · [简体中文](./README.zh-CN.md) · [GitHub](https://github.com/CxMYu/CcGlanceLine)
 
 ![ccglance 预览](./docs/assets/preview.png)
 
-截图由 `ccglance preview` 生成。
-
-## 特性
-
-- **紧凑多行布局** —— 运行时、订阅配额、项目/会话分成逻辑行；无数据的行自动消失。
-- **运行时零依赖** —— 仅用 Node 标准库;TypeScript 仅为构建期工具,不进发布包。
-- **stdin 优先** —— 核心段消费 Claude Code 提供的 JSON；status 只读 transcript 尾部固定字节。
-- **上下文块** —— 占用百分比、本轮输入/输出 token、剩余 token。
-- **缓存块** —— 缓存命中率、读取/写入 token。
-- **git 段** —— 分支、干净/脏/冲突标记、领先/落后计数；只跑一次有界 `git status`，并带短缓存。
-- **会话段** —— 耗时 + 新增/删除行数。
-- **Claude Code 版本 + 更新提示** —— 显示 stdin 里的 Claude Code `version`；
-  本地 4 小时缓存发现新版时追加 `↑latest`。刷新在 stdout 写出后异步进行，不阻塞状态栏。
-- **额外会话信息** —— 5小时/7天配额、美元成本，以及 Claude Code 提供时显示在 git 分支右侧的 worktree 名。
-- **响应式多行布局** —— 读终端宽度(`COLUMNS`),把每行按能容纳的宽度自动折成多行;
-  正确处理 CJK/emoji 显示宽度。
-- **固定内置风格** —— 不读取用户配置文件，也不读取外部样式文件；状态栏使用 ccglance 自己的 emoji 优先风格。
-
-## 环境要求
+</div>
 
-- Node.js **>= 22**
-- `git`(可选,仅 git 段需要)
+> **stdin 优先 · 运行时零依赖 · 固定 emoji 风格** —— 渲染 Claude Code 经 stdin 传入的 JSON;仅 `status` 段读取 transcript 尾部固定字节。TypeScript 编写,以编译后的 JavaScript 发布,可在 Node.js ≥ 22 或 Bun 上运行。
 
-Claude Code 兼容性：
-
-| Claude Code CLI | ccglance 行为 |
-|---|---|
-| >= 1.0.71 | 支持基础 statusline stdin |
-| >= 2.1.80 | 官方 `rate_limits.five_hour` / `rate_limits.seven_day` 字段存在时显示订阅配额行 |
-| >= 2.1.153 | 优先使用 `COLUMNS` / `LINES` 做终端宽度适配；更旧版本回退到 TTY 宽度或 80 列 |
-
-配额行只面向订阅场景。Claude.ai Pro/Max 这类订阅会话可能提供 `rate_limits`；
-API key、Bedrock、Vertex 等按量/外部网关场景通常没有该字段，ccglance 会隐藏配额行，
-不会自行推断或伪造。
+**文档:** [概览](./docs/overview.zh-CN.md) · [字段与图标](./docs/segments.zh-CN.md) · [开发](./docs/development.zh-CN.md)
 
 ## 安装
 
@@ -60,6 +27,7 @@ API key、Bedrock、Vertex 等按量/外部网关场景通常没有该字段，c
 npm install -g @cxmyu/ccglance          # npm
 yarn global add @cxmyu/ccglance         # 或 yarn
 pnpm add -g @cxmyu/ccglance             # 或 pnpm
+bun add -g @cxmyu/ccglance              # 或 bun
 ```
 
 registry 慢?用国内镜像:
@@ -129,66 +97,6 @@ Windows 用完整路径,例如 `node D:\\path\\to\\ccglance\\dist\\cli.js`。
 > 全局的 `ccglance` 命令则完全不需要写路径。`"padding": 0` 去掉 Claude Code 默认的左侧缩进,
 > 让状态栏从最左开始。
 
-## 状态栏速览
-
-三个逻辑行,任意一行无数据时自动消失:
-
-1. **运行时** —— 🤖 模型 · 🧠 effort · 状态 · 🚀 fast · ⚡️ 上下文 · 💾 缓存 · 🎯 风格
-2. **配额**(仅订阅会话)—— 📊 Hour / Week 配额仪表
-3. **项目 / 会话** —— 📁 目录 · 🌿 git · 🏷️ 会话名 · ⏱️ 会话 · 💰 成本 · 💩 版本
-
-**完整参考** —— 每个段的 stdin 来源、所有图标含义、配额月相档位、会话状态图标与颜色语义 ——
-见 **[docs/segments.zh-CN.md](./docs/segments.zh-CN.md)**。
-
-## 原理
-
-每次刷新时,Claude Code 会运行你配置的 `command`,并把一段 JSON(模型、effort、
-上下文窗口、cost、workspace、版本……)从 **stdin** 传入。`ccglance` 用
-`fs.readFileSync(0)` 一次性读入、按固定行格式化并**先打印**；`status`
-只会读取 transcript 尾部固定字节。版本段同步阶段只读本地小缓存；stdout 写出之后，如果
-Claude Code 最新版缓存超过 4 小时，才 detached 后台刷新 npm registry。若 JSON 解析失败则
-静默退出,绝不影响 CLI。来自 stdin、transcript、git 的文本在输出前会清理终端控制序列，
-避免逃逸到状态栏之外。主要外部调用是本地 `git`(单次有界 status 调用并带短缓存)、按需
-transcript 尾部读取，以及渲染后的后台版本检查。
-
-## 开发
-
-源码构建、测试、基准、代码结构、贡献范式与 git 缓存内部细节见
-**[docs/development.zh-CN.md](./docs/development.zh-CN.md)**。快速开始:
-
-```bash
-git clone https://github.com/CxMYu/CcGlanceLine.git
-cd CcGlanceLine
-npm install        # devDeps + prepare 构建
-npm test           # 构建 + node:test
-```
-
-## 缓存文件
-
-`ccglance` 只落盘可丢弃的运行缓存：git 状态、transcript 派生状态、Claude Code 最新版本缓存。
-文件按 `git/`、`transcript/`、`version/` 分组。
-
-所有平台都统一落在 Claude Code 自己的配置目录下,随 Claude 配置一起走、清理也方便:
-
-```text
-~/.claude/ccglance/
-├── git/          # git 状态快照(每个仓库一个)
-├── transcript/   # transcript 派生的会话状态
-└── version/      # Claude Code 最新版本检查
-```
-
-若设置了 `CLAUDE_CONFIG_DIR` 改变 Claude Code 配置目录,ccglance 的缓存会跟着落到该目录下。
-整个 `ccglance/` 目录随时可安全删除 —— 下次渲染会自动重建。
-
-git 缓存逻辑(缓存 key、`HEAD` 兜底、20 分钟 TTL、detached 刷新、原子写)见
-[docs/development.zh-CN.md](./docs/development.zh-CN.md#git-缓存内部细节)。
-
-## 相关项目
-
-- [CCometixLine](https://github.com/Haleclipse/CCometixLine) —— Rust 编写的高性能状态栏,带交互式 TUI 配置与主题
-- [ccstatusline](https://github.com/sirmalloc/ccstatusline) —— 可配置、支持 powerline 风格的状态栏
-- [claude-powerline](https://github.com/Owloops/claude-powerline) —— 轻量的 powerline 风格状态栏
-
 ## 贡献
 
 欢迎提 issue 和 PR。改代码前请先跑 `npm run typecheck`、`npm run build`、`ccglance preview`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cxmyu/ccglance",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A fast, zero-dependency, multi-line status line for Claude Code — model, effort, context, cache, git and session, all at a glance.",
   "bin": {
     "ccglance": "dist/cli.js"