pi-spark

Pi package that polishes your daily experience.

Install

Install from npm:

pi install npm:pi-spark

Install from git:

pi install git:github.com/zlliang/pi-spark

Features

Compact TUI: editor, footer, and fullscreen

pi-spark ships with custom editor, footer, and fullscreen rendering, replacing the default ones. The compact TUI gives you a calm, immersive experience without distraction.

• The editor shows a working indicator inspired by Amp and the current model on the top border. If you use presets, the active preset appears there too.
• The footer shows session information, extension statuses, cost, and context usage on one line.
• The fullscreen rendering clears the terminal screen and scrollback on session start and exit, and pins the editor and footer to the bottom.

Credits

pi-spark shows the active provider's credit balance or rate-limit usage in the status line, so you can keep an eye on what's left without leaving the terminal.

• Supported providers: DeepSeek, Fireworks, Kimi Code, Moonshot, OpenAI Codex, OpenRouter, and Vercel AI Gateway.
• Most provider fetching follows CodexBar. Fireworks is the exception: its balance sits behind an internal gRPC API, reverse-engineered from the firectl binary (see Reverse-Engineering Fireworks Credits).

OpenAI Codex banked resets

Banked rate-limit resets are saved benefits that can reset eligible Codex usage windows when redeemed. When available, their count appears after the usage windows. Run /codex-reset to inspect each reset and its expiration date, then select one to redeem. See OpenAI Codex Banked Rate-Limit Resets for the underlying behavior and internal APIs.

Presets

pi-spark lets you define named model presets in spark.json (see Configuration), so you can switch between models and thinking levels without retyping provider details. The active preset is shown on the editor's top border.

• Switch interactively with /preset, or jump straight to one with /preset <name>.
• Start pi on a given preset with pi --preset <name>.
• Cycle presets with ctrl+super+p (forward) and ctrl+shift+super+p (backward); super is command on macOS and needs a terminal that forwards it.

Recap

pi-spark generates a short recap of the current session after it goes idle, or on demand, inspired by Claude Code's session recap.

• A recap is generated automatically once the session stays idle past recap.idle in spark.json.
• Run /recap to generate one manually at any time.
• The recap generation can use its own model, configured separately from your working model.

Title

pi-spark names the session automatically after the first completed turn, so it's easy to find later in the session selector.

• Once the agent completes its first response and any tool calls from that turn, pi-spark generates a short title from the conversation and sets it as the session name.
• Generation is silent: nothing is shown in the UI, and the usage is recorded in a session entry like the recap.
• Sessions that already have a name are left untouched.
• The title generation can use its own model, configured separately from your working model.

Scrolling write previews

Long, streaming write tool calls keep their latest lines visible instead of pinning the preview to the beginning. The omitted-line count appears above the preview, while ctrl+o still expands the full content.

screencast-write.mp4

Configuration

pi-spark reads config from ~/.pi/agent/spark.json and from the current project's .pi/spark.json. Project config overrides matching global fields.

For example:

{
  "editor": {
    "spinner": "dots"
  },
  "footer": false,
  "presets": {
    "claude-opus": {
      "provider": "anthropic",
      "model": "claude-opus-4-8",
      "thinkingLevel": "high"
    },
    "gpt": {
      "provider": "openai-codex",
      "model": "gpt-5.5",
      "thinkingLevel": "medium"
    }
  },
  "recap": {
    "idle": "5m",
    "provider": "openai-codex",
    "model": "gpt-5.4-mini",
    "thinkingLevel": "off"
  },
  "title": {
    "provider": "openai-codex",
    "model": "gpt-5.4-mini",
    "thinkingLevel": "off"
  }
}

References

All fields are optional. Each top-level feature runs with the defaults below unless you turn it off.

Field	Value (or false)	Description
credits	CreditsConfig	Shows the active provider's credit balance or rate-limit usage in the status line.
editor	EditorConfig	Shows a working indicator and the current model on the editor's top border.
footer	FooterConfig	Shows session info, extension statuses, cost, and context usage.
fullscreen	{}	Clears the screen and scrollback on start and exit, and pins the editor and footer to the bottom.
presets	{ [name]: Preset }	Defines named model presets, keyed by name.
recap	RecapConfig	Generates a session recap when idle or on demand.
title	TitleConfig	Names the session automatically after the first completed turn.
write	{}	Keeps the latest lines of streaming write tool calls visible.

CreditsConfig

All supported providers are enabled by default. Set a provider to false to disable its credits status, or to true to override a global false in project config.

{
  "credits": {
    "providers": {
      "fireworks": false,
      "openai-codex": true
    }
  }
}

Field	Value	Description
providers	partial map of provider IDs to booleans	Enables or disables credits for individual providers. Valid IDs: deepseek, fireworks, kimi-coding, moonshotai, moonshotai-cn, openai-codex, openrouter, and vercel-ai-gateway.

EditorConfig

The spinner field is optional and defaults to tildes. thinkingLevelIndicator is also optional and defaults to border.

Field	Value	Description
spinner	dots	⠋, ⠙, ⠹, ⠸, ⠼, ⠴, ⠦, ⠧, ⠇, ⠏
	lights	○, ●
	tildes (default)	∼, ≈, ≋, ≈, ∼
	pulse	·, •, ●, •, ·
thinkingLevelIndicator	border (default)	Uses the thinking-level color for the editor border.
	model	Uses the thinking-level color for the model name and the dim color for the editor border.

FooterConfig

The statusPosition field is optional and defaults to inline.

Field	Value	Description
statusPosition	inline (default)	Shows extension statuses on the same line as session info, cost, and context usage.
	below	Moves extension statuses to a new line below.

Preset

Each preset must set all three fields.

Field	Value	Description
provider	string	Provider ID, e.g., anthropic.
model	string	Model ID, e.g., claude-opus-4-8.
thinkingLevel	ModelThinkingLevel	Thinking level for the preset.

RecapConfig

All fields are optional. If the recap model configuration is incomplete, pi-spark falls back to the session's main model. thinkingLevel defaults to off (clamped to the model), so recap stays cheap regardless of your working thinking level.

Field	Value	Description
idle	number (ms) or duration string	How long the session must stay idle before a recap is generated. Accepts a millisecond number or a parse-duration string (e.g., "5m"); minimum 5000 ms, defaults to 5 minutes.
provider	string	Provider ID for the recap model.
model	string	Model ID for the recap model.
thinkingLevel	ModelThinkingLevel	Thinking level for the recap model. Defaults to off.

TitleConfig

All fields are optional. If the title model configuration is incomplete, pi-spark falls back to the session's main model. thinkingLevel defaults to off (clamped to the model), so title generation stays cheap regardless of your working thinking level.

Field	Value	Description
provider	string	Provider ID for the title model.
model	string	Model ID for the title model.
thinkingLevel	ModelThinkingLevel	Thinking level for the title model. Defaults to off.

ModelThinkingLevel

Valid values: off, minimal, low, medium, high, xhigh, max.

Turn off the features you don't like

All features are enabled by default. Set a specific feature to false in spark.json to disable it.

For example, to disable the customized footer:

{
  "footer": false
}

Themes

pi-spark ships with two custom themes inspired by GitHub's VS Code themes:

• github-light-default
• github-dark-default

Select either theme in /settings, or configure automatic switching between them:

{
  "theme": "github-light-default/github-dark-default"
}