firecrawl-cli 1.9.7 → 1.9.8

package/dist/commands/experimental/workflows/market-research.js

@@ -0,0 +1,254 @@
+"use strict";
+/**
+ * Workflow: Market Research
+ *
+ * Browses financial portals, earnings pages, and market data sites using a
+ * cloud browser. Interacts with charts, filters, and dropdowns to extract
+ * earnings data, market metrics, and financial comparisons across companies.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.register = register;
+const backends_1 = require("../backends");
+const shared_1 = require("../shared");
+// ─── Input gathering ────────────────────────────────────────────────────────
+async function gatherInputs(prefill) {
+    if (prefill?.query) {
+        return {
+            query: prefill.query,
+            companies: '',
+            dataPoints: 'all',
+            output: 'json',
+            context: '',
+        };
+    }
+    const { input, select } = await Promise.resolve().then(() => __importStar(require('@inquirer/prompts')));
+    const query = await input({
+        message: 'What market or industry to research? (e.g., "cloud infrastructure", "AI SaaS")',
+        validate: (0, shared_1.validateRequired)('Market or industry'),
+    });
+    const companies = await input({
+        message: 'Specific companies to include? (comma-separated, leave blank to discover)',
+        default: '',
+    });
+    const dataPoints = await select({
+        message: 'What data are you looking for?',
+        choices: [
+            { name: 'Everything (revenue, earnings, metrics, news)', value: 'all' },
+            { name: 'Financial data (revenue, earnings, margins)', value: 'financial' },
+            { name: 'Market metrics (market cap, P/E, growth rates)', value: 'metrics' },
+            { name: 'Industry trends and news', value: 'trends' },
+        ],
+    });
+    const output = await select({
+        message: 'Output format?',
+        choices: [
+            { name: 'JSON (structured data)', value: 'json' },
+            { name: 'Markdown report', value: 'markdown' },
+            { name: 'Print to terminal', value: 'terminal' },
+        ],
+    });
+    const context = await input({
+        message: 'Any specific angle? (e.g., "focus on Q4 2024 earnings", "compare gross margins")',
+        default: '',
+    });
+    return { query, companies, dataPoints, output, context };
+}
+// ─── System prompt ──────────────────────────────────────────────────────────
+function buildSystemPrompt(opts) {
+    const focusInstructions = {
+        all: 'Extract comprehensive data: revenue, earnings, margins, market cap, P/E ratio, growth rates, recent news, and analyst estimates.',
+        financial: 'Focus on financial statements: quarterly/annual revenue, net income, gross margin, operating margin, EPS, and YoY growth.',
+        metrics: 'Focus on market metrics: market cap, P/E ratio, P/S ratio, EV/EBITDA, 52-week range, average volume, and beta.',
+        trends: 'Focus on industry trends: market size estimates, growth forecasts, major deals/acquisitions, regulatory changes, and emerging players.',
+    };
+    const outputInstructions = {
+        terminal: 'Print the full market research report to the terminal in well-formatted markdown with data tables.',
+        json: `Save the report to \`market-research.json\` in the current directory. Tell the user the file path when done.
+
+Use this schema:
+\`\`\`json
+{
+  "market": "string",
+  "researchedAt": "ISO-8601",
+  "companies": [
+    {
+      "name": "string",
+      "ticker": "string",
+      "sector": "string",
+      "financials": {
+        "revenue": { "value": "string", "period": "string", "yoyGrowth": "string" },
+        "netIncome": { "value": "string", "period": "string" },
+        "grossMargin": "string",
+        "operatingMargin": "string",
+        "eps": "string"
+      },
+      "marketMetrics": {
+        "marketCap": "string",
+        "peRatio": "string",
+        "psRatio": "string",
+        "52weekHigh": "string",
+        "52weekLow": "string"
+      },
+      "recentNews": [{ "date": "string", "headline": "string", "source": "string", "url": "string" }],
+      "sources": ["url"]
+    }
+  ],
+  "industryTrends": [{ "trend": "string", "details": "string", "source": "url" }],
+  "sources": [{ "url": "string", "type": "string", "dataExtracted": "string" }]
+}
+\`\`\``,
+        markdown: 'Save the report to `market-research.md` in the current directory. Tell the user the file path when done.',
+    };
+    return `You are a market research agent powered by Firecrawl. You use a real cloud browser to navigate financial portals, interact with data visualizations, and extract structured market data.
+
+## STEP 1: Launch Browser and Open Live View
+
+Before anything else, launch a browser session so the user can watch:
+
+\`\`\`bash
+firecrawl browser launch-session --json
+\`\`\`
+
+Extract the \`interactiveLiveViewUrl\` from the JSON output and open it (NOT the regular \`liveViewUrl\` -- the interactive one lets the user click and interact):
+
+\`\`\`bash
+open "<interactiveLiveViewUrl>"          # macOS
+xdg-open "<interactiveLiveViewUrl>"     # Linux
+\`\`\`
+
+If the \`open\` command fails, print the URL clearly.
+
+## STEP 2: Identify Target Companies
+
+If the user didn't specify companies, search for key players in the market:
+
+\`\`\`bash
+firecrawl search "<market> top public companies"
+firecrawl search "<market> industry leaders revenue"
+\`\`\`
+
+## STEP 3: Extract Data from Financial Portals
+
+For each company, visit financial data sources and interact with their UIs:
+
+### Primary sources to visit:
+- **Yahoo Finance** (finance.yahoo.com) -- Company profile, financials, statistics
+- **Macrotrends** (macrotrends.net) -- Historical financials, charts
+- **SEC filings** (sec.gov/cgi-bin/browse-edgar) -- For US public companies
+- **Company investor relations pages** -- Direct earnings reports
+
+### How to extract data:
+1. Navigate to the company's financial page
+2. Snapshot to see available data sections
+3. Click tabs like "Financials", "Statistics", "Historical Data"
+4. Interact with period selectors (quarterly/annual toggles)
+5. Scroll through data tables and extract values
+6. Click into earnings reports or press releases for details
+
+### Browser commands:
+\`\`\`bash
+firecrawl browser "open <url>"
+firecrawl browser "snapshot"
+firecrawl browser "click @<ref>"
+firecrawl browser "type @<ref> <text>"
+firecrawl browser "scroll down"
+firecrawl browser "scrape"
+\`\`\`
+
+Also use \`firecrawl scrape <url>\` for quick page grabs when browser interaction isn't needed.
+
+## Data Focus
+
+${focusInstructions[opts.dataPoints]}
+
+## Output Format
+
+${outputInstructions[opts.output]}
+
+Structure your report with:
+
+### Market Overview
+- Industry description, size, and growth trajectory
+- Key players and market share (if available)
+
+### Company Profiles
+For each company:
+- Financial summary (revenue, margins, growth)
+- Market metrics (cap, ratios)
+- Recent developments
+
+### Comparison Tables
+- Revenue comparison across companies
+- Margin comparison
+- Valuation multiples side-by-side
+
+### Trends & Outlook
+- Industry trends and forecasts
+- Analyst consensus if available
+
+### Sources
+- Every URL visited with what data was extracted
+
+---
+
+Do everything sequentially. Cross-reference data across sources when possible. Note any conflicting numbers. Start immediately.`;
+}
+// ─── Command registration ───────────────────────────────────────────────────
+function register(parentCmd, backend) {
+    const config = backends_1.BACKENDS[backend];
+    parentCmd
+        .command('market-research')
+        .description('Extract financial data, earnings, and market metrics via browser')
+        .argument('[query...]', 'Market, industry, or company to research')
+        .option('-y, --yes', 'Auto-approve all tool permissions')
+        .action(async (queryParts, options) => {
+        const prefillQuery = queryParts.length > 0 ? queryParts.join(' ') : undefined;
+        const inputs = await gatherInputs(prefillQuery ? { query: prefillQuery } : undefined);
+        const parts = [`Research market: ${inputs.query}`];
+        if (inputs.companies)
+            parts.push(`Include these companies: ${inputs.companies}`);
+        if (inputs.context)
+            parts.push(inputs.context);
+        const userMessage = parts.join('. ') + '.';
+        const skipPermissions = true;
+        console.log(`\nLaunching ${config.displayName}...\n`);
+        (0, backends_1.launchAgent)(backend, buildSystemPrompt({
+            dataPoints: inputs.dataPoints,
+            output: inputs.output,
+        }), userMessage, skipPermissions);
+    });
+}
+//# sourceMappingURL=market-research.js.map

package/dist/commands/experimental/workflows/market-research.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"market-research.js","sourceRoot":"","sources":["../../../../src/commands/experimental/workflows/market-research.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiOH,4BAoCC;AAlQD,0CAAkE;AAClE,sCAA6C;AAY7C,+EAA+E;AAE/E,KAAK,UAAU,YAAY,CAAC,OAA4B;IACtD,IAAI,OAAO,EAAE,KAAK,EAAE,CAAC;QACnB,OAAO;YACL,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,SAAS,EAAE,EAAE;YACb,UAAU,EAAE,KAAK;YACjB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE;SACZ,CAAC;IACJ,CAAC;IAED,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,wDAAa,mBAAmB,GAAC,CAAC;IAE5D,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC;QACxB,OAAO,EACL,gFAAgF;QAClF,QAAQ,EAAE,IAAA,yBAAgB,EAAC,oBAAoB,CAAC;KACjD,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC;QAC5B,OAAO,EACL,2EAA2E;QAC7E,OAAO,EAAE,EAAE;KACZ,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC;QAC9B,OAAO,EAAE,gCAAgC;QACzC,OAAO,EAAE;YACP,EAAE,IAAI,EAAE,+CAA+C,EAAE,KAAK,EAAE,KAAK,EAAE;YACvE,EAAE,IAAI,EAAE,6CAA6C,EAAE,KAAK,EAAE,WAAW,EAAE;YAC3E,EAAE,IAAI,EAAE,gDAAgD,EAAE,KAAK,EAAE,SAAS,EAAE;YAC5E,EAAE,IAAI,EAAE,0BAA0B,EAAE,KAAK,EAAE,QAAQ,EAAE;SACtD;KACF,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC;QAC1B,OAAO,EAAE,gBAAgB;QACzB,OAAO,EAAE;YACP,EAAE,IAAI,EAAE,wBAAwB,EAAE,KAAK,EAAE,MAAM,EAAE;YACjD,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,EAAE,UAAU,EAAE;YAC9C,EAAE,IAAI,EAAE,mBAAmB,EAAE,KAAK,EAAE,UAAU,EAAE;SACjD;KACF,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC;QAC1B,OAAO,EACL,kFAAkF;QACpF,OAAO,EAAE,EAAE;KACZ,CAAC,CAAC;IAEH,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;AAC3D,CAAC;AAED,+EAA+E;AAE/E,SAAS,iBAAiB,CAAC,IAG1B;IACC,MAAM,iBAAiB,GAA2B;QAChD,GAAG,EAAE,kIAAkI;QACvI,SAAS,EACP,2HAA2H;QAC7H,OAAO,EACL,gHAAgH;QAClH,MAAM,EACJ,wIAAwI;KAC3I,CAAC;IAEF,MAAM,kBAAkB,GAA2B;QACjD,QAAQ,EACN,oGAAoG;QACtG,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCH;QACH,QAAQ,EACN,0GAA0G;KAC7G,CAAC;IAEF,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4DP,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC;;;;EAIlC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;gIA4B+F,CAAC;AACjI,CAAC;AAED,+EAA+E;AAE/E,SAAgB,QAAQ,CAAC,SAAkB,EAAE,OAAgB;IAC3D,MAAM,MAAM,GAAG,mBAAQ,CAAC,OAAO,CAAC,CAAC;IAEjC,SAAS;SACN,OAAO,CAAC,iBAAiB,CAAC;SAC1B,WAAW,CACV,kEAAkE,CACnE;SACA,QAAQ,CAAC,YAAY,EAAE,0CAA0C,CAAC;SAClE,MAAM,CAAC,WAAW,EAAE,mCAAmC,CAAC;SACxD,MAAM,CAAC,KAAK,EAAE,UAAoB,EAAE,OAAO,EAAE,EAAE;QAC9C,MAAM,YAAY,GAChB,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3D,MAAM,MAAM,GAAG,MAAM,YAAY,CAC/B,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,SAAS,CACnD,CAAC;QAEF,MAAM,KAAK,GAAG,CAAC,oBAAoB,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACnD,IAAI,MAAM,CAAC,SAAS;YAClB,KAAK,CAAC,IAAI,CAAC,4BAA4B,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;QAC7D,IAAI,MAAM,CAAC,OAAO;YAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/C,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;QAE3C,MAAM,eAAe,GAAG,IAAI,CAAC;QAC7B,OAAO,CAAC,GAAG,CAAC,eAAe,MAAM,CAAC,WAAW,OAAO,CAAC,CAAC;QAEtD,IAAA,sBAAW,EACT,OAAO,EACP,iBAAiB,CAAC;YAChB,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC,EACF,WAAW,EACX,eAAe,CAChB,CAAC;IACJ,CAAC,CAAC,CAAC;AACP,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firecrawl-cli",
-  "version": "1.9.7",
+  "version": "1.9.8",
   "description": "Command-line interface for Firecrawl. Scrape, crawl, and extract data from any website directly from your terminal.",
   "main": "dist/index.js",
   "bin": {
@@ -68,7 +68,7 @@
   },
   "dependencies": {
     "@inquirer/prompts": "^8.2.1",
-    "@mendable/firecrawl-js": "4.15.3",
+    "@mendable/firecrawl-js": "4.15.4",
     "commander": "^14.0.2"
   }
 }