pi-everforest 0.1.3 → 0.1.5

package/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.5] - 2026-08-27
+
+### Changed
+
+- Restrict published npm package contents to the themes and required project documentation.
+
+## [0.1.4] - 2026-08-21
+
+### Added
+
+- Project README with installation, configuration, theme reference, and palette preview.
+
 ## [0.1.3] - 2026-08-12
 
 ### Fixed

package/README.md

@@ -0,0 +1,151 @@
+# Pi Everforest
+
+[![npm version](https://img.shields.io/npm/v/pi-everforest?logo=npm)](https://www.npmjs.com/package/pi-everforest)
+[![Pi package](https://img.shields.io/badge/Pi-package-83C092)](https://pi.dev/packages/pi-everforest)
+[![license](https://img.shields.io/npm/l/pi-everforest)](./LICENSE)
+
+Six warm, green-based [Everforest](https://github.com/sainnhe/everforest) color schemes packaged as installable themes for the [Pi coding agent](https://pi.dev).
+
+<p align="center">
+  <img src="assets/preview.svg" alt="Everforest dark medium and light medium palette previews" width="100%">
+</p>
+
+> The preview illustrates the package palettes. Exact colors depend on your terminal and display settings.
+
+## Features
+
+- Dark and light variants with hard, medium, and soft contrast levels
+- Colors for Pi's UI, Markdown, diffs, syntax highlighting, thinking levels, and bash mode
+- Matching colors for Pi HTML exports
+- Native Pi package discovery through `pi.themes`
+- No runtime dependencies
+
+## Install
+
+Install the package from npm:
+
+```bash
+pi install npm:pi-everforest
+```
+
+Or install it directly from GitHub:
+
+```bash
+pi install git:github.com/angribot/pi-everforest
+```
+
+To install the package only for the current project, add `-l`:
+
+```bash
+pi install -l npm:pi-everforest
+```
+
+## Themes
+
+| Theme | Variant | Contrast |
+| --- | --- | --- |
+| `everforest-dark-hard` | Dark | Hard |
+| `everforest-dark-medium` | Dark | Medium |
+| `everforest-dark-soft` | Dark | Soft |
+| `everforest-light-hard` | Light | Hard |
+| `everforest-light-medium` | Light | Medium |
+| `everforest-light-soft` | Light | Soft |
+
+`medium` is Everforest's default contrast level and a good place to start.
+
+## Use
+
+### Select interactively
+
+Open `/settings` in Pi and select one of the six theme names above.
+
+### Configure a theme
+
+Set the `theme` key in `~/.pi/agent/settings.json`:
+
+```json
+{
+  "theme": "everforest-dark-medium"
+}
+```
+
+### Follow terminal appearance
+
+Pair a light theme with a dark theme to follow your terminal's appearance:
+
+```json
+{
+  "theme": "everforest-light-medium/everforest-dark-medium"
+}
+```
+
+The light theme goes before the slash and the dark theme after it. The same pattern works with the hard and soft pairs.
+
+### Use for one session
+
+Start Pi with a theme without changing the saved setting:
+
+```bash
+pi --use-theme everforest-dark-medium
+```
+
+Or use the automatic light/dark pair:
+
+```bash
+pi --use-theme everforest-light-medium/everforest-dark-medium
+```
+
+## Palette design
+
+[Everforest](https://github.com/sainnhe/everforest) describes its palette as green-based, warm-toned, and designed around soft contrast. This package maps its two variants and three contrast levels onto Pi's theme tokens:
+
+- core UI and message surfaces
+- success, warning, and error states
+- Markdown and code syntax
+- tool output and diffs
+- thinking-level and bash-mode borders
+- HTML export surfaces
+
+This is an independent Pi theme package based on the upstream Everforest palette; it is not an official Everforest project.
+
+## Terminal notes
+
+Pi uses 24-bit RGB colors. Most modern terminals support them, while older 256-color terminals receive an approximation.
+
+You can check for true-color support with:
+
+```bash
+echo "$COLORTERM"
+```
+
+The result is commonly `truecolor` or `24bit`. In VS Code, set `terminal.integrated.minimumContrastRatio` to `1` if its automatic contrast adjustment changes the palette.
+
+## Development
+
+Load a theme directly from a checkout:
+
+```bash
+pi \
+  --theme ./themes/everforest-dark-medium.json \
+  --use-theme everforest-dark-medium
+```
+
+Validate all theme files as JSON:
+
+```bash
+for theme in themes/*.json; do
+  python3 -m json.tool "$theme" >/dev/null || exit 1
+done
+```
+
+Theme files include Pi's JSON schema URL for editor completion and validation.
+
+## Credits
+
+- Palette: [sainnhe/everforest](https://github.com/sainnhe/everforest)
+- Pi theme documentation: [Themes](https://github.com/earendil-works/pi/blob/main/packages/coding-agent/docs/themes.md)
+- Pi package documentation: [Packages](https://github.com/earendil-works/pi/blob/main/packages/coding-agent/docs/packages.md)
+
+## License
+
+[MIT](LICENSE). Everforest is also distributed under the MIT License by its upstream authors.

package/assets/preview.svg

@@ -0,0 +1,73 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="1200" height="560" viewBox="0 0 1200 560" role="img" aria-labelledby="title desc">
+  <title id="title">Pi Everforest palette preview</title>
+  <desc id="desc">Side-by-side previews of the Everforest dark medium and light medium themes for pi.</desc>
+  <defs>
+    <filter id="shadow" x="-10%" y="-10%" width="120%" height="130%">
+      <feDropShadow dx="0" dy="12" stdDeviation="16" flood-color="#1E2326" flood-opacity="0.28"/>
+    </filter>
+  </defs>
+
+  <rect width="1200" height="560" rx="28" fill="#E6E2CC"/>
+
+  <g transform="translate(54 54)" filter="url(#shadow)">
+    <rect width="522" height="452" rx="18" fill="#2D353B"/>
+    <path d="M18 0h486a18 18 0 0 1 18 18v42H0V18A18 18 0 0 1 18 0Z" fill="#343F44"/>
+    <circle cx="28" cy="30" r="7" fill="#E67E80"/>
+    <circle cx="52" cy="30" r="7" fill="#DBBC7F"/>
+    <circle cx="76" cy="30" r="7" fill="#A7C080"/>
+    <text x="261" y="36" text-anchor="middle" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="15" font-weight="600" fill="#9DA9A0">everforest-dark-medium</text>
+
+    <text x="30" y="105" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="18" font-weight="700" fill="#E69875">Pi Everforest</text>
+    <text x="30" y="137" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="15" fill="#D3C6AA">Warm, green-based colors for focused coding.</text>
+
+    <rect x="24" y="168" width="474" height="88" rx="10" fill="#343F44"/>
+    <text x="42" y="198" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="13" font-weight="700" fill="#83C092">YOU</text>
+    <text x="42" y="227" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="15" fill="#D3C6AA">Add a calm color scheme to pi.</text>
+
+    <text x="30" y="294" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="13" font-weight="700" fill="#E69875">READ</text>
+    <text x="82" y="294" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="14" fill="#859289">themes/everforest-dark-medium.json</text>
+    <rect x="24" y="314" width="474" height="66" rx="10" fill="#425047"/>
+    <text x="42" y="354" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="15" fill="#A7C080">✓ Theme loaded successfully</text>
+
+    <g transform="translate(30 407)">
+      <rect width="46" height="18" rx="9" fill="#E67E80"/>
+      <rect x="56" width="46" height="18" rx="9" fill="#E69875"/>
+      <rect x="112" width="46" height="18" rx="9" fill="#DBBC7F"/>
+      <rect x="168" width="46" height="18" rx="9" fill="#A7C080"/>
+      <rect x="224" width="46" height="18" rx="9" fill="#83C092"/>
+      <rect x="280" width="46" height="18" rx="9" fill="#7FBBB3"/>
+      <rect x="336" width="46" height="18" rx="9" fill="#D699B6"/>
+    </g>
+  </g>
+
+  <g transform="translate(624 54)" filter="url(#shadow)">
+    <rect width="522" height="452" rx="18" fill="#FDF6E3"/>
+    <path d="M18 0h486a18 18 0 0 1 18 18v42H0V18A18 18 0 0 1 18 0Z" fill="#F4F0D9"/>
+    <circle cx="28" cy="30" r="7" fill="#F85552"/>
+    <circle cx="52" cy="30" r="7" fill="#DFA000"/>
+    <circle cx="76" cy="30" r="7" fill="#8DA101"/>
+    <text x="261" y="36" text-anchor="middle" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="15" font-weight="600" fill="#829181">everforest-light-medium</text>
+
+    <text x="30" y="105" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="18" font-weight="700" fill="#F57D26">Pi Everforest</text>
+    <text x="30" y="137" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="15" fill="#5C6A72">Warm, green-based colors for focused coding.</text>
+
+    <rect x="24" y="168" width="474" height="88" rx="10" fill="#F4F0D9"/>
+    <text x="42" y="198" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="13" font-weight="700" fill="#35A77C">YOU</text>
+    <text x="42" y="227" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="15" fill="#5C6A72">Add a calm color scheme to pi.</text>
+
+    <text x="30" y="294" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="13" font-weight="700" fill="#F57D26">READ</text>
+    <text x="82" y="294" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="14" fill="#939F91">themes/everforest-light-medium.json</text>
+    <rect x="24" y="314" width="474" height="66" rx="10" fill="#F0F1D2"/>
+    <text x="42" y="354" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="15" fill="#8DA101">✓ Theme loaded successfully</text>
+
+    <g transform="translate(30 407)">
+      <rect width="46" height="18" rx="9" fill="#F85552"/>
+      <rect x="56" width="46" height="18" rx="9" fill="#F57D26"/>
+      <rect x="112" width="46" height="18" rx="9" fill="#DFA000"/>
+      <rect x="168" width="46" height="18" rx="9" fill="#8DA101"/>
+      <rect x="224" width="46" height="18" rx="9" fill="#35A77C"/>
+      <rect x="280" width="46" height="18" rx="9" fill="#3A94C5"/>
+      <rect x="336" width="46" height="18" rx="9" fill="#DF69BA"/>
+    </g>
+  </g>
+</svg>

package/package.json

@@ -1,8 +1,15 @@
 {
   "name": "pi-everforest",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Everforest color schemes (dark/light × hard/medium/soft) as themes for the pi coding agent",
   "license": "MIT",
+  "files": [
+    "themes",
+    "assets/preview.svg",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/angribot/pi-everforest.git"

package/.github/workflows/publish.yml

@@ -1,19 +0,0 @@
-name: Publish
-
-on:
-  push:
-    tags:
-      - "v*"
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write # OIDC: npm trusted publishing + provenance attestation
-    steps:
-      - uses: actions/checkout@v7
-      - uses: actions/setup-node@v7
-        with:
-          node-version: 26
-      - run: npm publish --provenance

package/AGENTS.md

@@ -1,20 +0,0 @@
-## Agent skills
-
-### Issue tracker
-
-Issues live in GitHub Issues, managed via the `gh` CLI. See `docs/agents/issue-tracker.md`.
-
-### Triage labels
-
-Default vocabulary: `needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`. See `docs/agents/triage-labels.md`.
-
-### Domain docs
-
-Single-context: `CONTEXT.md` + `docs/adr/` at the repo root. See `docs/agents/domain.md`.
-
-## Conventions
-
-- **Commits**: conventional commit messages (`feat:`, `fix:`, `docs:`, …).
-- **Version bump**: on "bump to x.y.z" — update the `version` in `package.json`, move the `[Unreleased]` entries into a new dated `## [x.y.z] - YYYY-MM-DD` section (leaving `[Unreleased]` empty), commit as `chore(release): x.y.z`, then show the proposed tag (`vx.y.z` + the commit it points at) and wait for confirmation before tagging.
-- **Changelog**: decide per change whether it is notable — user-visible changes (new schemes, palette/color adjustments, packaging) get an entry; internal-only changes (docs typos, refactors) don't.
-- **Release automation**: none yet — no workflow, no `npm publish`; conventional commits keep the release-please option open.

package/CONTEXT.md

@@ -1,29 +0,0 @@
-# Pi Everforest
-
-A theme extension for the pi coding agent, packaging the six sainnhe/everforest color schemes as installable pi themes.
-
-## Language
-
-### 上游配色
-
-**scheme**:
-六套配色组合之一，由 variant × contrast 决定（如 `everforest-dark-medium`）。
-_Avoid_: 主题、配色方案（指上游组合时）
-
-**variant**:
-明暗色系，`dark` 或 `light`。
-
-**contrast**:
-背景对比度，`hard`、`medium` 或 `soft`（medium 为上游默认）。
-
-**palette**:
-上游 sainnhe/everforest 的官方色值集合，分 `palette1`（背景）与 `palette2`（前景）两个子表。
-
-### pi 侧概念
-
-**theme**:
-pi 主题扩展中的一个 JSON 文件（`vars` + `colors` + 可选 `export`），与某个 scheme 一一对应。
-_Avoid_: scheme（指 pi 文件时）
-
-**token**:
-pi 主题 `colors` 中的具名颜色槽位（如 `accent`、`toolTitle`），语义由 pi 固定。

package/docs/agents/domain.md

@@ -1,51 +0,0 @@
-# Domain Docs
-
-How the engineering skills should consume this repo's domain documentation when exploring the codebase.
-
-## Before exploring, read these
-
-- **`CONTEXT.md`** at the repo root, or
-- **`CONTEXT-MAP.md`** at the repo root if it exists — it points at one `CONTEXT.md` per context. Read each one relevant to the topic.
-- **`docs/adr/`** — read ADRs that touch the area you're about to work in. In multi-context repos, also check `src/<context>/docs/adr/` for context-scoped decisions.
-
-If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The `/domain-modeling` skill (reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates them lazily when terms or decisions actually get resolved.
-
-## File structure
-
-Single-context repo (most repos):
-
-```
-/
-├── CONTEXT.md
-├── docs/adr/
-│   ├── 0001-event-sourced-orders.md
-│   └── 0002-postgres-for-write-model.md
-└── src/
-```
-
-Multi-context repo (presence of `CONTEXT-MAP.md` at the root):
-
-```
-/
-├── CONTEXT-MAP.md
-├── docs/adr/                          ← system-wide decisions
-└── src/
-    ├── ordering/
-    │   ├── CONTEXT.md
-    │   └── docs/adr/                  ← context-specific decisions
-    └── billing/
-        ├── CONTEXT.md
-        └── docs/adr/
-```
-
-## Use the glossary's vocabulary
-
-When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids.
-
-If the concept you need isn't in the glossary yet, that's a signal — either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`).
-
-## Flag ADR conflicts
-
-If your output contradicts an existing ADR, surface it explicitly rather than silently overriding:
-
-> _Contradicts ADR-0007 (event-sourced orders) — but worth reopening because…_

package/docs/agents/issue-tracker.md

@@ -1,45 +0,0 @@
-# Issue tracker: GitHub
-
-Issues and specs for this repo live as GitHub issues. Use the `gh` CLI for all operations.
-
-## Conventions
-
-- **Create an issue**: `gh issue create --title "..." --body "..."`. Use a heredoc for multi-line bodies.
-- **Read an issue**: `gh issue view <number> --comments`, filtering comments by `jq` and also fetching labels.
-- **List issues**: `gh issue list --state open --json number,title,body,labels,comments --jq '[.[] | {number, title, body, labels: [.labels[].name], comments: [.comments[].body]}]'` with appropriate `--label` and `--state` filters.
-- **Comment on an issue**: `gh issue comment <number> --body "..."`
-- **Apply / remove labels**: `gh issue edit <number> --add-label "..."` / `--remove-label "..."`
-- **Close**: `gh issue close <number> --comment "..."`
-
-Infer the repo from `git remote -v` — `gh` does this automatically when run inside a clone.
-
-## Pull requests as a triage surface
-
-**PRs as a request surface: no.** _(Set to `yes` if this repo treats external PRs as feature requests; `/triage` reads this flag.)_
-
-When set to `yes`, PRs run through the same labels and states as issues, using the `gh pr` equivalents:
-
-- **Read a PR**: `gh pr view <number> --comments` and `gh pr diff <number>` for the diff.
-- **List external PRs for triage**: `gh pr list --state open --json number,title,body,labels,author,authorAssociation,comments` then keep only `authorAssociation` of `CONTRIBUTOR`, `FIRST_TIME_CONTRIBUTOR`, or `NONE` (drop `OWNER`/`MEMBER`/`COLLABORATOR`).
-- **Comment / label / close**: `gh pr comment`, `gh pr edit --add-label`/`--remove-label`, `gh pr close`.
-
-GitHub shares one number space across issues and PRs, so a bare `#42` may be either — resolve with `gh pr view 42` and fall back to `gh issue view 42`.
-
-## When a skill says "publish to the issue tracker"
-
-Create a GitHub issue.
-
-## When a skill says "fetch the relevant ticket"
-
-Run `gh issue view <number> --comments`.
-
-## Wayfinding operations
-
-Used by `/wayfinder`. The **map** is a single issue with **child** issues as tickets.
-
-- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `gh issue create --label wayfinder:map`.
-- **Child ticket**: an issue linked to the map as a GitHub sub-issue (`gh api` on the sub-issues endpoint). Where sub-issues aren't enabled, add the child to a task list in the map body and put `Part of #<map>` at the top of the child body. Labels: `wayfinder:<type>` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev.
-- **Blocking**: GitHub's **native issue dependencies** — the canonical, UI-visible representation. Add an edge with `gh api --method POST repos/<owner>/<repo>/issues/<child>/dependencies/blocked_by -F issue_id=<blocker-db-id>`, where `<blocker-db-id>` is the blocker's numeric **database id** (`gh api repos/<owner>/<repo>/issues/<n> --jq .id`, _not_ the `#number` or `node_id`). GitHub reports `issue_dependencies_summary.blocked_by` (open blockers only — the live gate). Where dependencies aren't available, fall back to a `Blocked by: #<n>, #<n>` line at the top of the child body. A ticket is unblocked when every blocker is closed.
-- **Frontier query**: list the map's open children (`gh issue list --state open`, scoped to the map's sub-issues / task list), drop any with an open blocker (`issue_dependencies_summary.blocked_by > 0`, or an open issue in the `Blocked by` line) or an assignee; first in map order wins.
-- **Claim**: `gh issue edit <n> --add-assignee @me` — the session's first write.
-- **Resolve**: `gh issue comment <n> --body "<answer>"`, then `gh issue close <n>`, then append a context pointer (gist + link) to the map's Decisions-so-far.

package/docs/agents/triage-labels.md

@@ -1,15 +0,0 @@
-# Triage Labels
-
-The skills speak in terms of five canonical triage roles. This file maps those roles to the actual label strings used in this repo's issue tracker.
-
-| Label in mattpocock/skills | Label in our tracker | Meaning                                  |
-| -------------------------- | -------------------- | ---------------------------------------- |
-| `needs-triage`             | `needs-triage`       | Maintainer needs to evaluate this issue  |
-| `needs-info`               | `needs-info`         | Waiting on reporter for more information |
-| `ready-for-agent`          | `ready-for-agent`    | Fully specified, ready for an AFK agent  |
-| `ready-for-human`          | `ready-for-human`    | Requires human implementation            |
-| `wontfix`                  | `wontfix`            | Will not be actioned                     |
-
-When a skill mentions a role (e.g. "apply the AFK-ready triage label"), use the corresponding label string from this table.
-
-Edit the right-hand column to match whatever vocabulary you actually use.