@nuxtseo/cli 0.5.4 → 0.5.5

package/README.md

@@ -206,6 +206,9 @@ nuxtseo sitemaps urls
 nuxtseo sitemaps submit <sitemap-url>
 nuxtseo sitemaps delete <sitemap-url>
 nuxtseo research overview
+nuxtseo research competitors list
+nuxtseo research competitors add <domain> --yes
+nuxtseo research competitors remove <competitor-id> --yes
 nuxtseo research domain-traffic <domain>
 nuxtseo research domain-availability <domains>
 nuxtseo research keywords <topic>

package/dist/commands.js

@@ -762,6 +762,40 @@ async function researchOverview(runtime, globals) {
     }, { signal: runtime.requestSignal }));
     return present(runtime, globals, response, value => renderResearchOverview(value.data));
 }
+async function competitorsList(runtime, globals) {
+    const resolved = await apiAndSite(runtime, globals);
+    if (resolved._tag === 'Err')
+        return resolved;
+    const response = await withSpinner(runtime, 'Loading competitors', () => resolved.value.api.client.research.listCompetitors({
+        params: { siteId: resolved.value.siteId },
+    }, { signal: runtime.requestSignal }));
+    return present(runtime, globals, response, value => value.data.competitors.map(competitor => `${competitor.id}\t${competitor.domain}`).join('\n') || '0 tracked competitors');
+}
+async function competitorWrite(runtime, globals, action) {
+    const confirmed = await confirmMutation(runtime, globals, action._tag === 'Add'
+        ? `Track ${action.domain}? This uses the research limit.`
+        : `Remove competitor ${action.competitorId}? This cannot be undone.`);
+    if (confirmed._tag === 'Err')
+        return confirmed;
+    if (!confirmed.value) {
+        writeDiagnostic(runtime, 'Mutation cancelled.');
+        return ok(undefined);
+    }
+    const resolved = await apiAndSite(runtime, globals);
+    if (resolved._tag === 'Err')
+        return resolved;
+    if (action._tag === 'Add') {
+        const response = await withSpinner(runtime, 'Adding competitor', () => resolved.value.api.client.research.addCompetitor({
+            params: { siteId: resolved.value.siteId },
+            body: { domain: action.domain },
+        }, { signal: runtime.requestSignal }));
+        return present(runtime, globals, response, value => `${value.data.competitor.id}\t${value.data.competitor.domain}\tAnalysis queued`);
+    }
+    const response = await withSpinner(runtime, 'Removing competitor', () => resolved.value.api.client.research.removeCompetitor({
+        params: { siteId: resolved.value.siteId, competitorId: action.competitorId },
+    }, { signal: runtime.requestSignal }));
+    return present(runtime, globals, response, value => `Removed competitor ${value.data.competitorId}`);
+}
 /**
  * DataForSEO refuses these characters, so the research provider removes them
  * before it counts the words of a seed. Mirrored from
@@ -1833,6 +1867,25 @@ export function createRootCommand(runtime, globals, execution) {
     const research = defineCommand({
         meta: { name: 'research', description: 'Read stored and live search research' },
         subCommands: {
+            'competitors': defineCommand({
+                meta: { name: 'competitors', description: 'Manage tracked competitors for the Site' },
+                subCommands: {
+                    list: defineCommand({
+                        meta: { name: 'list', description: 'List tracked competitor domains and ids' },
+                        run: ({ args }) => capture(execution, () => competitorsList(runtime, globals), args._, 0)(),
+                    }),
+                    add: defineCommand({
+                        meta: { name: 'add', description: 'Track one competitor and queue its analysis' },
+                        args: { domain: positional('domain', 'Public competitor domain') },
+                        run: ({ args }) => capture(execution, () => competitorWrite(runtime, globals, { _tag: 'Add', domain: args.domain }), args._, 1)(),
+                    }),
+                    remove: defineCommand({
+                        meta: { name: 'remove', description: 'Remove one competitor using its listed id' },
+                        args: { competitorId: positional('competitorId', 'Competitor id from research competitors list') },
+                        run: ({ args }) => capture(execution, () => competitorWrite(runtime, globals, { _tag: 'Remove', competitorId: args.competitorId }), args._, 1)(),
+                    }),
+                },
+            }),
             'overview': defineCommand({
                 meta: { name: 'overview', description: 'Read stored Site metrics and competitor research' },
                 run: ({ args }) => capture(execution, () => researchOverview(runtime, globals), args._, 0)(),

package/dist/render.js

@@ -484,9 +484,19 @@ export function renderResearchOverview(data) {
     return [subject, `Competitors: ${data.summary.competitorCount}`, competitors].join('\n');
 }
 export function renderKeywordResearch(data) {
+    const measured = data.topicMetrics.filter(row => row._tag === 'measured').length;
+    const topics = data.topicMetrics.length
+        ? [
+            `Requested topics (${measured}/${data.topicMetrics.length} measured)`,
+            ...data.topicMetrics.map(row => row._tag === 'measured'
+                ? `${row.metrics.volume ?? 'unknown'} volume  ${row.metrics.difficulty ?? 'unknown'} difficulty  ${row.metrics.intent ?? 'unknown intent'}\n  ${row.topic}`
+                : `No data returned\n  ${row.topic}`),
+        ]
+        : [];
     if (data.keywords.length === 0)
-        return data.message ?? `No keyword ideas found for ${data.topic}.`;
+        return [...topics, data.message ?? `No keyword ideas found for ${data.topic}.`, ...(data.tip ? [`Tip: ${data.tip}`] : [])].join('\n');
     return [
+        ...topics,
         `Keyword ideas for ${data.topic} (${data.keywords.length} of ${data.totalFound})${data.evidence._tag === 'cache' ? '  cached' : ''}`,
         ...data.keywords.map(row => `${row.volume ?? 'unknown'} volume  ${row.difficulty ?? 'unknown'} difficulty  ${row.intent ?? 'unknown intent'}\n  ${row.keyword}`),
         ...(data.tip ? [`Tip: ${data.tip}`] : []),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nuxtseo/cli",
   "type": "module",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "description": "Command line interface for the Nuxt SEO public API.",
   "license": "MIT",
   "homepage": "https://nuxtseo.com/pro",
@@ -33,8 +33,8 @@
   },
   "dependencies": {
     "@clack/prompts": "^1.8.0",
-    "@nuxtseo/protocol": "^0.5.4",
-    "@nuxtseo/sdk": "^0.5.4",
+    "@nuxtseo/protocol": "^0.5.5",
+    "@nuxtseo/sdk": "^0.5.5",
     "citty": "^0.2.2",
     "pathe": "^2.0.3"
   },

package/skills/nuxtseo-cli/SKILL.md

@@ -64,6 +64,7 @@ Read the matching file before you act on its subject:
    | `page scan` | `page:write` |
    | `actions resolve`, `actions dismiss` | `actions:write` |
    | `annotations` writes | `timeline:write` |
+   | `research competitors add`, `research competitors remove` | `research:write` |
    | `sitemaps submit`, `sitemaps delete` | `sites:write` |
 
    If a write scope is missing, do the reads, then hand the user the exact

package/skills/nuxtseo-cli/references/commands.md

@@ -252,12 +252,16 @@ A missing query row is never evidence of no demand.
 ## Research, backlinks, and mentions
 
 Every command here can start live research, except `research overview`,
+`research competitors list`, `research competitors remove`,
 `backlinks recoverable` and `mentions list`, which read retained rows. Read the
 research boundary in SKILL.md first.
 
 | Command | What it returns, and its flags |
 | --- | --- |
 | `research overview` | Stored Site and competitor research: metrics, history, gaps, quick wins. Takes no flags. Returns `data.competitors` and `data.summary` |
+| `research competitors list` | Tracked competitor domains and ids for this Site. Suggested competitors stay excluded. Reads start no provider work. |
+| `research competitors add <domain>` | Mutation, requires `research:write` and `--yes`. Accepts a public domain or URL. Queues analysis within existing Site and Team limits. Returns `data.competitor.id` and `data.status: queued`. |
+| `research competitors remove <competitor-id>` | Mutation, requires `research:write` and `--yes`. Use an id from the list. Removes that Site's competitor without provider work. |
 | `research keywords <topic>` | Live keyword ideas, with volume, difficulty, intent, and cost data. The seed must be 1 to 3 words. The server refuses a longer seed. The refusal arrives as exit `0` with an empty `data.keywords`, so read `data.message` first. Comma-separate several short seeds instead. Special characters are stripped before the lookup. If a seed is under 2 characters after stripping, the server refuses it the same way. The server applies default filters and echoes them in `data.filters`: `--min-volume` (default 10), `--max-volume` (default 10000), `--min-difficulty 0..100` (default 0), `--max-difficulty 0..100` (default 60). So a default run hides keywords over difficulty 60 or under 10 searches. Also `--limit 1..100` (default 20), `--intent`, `--location-code` (default 2840), `--no-related` to drop related keywords, and `--verbose` for full evidence. If `--max-volume` is under `--min-volume`, the run exits `2`. The same holds for `--max-difficulty` under `--min-difficulty` |
 | `research serp <keyword>` | A live SERP snapshot: results, features, fetch time. `--depth 1..20` (default 10) sets how many organic results return. `--location-code` (default 2840). The keyword must be 2 to 200 characters. `data.cached` reports cache use |
 | `research rankings <domain>` | Live domain rankings: current keywords and domain metrics. `--limit 1..100` (default 50), `--min-position 1..100` (default 1), `--max-position 1..100` (default 20), `--location-code` (default 2840), `--order position\|traffic` (default `position`). So a default run returns only the top 20 positions. If `--max-position` is under `--min-position`, the run exits `2`. An unusable domain also exits `2`, with `invalid_request`. An empty `data.keywords` with exit `0` carries the reason in `data.message`. `data.cached` reports cache use |
@@ -270,6 +274,13 @@ research boundary in SKILL.md first.
 | `backlinks recoverable` | Stored recoverable backlinks. `--limit 1..200`, `--offset`. Reads retained rows |
 | `mentions list` | Stored mentions. `--limit 1..200` (default 100), `--include-filtered` to keep the Mentions AI triage marked a false positive. Reads retained rows |
 
+Keyword research returns `data.topicMetrics` for every accepted comma-separated topic.
+Read it separately from filtered `data.keywords`, which contains keyword ideas.
+A `measured` row preserves exact metrics, including zero volume and values outside idea filters.
+A `no-data` row means the provider returned no exact metrics. It does not mean zero volume.
+If any topic becomes shorter than two characters after sanitization, the server refuses the whole request.
+Cached reads preserve all topic metrics without another provider call.
+
 ## Crawl audit
 
 | Command | What it returns, and its flags |