@narumitw/pi-starship 0.35.0 → 0.37.0
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.
- package/README.md +37 -5
- package/package.json +1 -1
- package/src/config.ts +1 -0
- package/src/modules/cache.ts +23 -0
- package/src/modules/catalog.ts +2 -0
- package/src/modules/context.ts +1 -1
- package/src/modules/cost.ts +6 -3
- package/src/modules/types.ts +9 -1
- package/src/pi-starship.ts +9 -11
- package/src/usage.ts +53 -0
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ A native Pi footer configured with Starship-style TOML. It parses and renders fo
|
|
|
10
10
|
|
|
11
11
|
- Uses a readable built-in Tokyo Night configuration until the user explicitly saves settings.
|
|
12
12
|
- Starship-style root/module formats, conditional groups, `$all`, styles, and palettes.
|
|
13
|
-
- Pi modules for model, thinking, activity, context, tokens, cost, turn, and extension statuses.
|
|
13
|
+
- Pi modules for model, thinking, activity, context, tokens, prompt cache, cost, turn, and extension statuses.
|
|
14
14
|
- Cached Git branch, commit, operation state, line metrics, detailed status, and linked-worktree identity.
|
|
15
15
|
- Opt-in package, language, development-shell, deployment, cloud, and execution-context modules.
|
|
16
16
|
- Width-aware `$fill` alignment for native multiline left/right layouts.
|
|
@@ -57,7 +57,7 @@ The **Advanced** menu is one level deep and contains configuration details plus
|
|
|
57
57
|
### 📝 Example
|
|
58
58
|
|
|
59
59
|
```toml
|
|
60
|
-
format = "$brand$provider$model$thinking\n$directory$git_branch$git_status\n$activity$context$tokens$cost$time$turn\n$extension_status"
|
|
60
|
+
format = "$brand$provider$model$thinking\n$directory$git_branch$git_status\n$activity$context$tokens$cache$cost$time$turn\n$extension_status"
|
|
61
61
|
palette = "tokyo-night"
|
|
62
62
|
|
|
63
63
|
[palettes.tokyo-night]
|
|
@@ -75,6 +75,16 @@ disabled = false
|
|
|
75
75
|
format = "([ $text ]($style))"
|
|
76
76
|
style = "fg:custom"
|
|
77
77
|
|
|
78
|
+
[context]
|
|
79
|
+
format = "[$symbol $percentage/$window ]($style)"
|
|
80
|
+
|
|
81
|
+
[cache]
|
|
82
|
+
format = "[$symbol (R$read )(W$write )(CH$rate )]($style)"
|
|
83
|
+
disabled = false
|
|
84
|
+
|
|
85
|
+
[cost]
|
|
86
|
+
format = "[ $symbol \\$$cost( $subscription) ]($style)"
|
|
87
|
+
|
|
78
88
|
[git_branch]
|
|
79
89
|
format = "[ $symbol$branch$pr ]($style)"
|
|
80
90
|
|
|
@@ -155,7 +165,8 @@ An invalid root format falls back to the built-in root format. An invalid module
|
|
|
155
165
|
| `activity` | `$symbol`, `$state`, `$tool`, `$count`, `$text` | Active tools, streaming, completion, or idle |
|
|
156
166
|
| `context` | `$symbol`, `$percentage`, `$tokens`, `$window` | Context-window use |
|
|
157
167
|
| `tokens` | `$symbol`, `$input`, `$output`, `$total` | Token totals |
|
|
158
|
-
| `
|
|
168
|
+
| `cache` | `$symbol`, `$rate`, `$read`, `$write` | Prompt-cache reads, writes, and latest hit rate; disabled by default |
|
|
169
|
+
| `cost` | `$symbol`, `$cost`, `$subscription` | Session cost and optional `(sub)` marker |
|
|
159
170
|
| `time` | `$symbol`, `$time` | Current local time |
|
|
160
171
|
| `turn` | `$symbol`, `$count` | User turn count |
|
|
161
172
|
| `package` | `$symbol`, `$version`, `$source` | Direct project manifest version |
|
|
@@ -184,6 +195,25 @@ An invalid root format falls back to the built-in root format. An invalid module
|
|
|
184
195
|
| `fill` | `$symbol` | Flexible width-aware root-layout marker |
|
|
185
196
|
| `extension_status` | `$symbol`, `$statuses`, `$count` | Pi extension statuses |
|
|
186
197
|
|
|
198
|
+
### Usage semantics
|
|
199
|
+
|
|
200
|
+
- `tokens`, `cache`, and `cost` total every usage-bearing session entry, matching Pi's native footer:
|
|
201
|
+
assistant messages, nested-LLM tool results, compactions, and branch summaries, including abandoned
|
|
202
|
+
branches retained in the session.
|
|
203
|
+
- Cache `$read` and `$write` are cumulative. `$rate` uses only the latest assistant prompt:
|
|
204
|
+
`cacheRead / (input + cacheRead + cacheWrite) * 100`. The module is empty when Pi has reported no
|
|
205
|
+
cache reads or writes.
|
|
206
|
+
- `cache` is disabled by default, but the built-in root format already contains `$cache`; users who
|
|
207
|
+
inherit that format can enable it with only `[cache] disabled = false`. A custom root format must
|
|
208
|
+
reference `$cache` or `$all` normally.
|
|
209
|
+
- Context `$percentage` uses native one-decimal precision. For a native-style display, use
|
|
210
|
+
`format = "[$symbol $percentage/$window ]($style)"` under `[context]`; the module name remains
|
|
211
|
+
`context`, not `context_usage`.
|
|
212
|
+
- Subscription-backed OAuth models and `kimi-coding` set cost `$subscription` to `(sub)`. The dollar
|
|
213
|
+
value is usage cost, not proof of an amount billed under a subscription.
|
|
214
|
+
- Pi's public extension API does not expose the current auto-compaction toggle, so pi-starship cannot
|
|
215
|
+
reliably provide the native `(auto)` marker.
|
|
216
|
+
|
|
187
217
|
`git_worktree` is empty in the primary worktree. In a linked worktree it defaults to the top-level directory name; use `$path` when the full absolute path is needed.
|
|
188
218
|
|
|
189
219
|
`git_commit`, `git_state`, and `git_metrics` are intentionally not present in the built-in root format. Add their variables to `format` to opt in; also set `[git_metrics].disabled = false`, matching Starship's opt-in metrics default. `$tag` resolves only an exact tag on HEAD and is queried only when the configured `git_commit` format references it.
|
|
@@ -322,7 +352,7 @@ shell modules, or expose unrestricted `env_var` behavior. JVM/.NET, other long-t
|
|
|
322
352
|
alternative VCS, system-monitor, and additional DevOps modules remain demand-gated; the first-wave
|
|
323
353
|
review found no issue/discussion evidence for a coherent follow-up batch, so no second wave is added.
|
|
324
354
|
|
|
325
|
-
Pi-native model, context, cost, Git metrics, and activity remain owned by the existing modules. The
|
|
355
|
+
Pi-native model, context, cache, cost, Git metrics, and activity remain owned by the existing modules. The
|
|
326
356
|
lifecycle design rejects provider-specific duplicates and ambiguous `turn_duration`/`last_result`
|
|
327
357
|
modules until separately approved semantics exist.
|
|
328
358
|
|
|
@@ -336,6 +366,7 @@ Keep `extension_status` last in the catalog so earlier modules can consume exten
|
|
|
336
366
|
|
|
337
367
|
- `src/index.ts` — Pi package entrypoint.
|
|
338
368
|
- `src/pi-starship.ts` — extension lifecycle, cached refresh binding, live preview, and footer.
|
|
369
|
+
- `src/usage.ts` — native-aligned session usage and cache aggregation.
|
|
339
370
|
- `src/commands.ts` — goal-oriented menu, preview/confirmation, diagnostics, and compatibility routes.
|
|
340
371
|
- `src/config.ts` — TOML loading, draft validation, defaults, atomic persistence, and rollback.
|
|
341
372
|
- `src/format/` — native format/style parser and renderer.
|
|
@@ -345,7 +376,8 @@ Keep `extension_status` last in the catalog so earlier modules can consume exten
|
|
|
345
376
|
|
|
346
377
|
## 🔎 Keywords
|
|
347
378
|
|
|
348
|
-
Pi Coding Agent, Starship statusline, Starship TOML, terminal footer, native statusline,
|
|
379
|
+
Pi Coding Agent, Starship statusline, Starship TOML, terminal footer, native statusline, prompt cache,
|
|
380
|
+
cache hit rate, Pi extension
|
|
349
381
|
|
|
350
382
|
## 📄 License
|
|
351
383
|
|
package/package.json
CHANGED
package/src/config.ts
CHANGED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { formatCount } from "./helpers.js";
|
|
2
|
+
import { defineModule } from "./types.js";
|
|
3
|
+
|
|
4
|
+
export const cacheModule = defineModule({
|
|
5
|
+
name: "cache",
|
|
6
|
+
variables: ["symbol", "rate", "read", "write"],
|
|
7
|
+
defaults: {
|
|
8
|
+
format: "[$symbol (CH$rate )]($style)",
|
|
9
|
+
symbol: "📦",
|
|
10
|
+
style: "fg:runtime_fg bg:runtime",
|
|
11
|
+
disabled: true,
|
|
12
|
+
},
|
|
13
|
+
values: ({ runtime }) => {
|
|
14
|
+
const { cacheRead, cacheWrite, latestCacheHitRate } = runtime.tokenTotals;
|
|
15
|
+
if (cacheRead === 0 && cacheWrite === 0) return undefined;
|
|
16
|
+
const rate = latestCacheHitRate === undefined ? "" : `${latestCacheHitRate.toFixed(1)}%`;
|
|
17
|
+
return {
|
|
18
|
+
rate,
|
|
19
|
+
read: cacheRead > 0 ? formatCount(cacheRead) : "",
|
|
20
|
+
write: cacheWrite > 0 ? formatCount(cacheWrite) : "",
|
|
21
|
+
};
|
|
22
|
+
},
|
|
23
|
+
});
|
package/src/modules/catalog.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { activityModule } from "./activity.js";
|
|
2
2
|
import { brandModule } from "./brand.js";
|
|
3
|
+
import { cacheModule } from "./cache.js";
|
|
3
4
|
import { cloudModules } from "./cloud.js";
|
|
4
5
|
import { contextModule } from "./context.js";
|
|
5
6
|
import { costModule } from "./cost.js";
|
|
@@ -46,6 +47,7 @@ export const MODULE_DEFINITIONS = [
|
|
|
46
47
|
activityModule,
|
|
47
48
|
contextModule,
|
|
48
49
|
tokensModule,
|
|
50
|
+
cacheModule,
|
|
49
51
|
costModule,
|
|
50
52
|
timeModule,
|
|
51
53
|
turnModule,
|
package/src/modules/context.ts
CHANGED
|
@@ -13,7 +13,7 @@ export const contextModule = defineModule({
|
|
|
13
13
|
values: ({ runtime }) => {
|
|
14
14
|
const percent = runtime.contextUsage?.percent;
|
|
15
15
|
return {
|
|
16
|
-
percentage: percent === null || percent === undefined ? "?" : `${percent.toFixed(
|
|
16
|
+
percentage: percent === null || percent === undefined ? "?" : `${percent.toFixed(1)}%`,
|
|
17
17
|
tokens: formatCount(runtime.contextUsage?.tokens ?? 0),
|
|
18
18
|
window: formatCount(runtime.contextUsage?.contextWindow ?? 0),
|
|
19
19
|
};
|
package/src/modules/cost.ts
CHANGED
|
@@ -2,14 +2,17 @@ import { defineModule } from "./types.js";
|
|
|
2
2
|
|
|
3
3
|
export const costModule = defineModule({
|
|
4
4
|
name: "cost",
|
|
5
|
-
variables: ["symbol", "cost"],
|
|
5
|
+
variables: ["symbol", "cost", "subscription"],
|
|
6
6
|
defaults: {
|
|
7
|
-
format: "[ $symbol \\$$cost ]($style)",
|
|
7
|
+
format: "[ $symbol \\$$cost( $subscription) ]($style)",
|
|
8
8
|
symbol: "💸",
|
|
9
9
|
style: "fg:meter_fg bg:meter",
|
|
10
10
|
disabled: false,
|
|
11
11
|
},
|
|
12
|
-
values: ({ runtime }) => ({
|
|
12
|
+
values: ({ runtime }) => ({
|
|
13
|
+
cost: formatCost(runtime.tokenTotals.cost),
|
|
14
|
+
subscription: runtime.usingSubscription ? "(sub)" : "",
|
|
15
|
+
}),
|
|
13
16
|
});
|
|
14
17
|
|
|
15
18
|
function formatCost(value: number): string {
|
package/src/modules/types.ts
CHANGED
|
@@ -78,7 +78,15 @@ export interface StarshipRuntimeSnapshot {
|
|
|
78
78
|
tokens?: number | null;
|
|
79
79
|
contextWindow?: number | null;
|
|
80
80
|
};
|
|
81
|
-
tokenTotals: {
|
|
81
|
+
tokenTotals: {
|
|
82
|
+
input: number;
|
|
83
|
+
output: number;
|
|
84
|
+
cacheRead: number;
|
|
85
|
+
cacheWrite: number;
|
|
86
|
+
cost: number;
|
|
87
|
+
latestCacheHitRate?: number;
|
|
88
|
+
};
|
|
89
|
+
usingSubscription: boolean;
|
|
82
90
|
gitBranch: string | null;
|
|
83
91
|
gitBranchDetails?: GitBranchSnapshot;
|
|
84
92
|
gitCommit?: GitCommitSnapshot;
|
package/src/pi-starship.ts
CHANGED
|
@@ -30,6 +30,7 @@ import {
|
|
|
30
30
|
type WorkspaceRefreshInput,
|
|
31
31
|
workspaceSnapshotEqual,
|
|
32
32
|
} from "./runtime/workspace.js";
|
|
33
|
+
import { summarizeFooterUsage } from "./usage.js";
|
|
33
34
|
|
|
34
35
|
const REFRESH_INTERVAL_MS = 30_000;
|
|
35
36
|
const EVENT_DEBOUNCE_MS = 250;
|
|
@@ -394,7 +395,8 @@ function runtimeSnapshot(
|
|
|
394
395
|
isStreaming: runtime.isStreaming,
|
|
395
396
|
lastCompletedTool: runtime.lastCompletedTool,
|
|
396
397
|
contextUsage: ctx.getContextUsage() ?? undefined,
|
|
397
|
-
tokenTotals:
|
|
398
|
+
tokenTotals: summarizeFooterUsage(ctx.sessionManager.getEntries()),
|
|
399
|
+
usingSubscription: isSubscriptionBacked(ctx),
|
|
398
400
|
gitBranch: runtime.git?.branch?.name ?? footerData.getGitBranch(),
|
|
399
401
|
gitBranchDetails: runtime.git?.branch,
|
|
400
402
|
gitCommit: runtime.git?.commit,
|
|
@@ -415,16 +417,12 @@ function userTurnCount(ctx: ExtensionContext): number {
|
|
|
415
417
|
.filter((entry) => entry.type === "message" && entry.message.role === "user").length;
|
|
416
418
|
}
|
|
417
419
|
|
|
418
|
-
function
|
|
419
|
-
const
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
totals.output += usage.output ?? 0;
|
|
425
|
-
totals.cost += usage.cost?.total ?? 0;
|
|
426
|
-
}
|
|
427
|
-
return totals;
|
|
420
|
+
function isSubscriptionBacked(ctx: ExtensionContext): boolean {
|
|
421
|
+
const model = ctx.model;
|
|
422
|
+
return (
|
|
423
|
+
model !== undefined &&
|
|
424
|
+
(model.provider === "kimi-coding" || ctx.modelRegistry.isUsingOAuth(model))
|
|
425
|
+
);
|
|
428
426
|
}
|
|
429
427
|
|
|
430
428
|
function formatDiagnostics(loaded: LoadedStarshipConfig): string {
|
package/src/usage.ts
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import type { SessionEntry } from "@earendil-works/pi-coding-agent";
|
|
2
|
+
|
|
3
|
+
interface UsageLike {
|
|
4
|
+
input?: number;
|
|
5
|
+
output?: number;
|
|
6
|
+
cacheRead?: number;
|
|
7
|
+
cacheWrite?: number;
|
|
8
|
+
cost?: { total?: number };
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
export interface FooterUsageSummary {
|
|
12
|
+
input: number;
|
|
13
|
+
output: number;
|
|
14
|
+
cacheRead: number;
|
|
15
|
+
cacheWrite: number;
|
|
16
|
+
cost: number;
|
|
17
|
+
latestCacheHitRate?: number;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
export function summarizeFooterUsage(entries: readonly SessionEntry[]): FooterUsageSummary {
|
|
21
|
+
const totals: FooterUsageSummary = {
|
|
22
|
+
input: 0,
|
|
23
|
+
output: 0,
|
|
24
|
+
cacheRead: 0,
|
|
25
|
+
cacheWrite: 0,
|
|
26
|
+
cost: 0,
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
for (const entry of entries) {
|
|
30
|
+
let usage: UsageLike | undefined;
|
|
31
|
+
if (entry.type === "message" && entry.message.role === "assistant") {
|
|
32
|
+
usage = entry.message.usage;
|
|
33
|
+
const input = usage.input ?? 0;
|
|
34
|
+
const cacheRead = usage.cacheRead ?? 0;
|
|
35
|
+
const cacheWrite = usage.cacheWrite ?? 0;
|
|
36
|
+
const promptTokens = input + cacheRead + cacheWrite;
|
|
37
|
+
totals.latestCacheHitRate = promptTokens > 0 ? (cacheRead / promptTokens) * 100 : undefined;
|
|
38
|
+
} else if (entry.type === "message" && entry.message.role === "toolResult") {
|
|
39
|
+
usage = entry.message.usage;
|
|
40
|
+
} else if (entry.type === "compaction" || entry.type === "branch_summary") {
|
|
41
|
+
usage = entry.usage;
|
|
42
|
+
}
|
|
43
|
+
if (!usage) continue;
|
|
44
|
+
|
|
45
|
+
totals.input += usage.input ?? 0;
|
|
46
|
+
totals.output += usage.output ?? 0;
|
|
47
|
+
totals.cacheRead += usage.cacheRead ?? 0;
|
|
48
|
+
totals.cacheWrite += usage.cacheWrite ?? 0;
|
|
49
|
+
totals.cost += usage.cost?.total ?? 0;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
return totals;
|
|
53
|
+
}
|