@clickminded/coauthor-cli 0.0.66 → 0.0.67
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.
- package/README.md +3 -3
- package/dist/commands.js +11 -11
- package/package.json +1 -1
- package/skills/coauthor/SKILL.md +2 -2
- package/skills/coauthor/references/brief-and-contract.md +2 -2
- package/skills/coauthor/references/seo-content-plan.md +2 -2
- package/skills/coauthor/references/troubleshooting.md +1 -1
- package/skills/cursor/coauthor-cli.mdc +7 -7
package/README.md
CHANGED
|
@@ -46,7 +46,7 @@ A typical piece:
|
|
|
46
46
|
|
|
47
47
|
```sh
|
|
48
48
|
coauthor profile list --json # pick the writer profile (voice, context, image style)
|
|
49
|
-
coauthor site status --json # SEO mode: the profile website's page index
|
|
49
|
+
coauthor site status --json # SEO mode: the profile website's page index
|
|
50
50
|
coauthor project create --title "Post title" --contract @brief.json --profile <profile id> --json
|
|
51
51
|
coauthor source add <id> notes.pdf --json # optional reference documents, before research
|
|
52
52
|
coauthor workflow run <id> --target contract --briefing-mode strict --json # CoAuthor questions the brief
|
|
@@ -86,9 +86,9 @@ coauthor export wordpress <id> --yes --json # creates a WordPr
|
|
|
86
86
|
coauthor credits <id> --json
|
|
87
87
|
coauthor integrations list --json # WordPress sites and X accounts
|
|
88
88
|
coauthor seo markets --country Mexico --language Spanish --json # Google search data coverage for a market
|
|
89
|
-
coauthor search-brief show <id> --json # SEO mode: target keyword and what ranks
|
|
89
|
+
coauthor search-brief show <id> --json # SEO mode: target keyword and what ranks
|
|
90
90
|
coauthor search-brief set-keyword <id> "email marketing" --json # target your own keyword (--confirm-reset after an outline)
|
|
91
|
-
coauthor seo-plan generate --wait --json # SEO content plan for the default profile: ~420 credits, 5-12 minutes
|
|
91
|
+
coauthor seo-plan generate --wait --json # SEO content plan for the default profile: ~420 credits, 5-12 minutes
|
|
92
92
|
coauthor seo-plan show --kind post --json # strategy, Do next moves, counts, and the post ideas
|
|
93
93
|
coauthor seo-plan write <item-id> --json # open a project for a post idea, then continue with workflow run
|
|
94
94
|
coauthor seo-plan dismiss <item-id> --json # hide an idea (--undo brings it back)
|
package/dist/commands.js
CHANGED
|
@@ -805,7 +805,7 @@ function searchBriefMessage(data) {
|
|
|
805
805
|
return target.explanation;
|
|
806
806
|
return typeof brief.status === 'string' ? `Search targeting: ${brief.status}.` : undefined;
|
|
807
807
|
}
|
|
808
|
-
// SEO mode
|
|
808
|
+
// SEO mode: the keyword this post targets and the research behind it.
|
|
809
809
|
async function runSearchBriefCommand(action, input, client) {
|
|
810
810
|
const projectId = requireProjectId(input);
|
|
811
811
|
const path = `projects/${encodeURIComponent(projectId)}/search-brief`;
|
|
@@ -2197,7 +2197,7 @@ function siteMessage(data, request) {
|
|
|
2197
2197
|
return `The last index of ${origin} failed. Try \`coauthor site reindex\`.`;
|
|
2198
2198
|
return `${origin} has not been indexed yet.`;
|
|
2199
2199
|
}
|
|
2200
|
-
// SEO mode
|
|
2200
|
+
// SEO mode: the site index behind a profile's website, which
|
|
2201
2201
|
// internal links and own-site evidence read. Defaults to the default profile.
|
|
2202
2202
|
async function runSiteCommand(action, input, client) {
|
|
2203
2203
|
if (action && !['status', 'reindex'].includes(action))
|
|
@@ -2218,7 +2218,7 @@ async function runSiteCommand(action, input, client) {
|
|
|
2218
2218
|
const data = await client.request({ path });
|
|
2219
2219
|
return { ok: true, message: siteMessage(data), data };
|
|
2220
2220
|
}
|
|
2221
|
-
// ─── SEO content plan
|
|
2221
|
+
// ─── SEO content plan ────────────────────────────────────────────────────────
|
|
2222
2222
|
const SEO_PLAN_KINDS = ['post', 'improve', 'page', 'left_out', 'covered', 'not_checked'];
|
|
2223
2223
|
const SEO_PLAN_KIND_LABELS = {
|
|
2224
2224
|
post: 'posts to write',
|
|
@@ -3442,8 +3442,8 @@ export function helpResult(command = []) {
|
|
|
3442
3442
|
' brief review|answer',
|
|
3443
3443
|
' profile list|show|update (update: --interactive-widgets on|off)',
|
|
3444
3444
|
' widgets list|status|build|build-all|use-image|edit|delete (interactives, beta)',
|
|
3445
|
-
' site status|reindex [--profile <profile-id>]
|
|
3446
|
-
' seo-plan show|generate|write|dismiss|done|monthly-check|results
|
|
3445
|
+
' site status|reindex [--profile <profile-id>]',
|
|
3446
|
+
' seo-plan show|generate|write|dismiss|done|monthly-check|results',
|
|
3447
3447
|
' source list|add|remove',
|
|
3448
3448
|
' integrations list',
|
|
3449
3449
|
' log add|show',
|
|
@@ -3453,7 +3453,7 @@ export function helpResult(command = []) {
|
|
|
3453
3453
|
' draft get supports --format json|markdown|html|text (--frontmatter adds post details to markdown)',
|
|
3454
3454
|
' post-details show|set',
|
|
3455
3455
|
' seo markets [--country <country>] [--language <language>]',
|
|
3456
|
-
' search-brief show|set-keyword|set-mode
|
|
3456
|
+
' search-brief show|set-keyword|set-mode',
|
|
3457
3457
|
' workflow show|status|advance|run|rewind|approve|resume',
|
|
3458
3458
|
' workflow run/advance supports --briefing-mode auto|strict|off and --require-brief-review',
|
|
3459
3459
|
' image list|status|show|generate|edit|metadata|replace',
|
|
@@ -3495,8 +3495,8 @@ function commandHelp(command) {
|
|
|
3495
3495
|
'',
|
|
3496
3496
|
'Creates a project. When --topic or --audience is provided, CoAuthor seeds the saved contract so workflow briefing review can use that context.',
|
|
3497
3497
|
'--contract accepts a JSON editorial contract object. Top-level --topic and --audience fill missing contract topic/audience fields.',
|
|
3498
|
-
'--keyword (SEO mode
|
|
3499
|
-
'--seo (SEO mode
|
|
3498
|
+
'--keyword (SEO mode) sets the Google search keyword the post targets. It is researched when the outline is generated and never replaced automatically.',
|
|
3499
|
+
'--seo (SEO mode) sets how the post uses search: optimize (the outline covers what ranks and keeps your angle), my-way (written as planned; the keyword goes only in the SEO title, meta description and slug) or off. Without it, the profile\'s Search optimization setting applies, and "Ask each time" optimizes.',
|
|
3500
3500
|
].join('\n'),
|
|
3501
3501
|
'workflow run': [
|
|
3502
3502
|
'Usage: coauthor workflow run <project-id> --target <outline|research|draft> [--planning-model <id>] [--writing-model <id>] [--wait] [--briefing-mode auto|strict|off] [--json]',
|
|
@@ -3571,7 +3571,7 @@ function commandHelp(command) {
|
|
|
3571
3571
|
'Usage: coauthor site status [--profile <profile-id>] [--json]',
|
|
3572
3572
|
' coauthor site reindex [--profile <profile-id>] [--json]',
|
|
3573
3573
|
'',
|
|
3574
|
-
'SEO mode
|
|
3574
|
+
'SEO mode. CoAuthor reads the website on a writer profile from its sitemap (up to 500 recent pages) to link new posts to it and cite its own pages as evidence.',
|
|
3575
3575
|
'status shows the website, its index status (pending, indexing, ready, blocked, failed) and how many pages are indexed. Without --profile it uses the default profile.',
|
|
3576
3576
|
'reindex starts a fresh read (free). It answers already_indexing during a crawl and reindex_too_soon within 15 minutes of the last one; no_website when the profile has no website.',
|
|
3577
3577
|
].join('\n'),
|
|
@@ -3584,7 +3584,7 @@ function commandHelp(command) {
|
|
|
3584
3584
|
' coauthor seo-plan monthly-check on|off [--profile <profile-id>] [--json]',
|
|
3585
3585
|
' coauthor seo-plan results [--profile <profile-id>] [--json]',
|
|
3586
3586
|
'',
|
|
3587
|
-
'SEO content plan
|
|
3587
|
+
'SEO content plan: a business-wide keyword plan for a writer profile, built from live search data and the profile\'s website. Without --profile it uses the default profile.',
|
|
3588
3588
|
'show prints the strategy, the Do next moves, counts per kind, and the ideas of one kind (default post). Kinds: post (written post ideas), improve (existing pages to improve), page (page ideas, not blog posts), left_out (searches skipped, with a reason), covered, not_checked.',
|
|
3589
3589
|
'generate makes or updates the plan (about 420 credits, most plans 300-500, charged as it runs; the account needs 500 credits remaining to start). --adjust gives a one-line steer. --wait polls for up to 9 minutes, then exits 2 with still_running; run the same command again to keep waiting.',
|
|
3590
3590
|
'write <item-id> opens a project for a post idea, already set up from the plan, and prints its id and the start prompt. Continue with the normal project flow. Writing the same idea again returns the same project.',
|
|
@@ -3716,7 +3716,7 @@ function commandHelp(command) {
|
|
|
3716
3716
|
' coauthor search-brief set-keyword <project-id> "<keyword>" [--confirm-reset] [--json]',
|
|
3717
3717
|
' coauthor search-brief set-mode <project-id> <optimize|my-way|off> [--confirm-reset] [--json]',
|
|
3718
3718
|
'',
|
|
3719
|
-
'SEO mode
|
|
3719
|
+
'SEO mode. show prints the keyword this post targets, its volume, difficulty and market, and what the ranking pages cover and miss.',
|
|
3720
3720
|
'set-keyword targets a keyword you choose; CoAuthor researches it (SEO research credits) and never replaces it automatically.',
|
|
3721
3721
|
'If an outline exists, set-keyword answers confirmation_required: changing the keyword regenerates the outline, research and draft. Repeat with --confirm-reset to proceed.',
|
|
3722
3722
|
'set-mode chooses how the post uses its keyword: optimize (reads what ranks; SEO research credits), my-way (no ranking-page read; the keyword goes only in the SEO title, meta description and slug) or off. optimize and my-way need a search target (no_search_target otherwise). After an outline exists, a change answers confirmation_required like set-keyword.',
|
package/package.json
CHANGED
package/skills/coauthor/SKILL.md
CHANGED
|
@@ -61,7 +61,7 @@ Typical timing: brief and outline under a minute; research and draft 3–10 minu
|
|
|
61
61
|
|
|
62
62
|
Everything else, including auth problems: `references/troubleshooting.md`. Credits, plans, and models: `references/credits-and-plans.md`.
|
|
63
63
|
|
|
64
|
-
## SEO content plan
|
|
64
|
+
## SEO content plan
|
|
65
65
|
|
|
66
66
|
When the user wants to know what to write about for a business site, or asks for a keyword or content strategy, make a plan instead of guessing topics. A plan reads live search data and the profile's website, then lists post ideas that can win, pages to improve, and page ideas that are not blog posts.
|
|
67
67
|
|
|
@@ -73,7 +73,7 @@ When the user wants to know what to write about for a business site, or asks for
|
|
|
73
73
|
- `coauthor seo-plan monthly-check on|off --json` switches the plan's monthly check, which re-checks where each published post ranks on Google and refreshes the plan's chances. It uses credits (about 30 a month; the first check is free). `show` returns `data.monthly_check` (`enabled`, `next_check_at`, `estimate_credits`), or `null` while it is not switched on for the account.
|
|
74
74
|
- `coauthor seo-plan results --json` reads the last monthly check: where each tracked post ranks on Google (`data.results`: `position`, `previous_position`, `movement`, `ranking_url`), the posts that have a target search but no live address yet, except ones marked as still being edited (`data.missing_urls`), and how the check went (`data.last_check`). Posts without a live address are not tracked; set one with `coauthor post-details set <id> --live-url <url>`.
|
|
75
75
|
|
|
76
|
-
Details, item fields, and what each kind means: `references/seo-content-plan.md`. If a command answers `not_enabled`,
|
|
76
|
+
Details, item fields, and what each kind means: `references/seo-content-plan.md`. If a command answers `not_enabled`, SEO content plans are not switched on for this account; carry on without a plan.
|
|
77
77
|
|
|
78
78
|
## Housekeeping
|
|
79
79
|
|
|
@@ -13,7 +13,7 @@ All fields are optional and omitted ones get defaults, but always include at lea
|
|
|
13
13
|
## Profiles and source documents
|
|
14
14
|
|
|
15
15
|
- `coauthor profile list --json` shows the user's writer profiles: `is_default` marks the one new projects get without `--profile`, plus a `summary` and the `visual_style`. `coauthor profile show <profile id> --json` shows the voice, writer context, and business context in full, plus the profile's `website` and `search_country` (null until set in the web app; the search language follows the language each post is written in). Pass `--profile <id>` to `project create`; the profile can't be changed later, so pick deliberately. Profiles are created and edited in the web app (`manage_url`).
|
|
16
|
-
- `coauthor site status [--profile <id>] --json` (SEO mode
|
|
16
|
+
- `coauthor site status [--profile <id>] --json` (SEO mode) shows how much of the profile's website CoAuthor has read (`site.status`: pending, indexing, ready, blocked, failed; `site.indexed_pages`). SEO posts link to those pages and cite them as evidence. `coauthor site reindex` refreshes it after the user publishes new pages; it is free and needs no confirmation.
|
|
17
17
|
- `coauthor source add <id> <file>` uploads a reference document CoAuthor's research reads (PDF up to about 3.3 MB through the CLI, .txt or .md up to 512 KB, 5 per project). `coauthor source list <id> --json` shows them; `coauthor source remove <id> <source id> --yes` deletes one.
|
|
18
18
|
- Add sources before research runs. Adding or removing one after research marks the research and draft stale (the output says `research_invalidated`), so research has to run again.
|
|
19
19
|
|
|
@@ -21,7 +21,7 @@ All fields are optional and omitted ones get defaults, but always include at lea
|
|
|
21
21
|
|
|
22
22
|
`coauthor seo markets --country <country> --language <language> --json` checks whether CoAuthor has Google search data for a country and language (names or codes both work). `data.support.tier` is `full` (search volume, keyword difficulty, and ranking checks), `limited` (CoAuthor can analyze what ranks, but not difficulty or existing rankings), `unsupported`, or `unknown_country`. `data.explanation.message` is a sentence you can give the user, and `data.explanation.alternatives` lists covered languages for that country and covered countries for that language. Use `--country` or `--language` alone to list one side; markets are country-level.
|
|
23
23
|
|
|
24
|
-
## Search target
|
|
24
|
+
## Search target
|
|
25
25
|
|
|
26
26
|
SEO mode is rolling out gradually; accounts outside it get `feature_unavailable` from these commands. When it is on, a post on a searchable topic targets one Google keyword chosen from real search data, and the outline and draft are built around it.
|
|
27
27
|
- You don't have to do anything: when the outline is generated, CoAuthor checks search demand, picks a keyword the user's site can win, and reads what currently ranks (table stakes, gaps, intent, format, a length hint). This costs SEO research credits and is skipped for topics nobody searches for.
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# SEO content plan
|
|
1
|
+
# SEO content plan
|
|
2
2
|
|
|
3
3
|
A plan is a business-wide keyword strategy for one writer profile: what the site should publish, what to fix on pages it already has, and what to skip. It is built from live Google search data and the profile's website (so the profile needs a website that `coauthor site status` reports as `ready`). One plan per profile; making it again updates it.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
SEO content plans are open to every CoAuthor account. An account where they are not switched on gets `not_enabled` from every `seo-plan` command; carry on without a plan and pick topics yourself.
|
|
6
6
|
|
|
7
7
|
## When to use it
|
|
8
8
|
|
|
@@ -54,7 +54,7 @@ Every failure prints JSON on stderr with `ok: false`, `error` (a readable messag
|
|
|
54
54
|
| `structured_brief` | `image generate --prompt` on a comparison or technical-diagram image, which is built from structured fields. | Generate without `--prompt`, then `image edit --edit-prompt "..."`. |
|
|
55
55
|
| `uploaded_image` | `image generate` on an image the user replaced with their own file. | Use `image edit --edit-prompt "..."`, or `image replace` again. |
|
|
56
56
|
| `not_a_panel` | `image replace` on an article image. | Only slideshow and video panels can be replaced from the CLI. |
|
|
57
|
-
| `not_enabled` | `seo-plan` commands on an account
|
|
57
|
+
| `not_enabled` | `seo-plan` commands on an account where SEO content plans are not switched on. | Carry on without a plan and choose topics yourself. |
|
|
58
58
|
| `profile_not_found` | `--profile` isn't one of the user's profiles. | `coauthor profile list --json` and use an `id` from it. |
|
|
59
59
|
| `profile_archived` | `seo-plan generate` on an archived profile. | Use another profile, or the user restores it in the web app. |
|
|
60
60
|
| `site_required` | `seo-plan generate` on a profile with no website. | Ask the user to add the website to the profile in the web app. |
|
|
@@ -63,7 +63,7 @@ Typical timing: brief and outline under a minute; research and draft 3–10 minu
|
|
|
63
63
|
|
|
64
64
|
Everything else, including auth problems: `references/troubleshooting.md`. Credits, plans, and models: `references/credits-and-plans.md`.
|
|
65
65
|
|
|
66
|
-
## SEO content plan
|
|
66
|
+
## SEO content plan
|
|
67
67
|
|
|
68
68
|
When the user wants to know what to write about for a business site, or asks for a keyword or content strategy, make a plan instead of guessing topics. A plan reads live search data and the profile's website, then lists post ideas that can win, pages to improve, and page ideas that are not blog posts.
|
|
69
69
|
|
|
@@ -75,7 +75,7 @@ When the user wants to know what to write about for a business site, or asks for
|
|
|
75
75
|
- `coauthor seo-plan monthly-check on|off --json` switches the plan's monthly check, which re-checks where each published post ranks on Google and refreshes the plan's chances. It uses credits (about 30 a month; the first check is free). `show` returns `data.monthly_check` (`enabled`, `next_check_at`, `estimate_credits`), or `null` while it is not switched on for the account.
|
|
76
76
|
- `coauthor seo-plan results --json` reads the last monthly check: where each tracked post ranks on Google (`data.results`: `position`, `previous_position`, `movement`, `ranking_url`), the posts that have a target search but no live address yet, except ones marked as still being edited (`data.missing_urls`), and how the check went (`data.last_check`). Posts without a live address are not tracked; set one with `coauthor post-details set <id> --live-url <url>`.
|
|
77
77
|
|
|
78
|
-
Details, item fields, and what each kind means: `references/seo-content-plan.md`. If a command answers `not_enabled`,
|
|
78
|
+
Details, item fields, and what each kind means: `references/seo-content-plan.md`. If a command answers `not_enabled`, SEO content plans are not switched on for this account; carry on without a plan.
|
|
79
79
|
|
|
80
80
|
## Housekeeping
|
|
81
81
|
|
|
@@ -106,7 +106,7 @@ All fields are optional and omitted ones get defaults, but always include at lea
|
|
|
106
106
|
### Profiles and source documents
|
|
107
107
|
|
|
108
108
|
- `coauthor profile list --json` shows the user's writer profiles: `is_default` marks the one new projects get without `--profile`, plus a `summary` and the `visual_style`. `coauthor profile show <profile id> --json` shows the voice, writer context, and business context in full, plus the profile's `website` and `search_country` (null until set in the web app; the search language follows the language each post is written in). Pass `--profile <id>` to `project create`; the profile can't be changed later, so pick deliberately. Profiles are created and edited in the web app (`manage_url`).
|
|
109
|
-
- `coauthor site status [--profile <id>] --json` (SEO mode
|
|
109
|
+
- `coauthor site status [--profile <id>] --json` (SEO mode) shows how much of the profile's website CoAuthor has read (`site.status`: pending, indexing, ready, blocked, failed; `site.indexed_pages`). SEO posts link to those pages and cite them as evidence. `coauthor site reindex` refreshes it after the user publishes new pages; it is free and needs no confirmation.
|
|
110
110
|
- `coauthor source add <id> <file>` uploads a reference document CoAuthor's research reads (PDF up to about 3.3 MB through the CLI, .txt or .md up to 512 KB, 5 per project). `coauthor source list <id> --json` shows them; `coauthor source remove <id> <source id> --yes` deletes one.
|
|
111
111
|
- Add sources before research runs. Adding or removing one after research marks the research and draft stale (the output says `research_invalidated`), so research has to run again.
|
|
112
112
|
|
|
@@ -114,7 +114,7 @@ All fields are optional and omitted ones get defaults, but always include at lea
|
|
|
114
114
|
|
|
115
115
|
`coauthor seo markets --country <country> --language <language> --json` checks whether CoAuthor has Google search data for a country and language (names or codes both work). `data.support.tier` is `full` (search volume, keyword difficulty, and ranking checks), `limited` (CoAuthor can analyze what ranks, but not difficulty or existing rankings), `unsupported`, or `unknown_country`. `data.explanation.message` is a sentence you can give the user, and `data.explanation.alternatives` lists covered languages for that country and covered countries for that language. Use `--country` or `--language` alone to list one side; markets are country-level.
|
|
116
116
|
|
|
117
|
-
### Search target
|
|
117
|
+
### Search target
|
|
118
118
|
|
|
119
119
|
SEO mode is rolling out gradually; accounts outside it get `feature_unavailable` from these commands. When it is on, a post on a searchable topic targets one Google keyword chosen from real search data, and the outline and draft are built around it.
|
|
120
120
|
- You don't have to do anything: when the outline is generated, CoAuthor checks search demand, picks a keyword the user's site can win, and reads what currently ranks (table stakes, gaps, intent, format, a length hint). This costs SEO research credits and is skipped for topics nobody searches for.
|
|
@@ -585,11 +585,11 @@ Only X can be posted directly. A thread posts with `coauthor publish thread <id>
|
|
|
585
585
|
|
|
586
586
|
## references/seo-content-plan.md
|
|
587
587
|
|
|
588
|
-
## SEO content plan
|
|
588
|
+
## SEO content plan
|
|
589
589
|
|
|
590
590
|
A plan is a business-wide keyword strategy for one writer profile: what the site should publish, what to fix on pages it already has, and what to skip. It is built from live Google search data and the profile's website (so the profile needs a website that `coauthor site status` reports as `ready`). One plan per profile; making it again updates it.
|
|
591
591
|
|
|
592
|
-
|
|
592
|
+
SEO content plans are open to every CoAuthor account. An account where they are not switched on gets `not_enabled` from every `seo-plan` command; carry on without a plan and pick topics yourself.
|
|
593
593
|
|
|
594
594
|
### When to use it
|
|
595
595
|
|
|
@@ -746,7 +746,7 @@ Every failure prints JSON on stderr with `ok: false`, `error` (a readable messag
|
|
|
746
746
|
| `structured_brief` | `image generate --prompt` on a comparison or technical-diagram image, which is built from structured fields. | Generate without `--prompt`, then `image edit --edit-prompt "..."`. |
|
|
747
747
|
| `uploaded_image` | `image generate` on an image the user replaced with their own file. | Use `image edit --edit-prompt "..."`, or `image replace` again. |
|
|
748
748
|
| `not_a_panel` | `image replace` on an article image. | Only slideshow and video panels can be replaced from the CLI. |
|
|
749
|
-
| `not_enabled` | `seo-plan` commands on an account
|
|
749
|
+
| `not_enabled` | `seo-plan` commands on an account where SEO content plans are not switched on. | Carry on without a plan and choose topics yourself. |
|
|
750
750
|
| `profile_not_found` | `--profile` isn't one of the user's profiles. | `coauthor profile list --json` and use an `id` from it. |
|
|
751
751
|
| `profile_archived` | `seo-plan generate` on an archived profile. | Use another profile, or the user restores it in the web app. |
|
|
752
752
|
| `site_required` | `seo-plan generate` on a profile with no website. | Ask the user to add the website to the profile in the web app. |
|