port: stub omp README (omp install + source link); source README install via npm
Some checks failed
port-to-omp / port (push) Failing after 5s

This commit is contained in:
2026-08-10 16:07:30 -04:00
parent ba14a89b1a
commit 2a2155e871
2 changed files with 17 additions and 24 deletions

View File

@@ -3,7 +3,7 @@
Multi-round deep web research powered by Firecrawl with iterative query refinement.
```bash
pi install npm:@mikefreno/deep-research
pi install npm:@mikefreno/deepi-research
```
## Features

View File

@@ -207,6 +207,19 @@ function transformPkg() {
const ordered = reorder(raw, rule.order);
return JSON.stringify(ordered, null, 2) + "\n";
}
const README_STUB = `# deepi-research (omp port)
Multi-round deep web research via Firecrawl with iterative query refinement.
## Install
\`\`\`sh
omp install @mikefreno/omp-deepi-research
\`\`\`
This is the omp port of [Mike/deepi-research](https://git.freno.me/Mike/deepi-research), regenerated automatically from the source repo. See the source repo for full documentation.
`;
const FILE_RULES = {
"src/agent.ts": [
{ from: " * Uses pi's in-process `createAgentSession` for LLM subtasks", to: " * Uses omp's in-process `createAgentSession` for LLM subtasks" },
@@ -278,29 +291,7 @@ const FILE_RULES = {
label: "renderCall signature",
},
],
"README.md": [
{ from: "```bash\npi install npm:@mikefreno/deep-research\n```", to: "Deep Research is a local omp extension under `~/.omp/agent/extensions/deepi-research/`.\nOmp loads it via `omp.extensions` in `package.json` (entry `./index.ts`).", label: "install block" },
{ from: "Deep Research reads Firecrawl configuration from pi's settings.json files, with the following resolution order (later wins):", to: "Deep Research reads Firecrawl configuration from omp's config.yml files, with the following resolution order (later wins):" },
{ from: "2. Global settings (`$agentDir/settings.json`) → `firecrawl.*`", to: "2. Global config (`$agentDir/config.yml`) → `firecrawl.*`" },
{ from: "3. Project settings (`.pi/settings.json`) → `firecrawl.*`", to: "3. Project config (`.omp/config.yml`) → `firecrawl.*`" },
{ from: "The agent directory (`$agentDir`) defaults to `~/.pi/agent` and respects the `PI_CODING_AGENT_DIR` environment variable.", to: "The agent directory (`$agentDir`) defaults to `~/.omp/agent`." },
{ from: "**Global settings** (`~/.pi/agent/settings.json`):", to: "**Global config** (`~/.omp/agent/config.yml`):" },
{
from:
'```json\n{\n "firecrawl": {\n "baseUrl": "http://localhost:3002",\n }\n}\n```',
to:
"```yaml\nfirecrawl:\n baseUrl: http://localhost:3002\n```",
label: "global config example",
},
{ from: "**Project settings** (`.pi/settings.json` — overrides global):", to: "**Project config** (`.omp/config.yml` — overrides global):" },
{
from:
'```json\n{\n "firecrawl": {\n "baseUrl": "https://firecrawl.team.internal"\n "apiKey": "your-api-key"\n }\n}\n```',
to:
"```yaml\nfirecrawl:\n baseUrl: https://firecrawl.team.internal\n apiKey: your-api-key\n```",
label: "project config example",
},
],
};
// ─── main ───────────────────────────────────────────────────────────────────
@@ -329,6 +320,8 @@ function portExtension() {
writeFileSync(p, text);
} else if (rel === "package.json") {
writeFileSync(p, transformPkg());
} else if (rel === "README.md") {
writeFileSync(p, README_STUB);
} else if (rel.endsWith(".md")) {
let text = readFileSync(p, "utf8");
if (FILE_RULES[rel]) text = applyOps(text, FILE_RULES[rel], rel);