@lincoln504/pi-research 1.3.7 → 1.3.8

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.
Files changed (9) hide show
  1. package/README.md +31 -19
  2. package/docs/ARCHITECTURE.md +3 -3
  3. package/docs/CHANGELOG.md +15 -0
  4. package/docs/CONFIGURATION.md +2 -2
  5. package/docs/KNOWLEDGE-STORE.md +2 -2
  6. package/docs/PI-EXTENSION.md +2 -2
  7. package/docs/SDK.md +2 -2
  8. package/package.json +2 -2
  9. package/skills/pi-research/SKILL.md +1 -1
package/README.md CHANGED
@@ -1,9 +1,9 @@
1
1
  <p align="center">
2
- <img src="https://raw.githubusercontent.com/Lincoln504/pi-research/main/docs/media/banner.jpg" alt="pi-research — free, unlimited web search and deep research for coding agents" width="100%" />
2
+ <img src="https://raw.githubusercontent.com/Lincoln504/pi-research/main/docs/media/banner.jpg" alt="pi-research: free unlimited web search and knowledge store for coding agents" width="100%" />
3
3
  </p>
4
4
 
5
5
  <p align="center">
6
- <strong>Free, unlimited web search &amp; deep research for coding agents — no API key, no quota</strong>
6
+ <strong>Free unlimited web search &amp; knowledge store for coding agents</strong>
7
7
  </p>
8
8
 
9
9
  <p align="center">
@@ -22,52 +22,64 @@
22
22
 
23
23
  ---
24
24
 
25
- <a href="https://github.com/Lincoln504/pi-research/actions/workflows/ci.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/Lincoln504/pi-research/ci.yml?style=flat-square&branch=main" /></a> <a href="https://www.npmjs.com/package/@lincoln504/pi-research"><img alt="npm version" src="https://img.shields.io/npm/v/@lincoln504/pi-research.svg?style=flat-square" /></a>
25
+ <a href="https://github.com/Lincoln504/pi-research/actions/workflows/ci.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/Lincoln504/pi-research/ci.yml?style=flat-square&branch=main" /></a><br />
26
+ <a href="https://www.npmjs.com/package/@lincoln504/pi-research"><img alt="npm version" src="https://img.shields.io/npm/v/@lincoln504/pi-research.svg?style=flat-square" /></a><br />
27
+ <a href="LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-97ca00?style=flat-square" /></a><br />
28
+ <a href="https://github.com/Lincoln504/pi-research"><img alt="GitHub repository" src="https://img.shields.io/badge/GitHub-Lincoln504%2Fpi--research-181717?style=flat-square&logo=github&logoColor=white" /></a>
26
29
 
27
- Search and scraping run locally through a stealth browser — no search provider, no monthly cap. You pay only for the LLM tokens you use.
30
+ Search and scraping run locally through a stealth browser with no search provider and no monthly cap. You pay only for the LLM tokens you use.
28
31
 
29
32
  ### Install
30
33
 
34
+ As a [pi](https://github.com/earendil-works/pi) extension:
35
+
31
36
  ```bash
32
37
  pi install npm:@lincoln504/pi-research
33
38
  ```
34
39
 
35
- In [pi](https://github.com/earendil-works/pi) it works out of the box, on your session's model and pi's configuration. Standalone use — [agent skill](docs/AGENT-SKILL.md), CLI, or [SDK](docs/SDK.md) — needs a model configured; see [Configuration](docs/CONFIGURATION.md). The first install pulls the stealth browser engine, which takes a few minutes.
40
+ Standalone, as an [agent skill](docs/AGENT-SKILL.md) for Claude Code, Codex, and OpenClaw:
41
+
42
+ ```bash
43
+ npm install -g @lincoln504/pi-research
44
+ pi-research skill install
45
+ ```
46
+
47
+ In pi it works out of the box on your session's model and pi's configuration. Standalone use (agent skill, CLI, or [SDK](docs/SDK.md)) needs a model configured. See [Configuration](docs/CONFIGURATION.md). The first install pulls the stealth browser engine, which takes a few minutes.
36
48
 
37
49
  ### How it works
38
50
 
39
- A research run loops through agent teams: a coordinator plans and opens with a search, researcher agents scrape and read in parallel, and an evaluator decides whether to go another round or synthesize. The result is one cited Markdown report, with findings optionally saved to the knowledge store.
51
+ A research run loops through agent teams: a coordinator plans and opens with a search, researcher agents scrape and read in parallel, and an evaluator decides whether to go another round or synthesize. The result is one cited Markdown report with findings optionally saved to the knowledge store.
40
52
 
41
- Three depth levels — normal, deep, ultra — set the team size and number of rounds. Ask in natural language and the tool picks the right one:
53
+ Three depth levels (normal, deep, ultra) set the team size and number of rounds. Ask in natural language and the tool picks the right one:
42
54
 
43
55
  ![Prompt-driven multi-round research in the pi TUI](https://raw.githubusercontent.com/Lincoln504/pi-research/main/docs/media/02-prompt-research.gif)
44
56
 
45
57
  ### Use cases
46
58
 
47
- - Researching for your [Pi](https://github.com/earendil-works/pi) Coding Agent — plug-and-play, no API key needed.
48
- - Researching from Claude Code, Codex, OpenClaw, or another coding agent, with a cheaper or local model driving the run so it doesn't spend your main agent's budget.
49
- - Keeping a persistent, searchable knowledge store of findings — global or per-project.
50
- - Building agent systems that find and read web content, or populating a dataset of web sources.
59
+ - Researching for your [Pi](https://github.com/earendil-works/pi) Coding Agent. Plug and play with no API key needed.
60
+ - Researching from Claude Code, Codex, OpenClaw, or another coding agent while a cheaper or local model drives the run so it doesn't spend your main agent's budget.
61
+ - Keeping a persistent and searchable knowledge store of findings, scoped globally or per project.
62
+ - Building agent systems that find and read web content or populating a dataset of web sources.
51
63
 
52
64
  ### Why pi-research
53
65
 
54
- - **No quota, no monthly fee.** Most AI-search providers cap free searches and then charge, with results served from *their* index on *their* servers. pi-research searches and scrapes locally — DuckDuckGo via a stealth browser.
55
- - **You own your index.** Every finding is written to a local [LanceDB](https://lancedb.com) knowledge store that seeds future runs, so repeat questions get faster, cheaper answers.
56
- - **Cited reports, not raw dumps.** One synthesized, sourced Markdown report instead of raw web content pasted into the conversation — context-efficient and easy to verify.
66
+ - **No quota and no monthly fee.** Most AI search providers cap free searches and then charge, with results served from *their* index on *their* servers. pi-research searches and scrapes locally through DuckDuckGo in a stealth browser.
67
+ - **You own your index.** Every finding is written to a local [LanceDB](https://lancedb.com) knowledge store that seeds future runs, so repeat questions get faster and cheaper answers.
68
+ - **Cited reports rather than raw dumps.** You get one sourced Markdown report instead of raw web content pasted into the conversation. Context efficient and easy to verify.
57
69
  - **Read-only by design.** The research agent cannot run shell commands or write, edit, or delete anything. It can read and search files, so treat it as you would any read-only agent with access to your machine.
58
70
  - **Search a little or a lot.** Depth levels span a quick pass to a large-scale investigation.
59
71
 
60
72
  ### Requirements / limitations
61
73
 
62
74
  - Node.js >= 22.19.0
63
- - An LLM with a 100k+ context window — bring your own key or use a local model
64
- - Internet access on a residential IP — search, scraping, and YouTube transcripts rely on a residential connection; a datacenter/VPS/cloud IP gets bot-blocked
65
- - The [pi runtime](https://github.com/earendil-works/pi) — the pi extension uses the host's copy; the standalone CLI and agent skill install it as a dependency
66
- - Cloudflare and similar systems block scraping on some sites — a run flags pages it can't reach and compensates with a wide pool of search results to cite
75
+ - An LLM with a 100k+ context window (bring your own key or use a local model)
76
+ - Internet access on a residential IP, since search, scraping, and YouTube transcripts get bot-blocked from datacenter/VPS/cloud IPs
77
+ - The [pi runtime](https://github.com/earendil-works/pi). The pi extension uses the host's copy while the standalone CLI and agent skill install it as a dependency.
78
+ - Cloudflare and similar systems block scraping on some sites. A run flags pages it can't reach and compensates with a wide pool of search results to cite.
67
79
 
68
80
  ### Channels
69
81
 
70
- npm (`npm:@lincoln504/pi-research`) is the stable channel, kept current with breaking pi changes. A git install is the development channel: latest commits, first to break.
82
+ npm (`npm:@lincoln504/pi-research`) is the stable channel and is kept current with breaking pi changes. A git install is the development channel. It has the latest commits and breaks first.
71
83
 
72
84
  ### License
73
85
 
package/docs/ARCHITECTURE.md CHANGED
@@ -3,8 +3,8 @@
3
3
  pi-research is a pi TUI extension for multi-agent web research. It runs inside the pi
4
4
  process, registers its tools and commands, and manages its own browser worker pool,
5
5
  service registry, and local knowledge store. One engine backs every front-end: besides
6
- the pi extension it is exposed as a standalone CLI, a portable agent skill — the same
7
- skill any skills-aware host runs, including OpenClaw — and a programmatic SDK
6
+ the pi extension it is exposed as a standalone CLI, a portable agent skill (the same
7
+ skill any skills-aware host runs, including OpenClaw) and a programmatic SDK
8
8
  (`src/sdk.ts`).
9
9
 
10
10
  ```
@@ -318,7 +318,7 @@ other). This sits above `@lancedb/lancedb` 0.29's declared Arrow peer ceiling
318
318
  whenever `@lancedb/lancedb` is upgraded.
319
319
 
320
320
  Pinned validation library — `typebox` is pinned to the exact version the pi host packages
321
- depend on (`@earendil-works/pi-ai` / `@earendil-works/pi-coding-agent` 0.83.0 pin `1.3.7`). Every
321
+ depend on (`@earendil-works/pi-ai` / `@earendil-works/pi-coding-agent` 0.84.1 pin `1.3.7`). Every
322
322
  tool's parameter schema is built with TypeBox here and handed across the boundary to pi's
323
323
  tool system, so the two must agree on `Value.Check`/`Convert` semantics. A floating `^1.1.38`
324
324
  range let a fresh consumer install resolve pi-research to a newer TypeBox than pi's, shipping
package/docs/CHANGELOG.md CHANGED
@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [1.3.8] - 2026-08-13
9
+
10
+ Presentation and dependency maintenance only. No engine changes.
11
+
12
+ ### Changed
13
+
14
+ - **README refined.** New tagline ("Free unlimited web search & knowledge store for coding agents"), MIT license and GitHub repository badges added with all four badges stacked vertically, both install paths (pi extension and standalone agent skill) shown up top, and a punctuation pass removing em dashes and surplus commas and semicolons from README and the npm description. The punctuation pass now also covers the intro paragraphs of the docs/ pages.
15
+ - **npm description compacted.** The no-search-API-key and no-quotas clause is covered by "free unlimited" and is gone.
16
+ - **docs/ARCHITECTURE.md** typebox pin rationale updated to cite the current pi host version (0.84.1, which still pins typebox 1.3.7).
17
+ - **In-range dependency refresh.** esbuild 0.28.2, undici 8.10.0, eslint 10.8.1, typescript-eslint 8.67.0. Deliberate exact pins (playwright-core 1.60.0, camoufox-js 0.10.x, lancedb 0.29.0, apache-arrow 21.1.0, transformers 4.2.0) unchanged per their documented rationale.
18
+
19
+ ### Security
20
+
21
+ - Production audit gate re-verified. The single allowlisted advisory (GHSA-f88m-g3jw-g9cj, sharp via transformers, unreachable image path) still has no upstream fix; no new advisories.
22
+
8
23
  ## [1.3.7] - 2026-08-11
9
24
 
10
25
  Discovery and packaging metadata only — no engine changes.
package/docs/CONFIGURATION.md CHANGED
@@ -1,7 +1,7 @@
1
1
  ## Configuration
2
2
 
3
- Every front-end (the pi extension, the standalone CLI / agent skill — the surface
4
- OpenClaw and other skills-aware hosts run — and the SDK) shares one configuration
3
+ Every front-end (the pi extension, the standalone CLI / agent skill that OpenClaw
4
+ and other skills-aware hosts run, and the SDK) shares one configuration
5
5
  model. This document covers the
6
6
  settings exposed in the `/research-config` TUI first, then the complete
7
7
  environment-variable reference, and finally how the configuration layers resolve.
package/docs/KNOWLEDGE-STORE.md CHANGED
@@ -1,7 +1,7 @@
1
1
  ## Knowledge Store
2
2
 
3
- The knowledge store is a local vector database of past research findings. It is used
4
- in two distinct ways, and it is an optional cache — research works without it:
3
+ The knowledge store is a local vector database of past research findings. It is an
4
+ optional cache (research works without it) and is used in two distinct ways:
5
5
 
6
6
  - **Knowledge-first answering (advisory).** The `research_knowledge_search` tool
7
7
  answers a repeat or overlapping question directly from stored results. The agent is
package/docs/PI-EXTENSION.md CHANGED
@@ -1,8 +1,8 @@
1
1
  ## Pi Extension
2
2
 
3
3
  pi-research integrates as a [pi](https://github.com/earendil-works/pi)
4
- extension (`src/index.ts`) — a multi-agent web research engine with a real-time
5
- TUI, registered directly in the pi process.
4
+ extension (`src/index.ts`), a multi-agent web research engine with a real-time
5
+ TUI registered directly in the pi process.
6
6
 
7
7
  ### Usage
8
8
 
package/docs/SDK.md CHANGED
@@ -1,7 +1,7 @@
1
1
  ## SDK
2
2
 
3
- The programmatic SDK for scripts, CI, and custom tooling. For configuration — the
4
- layering model, the TUI settings, and every environment variable — see
3
+ The programmatic SDK for scripts, CI, and custom tooling. For configuration (the
4
+ layering model, the TUI settings, and every environment variable) see
5
5
  [CONFIGURATION.md](CONFIGURATION.md).
6
6
 
7
7
  ### Install
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@lincoln504/pi-research",
3
- "version": "1.3.7",
4
- "description": "Free, unlimited web search and deep research for the Pi coding agent — no search API key, no quotas. Local knowledge store; also works from Claude Code, Codex, and OpenClaw.",
3
+ "version": "1.3.8",
4
+ "description": "Free unlimited web search and deep research for the Pi coding agent. Local knowledge store. Also works from Claude Code, Codex, and OpenClaw.",
5
5
  "type": "module",
6
6
  "private": false,
7
7
  "main": "./src/index.ts",
package/skills/pi-research/SKILL.md CHANGED
@@ -2,7 +2,7 @@
2
2
  name: pi-research
3
3
  description: "Multi-agent web research for any coding agent. Use for anything requiring current information from the internet — news, trends, product/service/company facts, statistics, people, places, events, APIs, library behavior, or 'what is X / how does X work' questions. Also use to search a local knowledge store of previously researched findings before doing live research. Powered by the pi-research engine (search, stealth scraping, security databases, Stack Exchange). Not for reading local files, running project commands, or analyzing this repository's own source."
4
4
  license: MIT
5
- metadata: { "author": "Lincoln Deen", "version": "1.3.7", "package": "@lincoln504/pi-research", "engine": "pi-research-sdk", "openclaw": { "requires": { "bins": ["node"] } } }
5
+ metadata: { "author": "Lincoln Deen", "version": "1.3.8", "package": "@lincoln504/pi-research", "engine": "pi-research-sdk", "openclaw": { "requires": { "bins": ["node"] } } }
6
6
  allowed-tools: Bash(node:*)
7
7
  ---
8
8