@clickminded/coauthor-cli 0.0.14 → 0.0.15

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@clickminded/coauthor-cli",
3
- "version": "0.0.14",
3
+ "version": "0.0.15",
4
4
  "type": "module",
5
5
  "bin": {
6
6
  "coauthor": "dist/index.js",
@@ -32,8 +32,72 @@ This skill guides agent use of the CoAuthor CLI.
32
32
  - For simple starts, use `coauthor project create --title "..." --topic "prose brief" --audience "target reader" --json`.
33
33
  - When you know the editorial contract fields, prefer `coauthor project create --contract '<json>' --json` instead of cramming structured data into `--topic`.
34
34
  - Keep `--topic` as a plain prose brief. Do not pass JSON through `--topic`.
35
- - `--contract` accepts a JSON object with editorial contract fields such as `topic`, `angle`, `target_audience`, `core_promise`, `format`, `reading_commitment`, `length_guidance`, `audience_knowledge_assumptions`, `desired_reader_experience`, `structure_preferences`, `must_include`, `must_avoid`, `non_negotiables`, `evidence_expectations`, `citation_expectations`, `liked_examples`, `rejected_examples`, `additional_editorial_guidance`, `editorial_profile`, `style_rules`, `must_not_change`, `structure_preference`, and `confidence_notes`.
35
+ - `--contract` accepts a JSON object. All fields are optional; omitted fields are normalized to defaults. Prefer including at least `topic`, `target_audience`, `core_promise`, and either `angle` or `additional_editorial_guidance` when known.
36
36
  - Top-level `--title`, `--topic`, and `--audience` can still be used with `--contract`; they fill missing project title, contract topic, or contract audience fields.
37
+ - Editorial contract schema:
38
+
39
+ ```ts
40
+ {
41
+ topic?: string
42
+ angle?: string
43
+ target_audience?: string
44
+ core_promise?: string
45
+ format?: string
46
+ reading_commitment?: null | {
47
+ kind: "preset" | "custom"
48
+ preset_id?: null | "quick_read" | "balanced_post" | "deep_dive"
49
+ source: "user_explicit" | "user_choice" | "assistant_inferred" | "system_default"
50
+ }
51
+ length_guidance?: {
52
+ min_words?: number | null
53
+ target_words?: number | null
54
+ max_words?: number | null
55
+ }
56
+ audience_knowledge_assumptions?: string
57
+ desired_reader_experience?: string
58
+ structure_preferences?: string[]
59
+ must_include?: string[]
60
+ must_avoid?: string[]
61
+ non_negotiables?: string[]
62
+ evidence_expectations?: string[]
63
+ citation_expectations?: string[]
64
+ liked_examples?: string[]
65
+ rejected_examples?: string[]
66
+ additional_editorial_guidance?: string
67
+ editorial_profile?: {
68
+ tone?: "light" | "balanced" | "serious"
69
+ form?: "essay" | "listicle" | "guide" | "case_study" | "analysis" | "mixed"
70
+ depth?: "scannable" | "standard" | "deep"
71
+ humor?: "none" | "low" | "medium" | "high"
72
+ section_length?: "adaptive" | "mostly_short" | "mostly_long" | "mixed"
73
+ cadence?: "tight" | "moderate" | "expansive"
74
+ notes?: string
75
+ }
76
+ canonical_entities?: Array<{
77
+ actor_key?: string
78
+ character_name?: string
79
+ role_title?: string
80
+ description?: string
81
+ aliases?: string[]
82
+ must_preserve?: boolean
83
+ }>
84
+ outline_seed?: Array<{
85
+ id?: string
86
+ heading?: string
87
+ intent?: string
88
+ must_include_points?: string[]
89
+ required_actor_keys?: string[]
90
+ notes?: string
91
+ }>
92
+ style_rules?: string[]
93
+ must_not_change?: string[]
94
+ structure_preference?: string
95
+ confidence_notes?: string
96
+ }
97
+ ```
98
+
99
+ - Use `reading_commitment.kind: "preset"` with a preset id for quick length choices; use `"custom"` with explicit `length_guidance` when the user gives a custom range.
100
+ - Use top-level `canonical_entities`, `outline_seed`, `style_rules`, `must_not_change`, `structure_preference`, and `confidence_notes`. A legacy nested `handoff` object may be normalized, but top-level fields are clearer for agents.
37
101
  - Example:
38
102
 
39
103
  ```bash
@@ -32,8 +32,72 @@ This skill guides agent use of the CoAuthor CLI.
32
32
  - For simple starts, use `coauthor project create --title "..." --topic "prose brief" --audience "target reader" --json`.
33
33
  - When you know the editorial contract fields, prefer `coauthor project create --contract '<json>' --json` instead of cramming structured data into `--topic`.
34
34
  - Keep `--topic` as a plain prose brief. Do not pass JSON through `--topic`.
35
- - `--contract` accepts a JSON object with editorial contract fields such as `topic`, `angle`, `target_audience`, `core_promise`, `format`, `reading_commitment`, `length_guidance`, `audience_knowledge_assumptions`, `desired_reader_experience`, `structure_preferences`, `must_include`, `must_avoid`, `non_negotiables`, `evidence_expectations`, `citation_expectations`, `liked_examples`, `rejected_examples`, `additional_editorial_guidance`, `editorial_profile`, `style_rules`, `must_not_change`, `structure_preference`, and `confidence_notes`.
35
+ - `--contract` accepts a JSON object. All fields are optional; omitted fields are normalized to defaults. Prefer including at least `topic`, `target_audience`, `core_promise`, and either `angle` or `additional_editorial_guidance` when known.
36
36
  - Top-level `--title`, `--topic`, and `--audience` can still be used with `--contract`; they fill missing project title, contract topic, or contract audience fields.
37
+ - Editorial contract schema:
38
+
39
+ ```ts
40
+ {
41
+ topic?: string
42
+ angle?: string
43
+ target_audience?: string
44
+ core_promise?: string
45
+ format?: string
46
+ reading_commitment?: null | {
47
+ kind: "preset" | "custom"
48
+ preset_id?: null | "quick_read" | "balanced_post" | "deep_dive"
49
+ source: "user_explicit" | "user_choice" | "assistant_inferred" | "system_default"
50
+ }
51
+ length_guidance?: {
52
+ min_words?: number | null
53
+ target_words?: number | null
54
+ max_words?: number | null
55
+ }
56
+ audience_knowledge_assumptions?: string
57
+ desired_reader_experience?: string
58
+ structure_preferences?: string[]
59
+ must_include?: string[]
60
+ must_avoid?: string[]
61
+ non_negotiables?: string[]
62
+ evidence_expectations?: string[]
63
+ citation_expectations?: string[]
64
+ liked_examples?: string[]
65
+ rejected_examples?: string[]
66
+ additional_editorial_guidance?: string
67
+ editorial_profile?: {
68
+ tone?: "light" | "balanced" | "serious"
69
+ form?: "essay" | "listicle" | "guide" | "case_study" | "analysis" | "mixed"
70
+ depth?: "scannable" | "standard" | "deep"
71
+ humor?: "none" | "low" | "medium" | "high"
72
+ section_length?: "adaptive" | "mostly_short" | "mostly_long" | "mixed"
73
+ cadence?: "tight" | "moderate" | "expansive"
74
+ notes?: string
75
+ }
76
+ canonical_entities?: Array<{
77
+ actor_key?: string
78
+ character_name?: string
79
+ role_title?: string
80
+ description?: string
81
+ aliases?: string[]
82
+ must_preserve?: boolean
83
+ }>
84
+ outline_seed?: Array<{
85
+ id?: string
86
+ heading?: string
87
+ intent?: string
88
+ must_include_points?: string[]
89
+ required_actor_keys?: string[]
90
+ notes?: string
91
+ }>
92
+ style_rules?: string[]
93
+ must_not_change?: string[]
94
+ structure_preference?: string
95
+ confidence_notes?: string
96
+ }
97
+ ```
98
+
99
+ - Use `reading_commitment.kind: "preset"` with a preset id for quick length choices; use `"custom"` with explicit `length_guidance` when the user gives a custom range.
100
+ - Use top-level `canonical_entities`, `outline_seed`, `style_rules`, `must_not_change`, `structure_preference`, and `confidence_notes`. A legacy nested `handoff` object may be normalized, but top-level fields are clearer for agents.
37
101
  - Example:
38
102
 
39
103
  ```bash
@@ -32,8 +32,72 @@ This skill guides agent use of the CoAuthor CLI.
32
32
  - For simple starts, use `coauthor project create --title "..." --topic "prose brief" --audience "target reader" --json`.
33
33
  - When you know the editorial contract fields, prefer `coauthor project create --contract '<json>' --json` instead of cramming structured data into `--topic`.
34
34
  - Keep `--topic` as a plain prose brief. Do not pass JSON through `--topic`.
35
- - `--contract` accepts a JSON object with editorial contract fields such as `topic`, `angle`, `target_audience`, `core_promise`, `format`, `reading_commitment`, `length_guidance`, `audience_knowledge_assumptions`, `desired_reader_experience`, `structure_preferences`, `must_include`, `must_avoid`, `non_negotiables`, `evidence_expectations`, `citation_expectations`, `liked_examples`, `rejected_examples`, `additional_editorial_guidance`, `editorial_profile`, `style_rules`, `must_not_change`, `structure_preference`, and `confidence_notes`.
35
+ - `--contract` accepts a JSON object. All fields are optional; omitted fields are normalized to defaults. Prefer including at least `topic`, `target_audience`, `core_promise`, and either `angle` or `additional_editorial_guidance` when known.
36
36
  - Top-level `--title`, `--topic`, and `--audience` can still be used with `--contract`; they fill missing project title, contract topic, or contract audience fields.
37
+ - Editorial contract schema:
38
+
39
+ ```ts
40
+ {
41
+ topic?: string
42
+ angle?: string
43
+ target_audience?: string
44
+ core_promise?: string
45
+ format?: string
46
+ reading_commitment?: null | {
47
+ kind: "preset" | "custom"
48
+ preset_id?: null | "quick_read" | "balanced_post" | "deep_dive"
49
+ source: "user_explicit" | "user_choice" | "assistant_inferred" | "system_default"
50
+ }
51
+ length_guidance?: {
52
+ min_words?: number | null
53
+ target_words?: number | null
54
+ max_words?: number | null
55
+ }
56
+ audience_knowledge_assumptions?: string
57
+ desired_reader_experience?: string
58
+ structure_preferences?: string[]
59
+ must_include?: string[]
60
+ must_avoid?: string[]
61
+ non_negotiables?: string[]
62
+ evidence_expectations?: string[]
63
+ citation_expectations?: string[]
64
+ liked_examples?: string[]
65
+ rejected_examples?: string[]
66
+ additional_editorial_guidance?: string
67
+ editorial_profile?: {
68
+ tone?: "light" | "balanced" | "serious"
69
+ form?: "essay" | "listicle" | "guide" | "case_study" | "analysis" | "mixed"
70
+ depth?: "scannable" | "standard" | "deep"
71
+ humor?: "none" | "low" | "medium" | "high"
72
+ section_length?: "adaptive" | "mostly_short" | "mostly_long" | "mixed"
73
+ cadence?: "tight" | "moderate" | "expansive"
74
+ notes?: string
75
+ }
76
+ canonical_entities?: Array<{
77
+ actor_key?: string
78
+ character_name?: string
79
+ role_title?: string
80
+ description?: string
81
+ aliases?: string[]
82
+ must_preserve?: boolean
83
+ }>
84
+ outline_seed?: Array<{
85
+ id?: string
86
+ heading?: string
87
+ intent?: string
88
+ must_include_points?: string[]
89
+ required_actor_keys?: string[]
90
+ notes?: string
91
+ }>
92
+ style_rules?: string[]
93
+ must_not_change?: string[]
94
+ structure_preference?: string
95
+ confidence_notes?: string
96
+ }
97
+ ```
98
+
99
+ - Use `reading_commitment.kind: "preset"` with a preset id for quick length choices; use `"custom"` with explicit `length_guidance` when the user gives a custom range.
100
+ - Use top-level `canonical_entities`, `outline_seed`, `style_rules`, `must_not_change`, `structure_preference`, and `confidence_notes`. A legacy nested `handoff` object may be normalized, but top-level fields are clearer for agents.
37
101
  - Example:
38
102
 
39
103
  ```bash
@@ -26,8 +26,73 @@ alwaysApply: true
26
26
  - For simple starts, use `coauthor project create --title "..." --topic "prose brief" --audience "target reader" --json`.
27
27
  - When you know the editorial contract fields, prefer `coauthor project create --contract '<json>' --json` instead of cramming structured data into `--topic`.
28
28
  - Keep `--topic` as a plain prose brief. Do not pass JSON through `--topic`.
29
- - `--contract` accepts a JSON object with editorial contract fields such as `topic`, `angle`, `target_audience`, `core_promise`, `format`, `reading_commitment`, `length_guidance`, `audience_knowledge_assumptions`, `desired_reader_experience`, `structure_preferences`, `must_include`, `must_avoid`, `non_negotiables`, `evidence_expectations`, `citation_expectations`, `liked_examples`, `rejected_examples`, `additional_editorial_guidance`, `editorial_profile`, `style_rules`, `must_not_change`, `structure_preference`, and `confidence_notes`.
29
+ - `--contract` accepts a JSON object. All fields are optional; omitted fields are normalized to defaults. Prefer including at least `topic`, `target_audience`, `core_promise`, and either `angle` or `additional_editorial_guidance` when known.
30
30
  - Top-level `--title`, `--topic`, and `--audience` can still be used with `--contract`; they fill missing project title, contract topic, or contract audience fields.
31
+
32
+ ## Editorial Contract Schema
33
+
34
+ ```ts
35
+ {
36
+ topic?: string
37
+ angle?: string
38
+ target_audience?: string
39
+ core_promise?: string
40
+ format?: string
41
+ reading_commitment?: null | {
42
+ kind: "preset" | "custom"
43
+ preset_id?: null | "quick_read" | "balanced_post" | "deep_dive"
44
+ source: "user_explicit" | "user_choice" | "assistant_inferred" | "system_default"
45
+ }
46
+ length_guidance?: {
47
+ min_words?: number | null
48
+ target_words?: number | null
49
+ max_words?: number | null
50
+ }
51
+ audience_knowledge_assumptions?: string
52
+ desired_reader_experience?: string
53
+ structure_preferences?: string[]
54
+ must_include?: string[]
55
+ must_avoid?: string[]
56
+ non_negotiables?: string[]
57
+ evidence_expectations?: string[]
58
+ citation_expectations?: string[]
59
+ liked_examples?: string[]
60
+ rejected_examples?: string[]
61
+ additional_editorial_guidance?: string
62
+ editorial_profile?: {
63
+ tone?: "light" | "balanced" | "serious"
64
+ form?: "essay" | "listicle" | "guide" | "case_study" | "analysis" | "mixed"
65
+ depth?: "scannable" | "standard" | "deep"
66
+ humor?: "none" | "low" | "medium" | "high"
67
+ section_length?: "adaptive" | "mostly_short" | "mostly_long" | "mixed"
68
+ cadence?: "tight" | "moderate" | "expansive"
69
+ notes?: string
70
+ }
71
+ canonical_entities?: Array<{
72
+ actor_key?: string
73
+ character_name?: string
74
+ role_title?: string
75
+ description?: string
76
+ aliases?: string[]
77
+ must_preserve?: boolean
78
+ }>
79
+ outline_seed?: Array<{
80
+ id?: string
81
+ heading?: string
82
+ intent?: string
83
+ must_include_points?: string[]
84
+ required_actor_keys?: string[]
85
+ notes?: string
86
+ }>
87
+ style_rules?: string[]
88
+ must_not_change?: string[]
89
+ structure_preference?: string
90
+ confidence_notes?: string
91
+ }
92
+ ```
93
+
94
+ - Use `reading_commitment.kind: "preset"` with a preset id for quick length choices; use `"custom"` with explicit `length_guidance` when the user gives a custom range.
95
+ - Use top-level `canonical_entities`, `outline_seed`, `style_rules`, `must_not_change`, `structure_preference`, and `confidence_notes`. A legacy nested `handoff` object may be normalized, but top-level fields are clearer for agents.
31
96
  - Never print tokens, service-role keys, cookies, or authorization headers.
32
97
  - Never ask the user to paste Anthropic, OpenAI, or Gemini provider API keys into chat or the terminal; key entry belongs in CoAuthor AI settings.
33
98
  - Pass tokens through environment variables or secret-backed CLI options only.