@ahumandev/autocode 0.0.1

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.
Files changed (240) hide show
  1. package/LICENSE.md +21 -0
  2. package/README.md +379 -0
  3. package/dist/agents/index.d.ts +25 -0
  4. package/dist/agents/index.d.ts.map +1 -0
  5. package/dist/agents/index.test.d.ts +2 -0
  6. package/dist/agents/index.test.d.ts.map +1 -0
  7. package/dist/agents/prompts/assist.d.ts +2 -0
  8. package/dist/agents/prompts/assist.d.ts.map +1 -0
  9. package/dist/agents/prompts/assist_git_conflict.d.ts +2 -0
  10. package/dist/agents/prompts/assist_git_conflict.d.ts.map +1 -0
  11. package/dist/agents/prompts/assist_troubleshoot.d.ts +2 -0
  12. package/dist/agents/prompts/assist_troubleshoot.d.ts.map +1 -0
  13. package/dist/agents/prompts/auto.d.ts +2 -0
  14. package/dist/agents/prompts/auto.d.ts.map +1 -0
  15. package/dist/agents/prompts/auto_feature.d.ts +2 -0
  16. package/dist/agents/prompts/auto_feature.d.ts.map +1 -0
  17. package/dist/agents/prompts/auto_general.d.ts +2 -0
  18. package/dist/agents/prompts/auto_general.d.ts.map +1 -0
  19. package/dist/agents/prompts/auto_refactor.d.ts +2 -0
  20. package/dist/agents/prompts/auto_refactor.d.ts.map +1 -0
  21. package/dist/agents/prompts/auto_research.d.ts +2 -0
  22. package/dist/agents/prompts/auto_research.d.ts.map +1 -0
  23. package/dist/agents/prompts/auto_review_api.d.ts +2 -0
  24. package/dist/agents/prompts/auto_review_api.d.ts.map +1 -0
  25. package/dist/agents/prompts/auto_review_ui.d.ts +2 -0
  26. package/dist/agents/prompts/auto_review_ui.d.ts.map +1 -0
  27. package/dist/agents/prompts/auto_test.d.ts +2 -0
  28. package/dist/agents/prompts/auto_test.d.ts.map +1 -0
  29. package/dist/agents/prompts/auto_troubleshoot.d.ts +2 -0
  30. package/dist/agents/prompts/auto_troubleshoot.d.ts.map +1 -0
  31. package/dist/agents/prompts/design.d.ts +2 -0
  32. package/dist/agents/prompts/design.d.ts.map +1 -0
  33. package/dist/agents/prompts/document_agents.d.ts +2 -0
  34. package/dist/agents/prompts/document_agents.d.ts.map +1 -0
  35. package/dist/agents/prompts/document_code.d.ts +2 -0
  36. package/dist/agents/prompts/document_code.d.ts.map +1 -0
  37. package/dist/agents/prompts/document_conventions.d.ts +2 -0
  38. package/dist/agents/prompts/document_conventions.d.ts.map +1 -0
  39. package/dist/agents/prompts/document_install.d.ts +2 -0
  40. package/dist/agents/prompts/document_install.d.ts.map +1 -0
  41. package/dist/agents/prompts/document_prd.d.ts +2 -0
  42. package/dist/agents/prompts/document_prd.d.ts.map +1 -0
  43. package/dist/agents/prompts/document_ux.d.ts +2 -0
  44. package/dist/agents/prompts/document_ux.d.ts.map +1 -0
  45. package/dist/agents/prompts/execute_author.d.ts +2 -0
  46. package/dist/agents/prompts/execute_author.d.ts.map +1 -0
  47. package/dist/agents/prompts/execute_code.d.ts +2 -0
  48. package/dist/agents/prompts/execute_code.d.ts.map +1 -0
  49. package/dist/agents/prompts/execute_debug.d.ts +2 -0
  50. package/dist/agents/prompts/execute_debug.d.ts.map +1 -0
  51. package/dist/agents/prompts/execute_document.d.ts +2 -0
  52. package/dist/agents/prompts/execute_document.d.ts.map +1 -0
  53. package/dist/agents/prompts/execute_excel.d.ts +2 -0
  54. package/dist/agents/prompts/execute_excel.d.ts.map +1 -0
  55. package/dist/agents/prompts/execute_git_commit.d.ts +2 -0
  56. package/dist/agents/prompts/execute_git_commit.d.ts.map +1 -0
  57. package/dist/agents/prompts/execute_os.d.ts +2 -0
  58. package/dist/agents/prompts/execute_os.d.ts.map +1 -0
  59. package/dist/agents/prompts/execute_script.d.ts +2 -0
  60. package/dist/agents/prompts/execute_script.d.ts.map +1 -0
  61. package/dist/agents/prompts/query_architect.d.ts +2 -0
  62. package/dist/agents/prompts/query_architect.d.ts.map +1 -0
  63. package/dist/agents/prompts/query_browser.d.ts +2 -0
  64. package/dist/agents/prompts/query_browser.d.ts.map +1 -0
  65. package/dist/agents/prompts/query_code.d.ts +2 -0
  66. package/dist/agents/prompts/query_code.d.ts.map +1 -0
  67. package/dist/agents/prompts/query_db.d.ts +2 -0
  68. package/dist/agents/prompts/query_db.d.ts.map +1 -0
  69. package/dist/agents/prompts/query_excel.d.ts +2 -0
  70. package/dist/agents/prompts/query_excel.d.ts.map +1 -0
  71. package/dist/agents/prompts/query_git.d.ts +2 -0
  72. package/dist/agents/prompts/query_git.d.ts.map +1 -0
  73. package/dist/agents/prompts/query_os.d.ts +2 -0
  74. package/dist/agents/prompts/query_os.d.ts.map +1 -0
  75. package/dist/agents/prompts/query_text.d.ts +2 -0
  76. package/dist/agents/prompts/query_text.d.ts.map +1 -0
  77. package/dist/agents/prompts/query_web.d.ts +2 -0
  78. package/dist/agents/prompts/query_web.d.ts.map +1 -0
  79. package/dist/agents/prompts/research.d.ts +2 -0
  80. package/dist/agents/prompts/research.d.ts.map +1 -0
  81. package/dist/agents/prompts/temp_concept.d.ts +2 -0
  82. package/dist/agents/prompts/temp_concept.d.ts.map +1 -0
  83. package/dist/agents/prompts/temp_manual.d.ts +4 -0
  84. package/dist/agents/prompts/temp_manual.d.ts.map +1 -0
  85. package/dist/agents/prompts/temp_report.d.ts +2 -0
  86. package/dist/agents/prompts/temp_report.d.ts.map +1 -0
  87. package/dist/agents/rules/caveman.d.ts +2 -0
  88. package/dist/agents/rules/caveman.d.ts.map +1 -0
  89. package/dist/agents/rules/definitions.d.ts +2 -0
  90. package/dist/agents/rules/definitions.d.ts.map +1 -0
  91. package/dist/agents/rules/error.d.ts +2 -0
  92. package/dist/agents/rules/error.d.ts.map +1 -0
  93. package/dist/agents/rules/markdown.d.ts +2 -0
  94. package/dist/agents/rules/markdown.d.ts.map +1 -0
  95. package/dist/agents/rules/planner.d.ts +2 -0
  96. package/dist/agents/rules/planner.d.ts.map +1 -0
  97. package/dist/agents/rules/question.d.ts +2 -0
  98. package/dist/agents/rules/question.d.ts.map +1 -0
  99. package/dist/agents/rules/response.d.ts +2 -0
  100. package/dist/agents/rules/response.d.ts.map +1 -0
  101. package/dist/agents/rules/swap2assist.d.ts +2 -0
  102. package/dist/agents/rules/swap2assist.d.ts.map +1 -0
  103. package/dist/agents/rules/task.d.ts +2 -0
  104. package/dist/agents/rules/task.d.ts.map +1 -0
  105. package/dist/commands/index.d.ts +19 -0
  106. package/dist/commands/index.d.ts.map +1 -0
  107. package/dist/commands/index.test.d.ts +2 -0
  108. package/dist/commands/index.test.d.ts.map +1 -0
  109. package/dist/config.d.ts +29 -0
  110. package/dist/config.d.ts.map +1 -0
  111. package/dist/config.test.d.ts +2 -0
  112. package/dist/config.test.d.ts.map +1 -0
  113. package/dist/index.d.ts +2 -0
  114. package/dist/index.d.ts.map +1 -0
  115. package/dist/plugin.d.ts +4 -0
  116. package/dist/plugin.d.ts.map +1 -0
  117. package/dist/plugin.js +30676 -0
  118. package/dist/plugin.test.d.ts +2 -0
  119. package/dist/plugin.test.d.ts.map +1 -0
  120. package/dist/skills/author-article/SKILL.md +116 -0
  121. package/dist/skills/author-caveman/SKILL.md +18 -0
  122. package/dist/skills/author-readme/SKILL.md +199 -0
  123. package/dist/skills/author-rules/SKILL.md +182 -0
  124. package/dist/skills/author-skill/SKILL.md +78 -0
  125. package/dist/skills/author-tutorial/SKILL.md +24 -0
  126. package/dist/skills/code-java/SKILL.md +345 -0
  127. package/dist/skills/code-rest/SKILL.md +82 -0
  128. package/dist/skills/code-typescript/SKILL.md +453 -0
  129. package/dist/skills/execute-sandbox/SKILL.md +42 -0
  130. package/dist/skills/test-jest/SKILL.md +211 -0
  131. package/dist/skills/test-junit/SKILL.md +206 -0
  132. package/dist/skills/test-mockito/SKILL.md +209 -0
  133. package/dist/skills/test-vitest/SKILL.md +159 -0
  134. package/dist/tools/autocode_agent_swap.d.ts +13 -0
  135. package/dist/tools/autocode_agent_swap.d.ts.map +1 -0
  136. package/dist/tools/autocode_agent_swap.test.d.ts +2 -0
  137. package/dist/tools/autocode_agent_swap.test.d.ts.map +1 -0
  138. package/dist/tools/autocode_concept_create.d.ts +23 -0
  139. package/dist/tools/autocode_concept_create.d.ts.map +1 -0
  140. package/dist/tools/autocode_concept_list.d.ts +14 -0
  141. package/dist/tools/autocode_concept_list.d.ts.map +1 -0
  142. package/dist/tools/autocode_concept_read.d.ts +20 -0
  143. package/dist/tools/autocode_concept_read.d.ts.map +1 -0
  144. package/dist/tools/autocode_criteria.d.ts +52 -0
  145. package/dist/tools/autocode_criteria.d.ts.map +1 -0
  146. package/dist/tools/autocode_criteria.test.d.ts +2 -0
  147. package/dist/tools/autocode_criteria.test.d.ts.map +1 -0
  148. package/dist/tools/autocode_db.d.ts +80 -0
  149. package/dist/tools/autocode_db.d.ts.map +1 -0
  150. package/dist/tools/autocode_db.test.d.ts +2 -0
  151. package/dist/tools/autocode_db.test.d.ts.map +1 -0
  152. package/dist/tools/autocode_dependencies.d.ts +4 -0
  153. package/dist/tools/autocode_dependencies.d.ts.map +1 -0
  154. package/dist/tools/autocode_dependencies.test.d.ts +2 -0
  155. package/dist/tools/autocode_dependencies.test.d.ts.map +1 -0
  156. package/dist/tools/autocode_job_execute.d.ts +14 -0
  157. package/dist/tools/autocode_job_execute.d.ts.map +1 -0
  158. package/dist/tools/autocode_job_execute.test.d.ts +2 -0
  159. package/dist/tools/autocode_job_execute.test.d.ts.map +1 -0
  160. package/dist/tools/autocode_job_list.d.ts +23 -0
  161. package/dist/tools/autocode_job_list.d.ts.map +1 -0
  162. package/dist/tools/autocode_job_list.test.d.ts +3 -0
  163. package/dist/tools/autocode_job_list.test.d.ts.map +1 -0
  164. package/dist/tools/autocode_job_status.d.ts +5 -0
  165. package/dist/tools/autocode_job_status.d.ts.map +1 -0
  166. package/dist/tools/autocode_job_status.test.d.ts +2 -0
  167. package/dist/tools/autocode_job_status.test.d.ts.map +1 -0
  168. package/dist/tools/autocode_logo_find.d.ts +10 -0
  169. package/dist/tools/autocode_logo_find.d.ts.map +1 -0
  170. package/dist/tools/autocode_plan_read.d.ts +12 -0
  171. package/dist/tools/autocode_plan_read.d.ts.map +1 -0
  172. package/dist/tools/autocode_plan_save.d.ts +48 -0
  173. package/dist/tools/autocode_plan_save.d.ts.map +1 -0
  174. package/dist/tools/autocode_sandbox_cli.d.ts +23 -0
  175. package/dist/tools/autocode_sandbox_cli.d.ts.map +1 -0
  176. package/dist/tools/autocode_sandbox_create.d.ts +16 -0
  177. package/dist/tools/autocode_sandbox_create.d.ts.map +1 -0
  178. package/dist/tools/autocode_sandbox_delete.d.ts +12 -0
  179. package/dist/tools/autocode_sandbox_delete.d.ts.map +1 -0
  180. package/dist/tools/autocode_sandbox_file_tools.d.ts +9 -0
  181. package/dist/tools/autocode_sandbox_file_tools.d.ts.map +1 -0
  182. package/dist/tools/autocode_sandbox_tools.test.d.ts +2 -0
  183. package/dist/tools/autocode_sandbox_tools.test.d.ts.map +1 -0
  184. package/dist/tools/autocode_session_create.d.ts +13 -0
  185. package/dist/tools/autocode_session_create.d.ts.map +1 -0
  186. package/dist/tools/autocode_session_create.test.d.ts +2 -0
  187. package/dist/tools/autocode_session_create.test.d.ts.map +1 -0
  188. package/dist/tools/autocode_shelve.d.ts +5 -0
  189. package/dist/tools/autocode_shelve.d.ts.map +1 -0
  190. package/dist/tools/autocode_shelve.test.d.ts +2 -0
  191. package/dist/tools/autocode_shelve.test.d.ts.map +1 -0
  192. package/dist/tools/index.d.ts +324 -0
  193. package/dist/tools/index.d.ts.map +1 -0
  194. package/dist/tools/index.test.d.ts +2 -0
  195. package/dist/tools/index.test.d.ts.map +1 -0
  196. package/dist/tools/task_external.d.ts +35 -0
  197. package/dist/tools/task_external.d.ts.map +1 -0
  198. package/dist/tools/task_external.test.d.ts +2 -0
  199. package/dist/tools/task_external.test.d.ts.map +1 -0
  200. package/dist/tools/task_resume.d.ts +12 -0
  201. package/dist/tools/task_resume.d.ts.map +1 -0
  202. package/dist/tools/task_resume.test.d.ts +2 -0
  203. package/dist/tools/task_resume.test.d.ts.map +1 -0
  204. package/dist/tools/test_context.d.ts +5 -0
  205. package/dist/tools/test_context.d.ts.map +1 -0
  206. package/dist/utils/agent_swap.d.ts +56 -0
  207. package/dist/utils/agent_swap.d.ts.map +1 -0
  208. package/dist/utils/agent_swap.test.d.ts +2 -0
  209. package/dist/utils/agent_swap.test.d.ts.map +1 -0
  210. package/dist/utils/autocode_dependencies.d.ts +44 -0
  211. package/dist/utils/autocode_dependencies.d.ts.map +1 -0
  212. package/dist/utils/autocode_sandbox_helpers.d.ts +12 -0
  213. package/dist/utils/autocode_sandbox_helpers.d.ts.map +1 -0
  214. package/dist/utils/db.d.ts +82 -0
  215. package/dist/utils/db.d.ts.map +1 -0
  216. package/dist/utils/delegate.d.ts +3 -0
  217. package/dist/utils/delegate.d.ts.map +1 -0
  218. package/dist/utils/frontmatter.d.ts +3 -0
  219. package/dist/utils/frontmatter.d.ts.map +1 -0
  220. package/dist/utils/jobs.d.ts +210 -0
  221. package/dist/utils/jobs.d.ts.map +1 -0
  222. package/dist/utils/jobs.test.d.ts +2 -0
  223. package/dist/utils/jobs.test.d.ts.map +1 -0
  224. package/dist/utils/sandbox.d.ts +233 -0
  225. package/dist/utils/sandbox.d.ts.map +1 -0
  226. package/dist/utils/sandbox.test.d.ts +2 -0
  227. package/dist/utils/sandbox.test.d.ts.map +1 -0
  228. package/dist/utils/sandbox_file_tools.d.ts +34 -0
  229. package/dist/utils/sandbox_file_tools.d.ts.map +1 -0
  230. package/dist/utils/shelve.d.ts +33 -0
  231. package/dist/utils/shelve.d.ts.map +1 -0
  232. package/dist/utils/solution.d.ts +28 -0
  233. package/dist/utils/solution.d.ts.map +1 -0
  234. package/dist/utils/solution.test.d.ts +2 -0
  235. package/dist/utils/solution.test.d.ts.map +1 -0
  236. package/dist/utils/tool_permission.d.ts +2 -0
  237. package/dist/utils/tool_permission.d.ts.map +1 -0
  238. package/dist/utils/tools.d.ts +7 -0
  239. package/dist/utils/tools.d.ts.map +1 -0
  240. package/package.json +58 -0
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=plugin.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"plugin.test.d.ts","sourceRoot":"","sources":["../src/plugin.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,116 @@
1
+ ---
2
+ name: author-article
3
+ description: Use `author-article` to get Professional Article/Report Format when reviewing/writing user content as articles/reports.
4
+ ---
5
+
6
+ # Professional Article/Report Format
7
+
8
+ Follow these instructions before reviewing/writing professional articles/reports
9
+
10
+ ## Editorial Rules
11
+
12
+ - Use full human-readable sentences by default
13
+ - Reduce long sentences > 40 words to smaller sentences (except in quoted text)
14
+ - Fix spelling and grammar mistakes (except in quoted text)
15
+ - Use British English by default in articles (unless different language requested)
16
+ - Merge repetitions
17
+ - Group long sections of continuous sentences in paragraphs, each paragraph focus on 1 argument/point of message.
18
+ - A paragraph typically starts with a statement/fact, then contain sentences that explain this statement with examples.
19
+ - Ensure content of the article does not deviate from topic of mentioned in the introduction section
20
+ - Capitalize first letter of every word in titles, except short prepositions < 4 characters (in, on, at, to, by, of, up), conjunctions (and, but, for, or, not, so, yet), and articles (a, an, the).
21
+ - NEVER modify quoted text even if it contains errors
22
+ - NEVER change the meaning of the text, unless the user explicitly asked to do so
23
+
24
+ ## Style Rules
25
+
26
+ - Add an introduction (if missing): Introductions should make it clear what topic the article will explore without giving away the main argument or point of the article. The introduction should rather trigger the reader's curiosity and encourage them to read it. The introduction should not be offensive to any group or people with a strong view point against the article main argument.
27
+ - Write articles in third person
28
+ - Check if the author's tone appears arrogant, offensive, or divisive. Replace sarcasm or rhetorical questions with objective statements.
29
+ - Write content diplomatically so it does not offend any people group.
30
+ - Use a professional tone, but explain academic or technical words in basic layman terms so non-Christians can understand.
31
+ - Only allow statements like "I think", "We believe", "It's possible" if the author uses unproven opinions.
32
+ - Replace em-dashes (—) and en-dashes (–) by breaking sentences up into multiple short sentences with periods that flow into each other (except in quoted text).
33
+ - Replace only Old Testament bible verses that refer to `the Lord` (lowercase) with `the LORD` (ALL CAPS). New Testament bible verses may refer to `the Lord` (lowercase).
34
+ - Use basic English vocabulary or explain complex academical terminology so that a non-English speaker or layman can understand.
35
+ - The final conclusion should only summarize the main argument, point or purpose of the article without explanations and evidence. Each statement in conclusion should be backed by section in the main content with a Markdown link in the text to that section for further reading or evidence.
36
+
37
+ ## Credibility Rules
38
+
39
+ - Rephrase confusing explanations, contradictions or fallacies
40
+ - Clearly indicate what is facts vs what is opinions
41
+ - Check that bible verses are quoted correctly from the bible: If a bible verse is incorrectly quoted, fix the quote. If the correct bible verses was referenced by comparing the context/sentence in which the bible verse appear. For example `Jesus said love your enemies (Genesis 1:1)` is wrong because that is not what Genesis 1:1 says. In these cases, replace it with the correct scripture reference.
42
+ - Add additional evidence like bible scriptures or Markdown links in text to external websites to support the author's statements (if known sources are available)
43
+ - Remove contradictions against the author's own content
44
+ - The article should never contradict itself. Instead it should objectively list the different views of groups and let the reader decide which view he prefers.
45
+ - Check for reasoning errors or fallacies: Rephrase the author's arguments to communicate the intended message but without logical reasoning errors.
46
+ - When author make controversial statement: add typical critique (argument) and defense (counter-argument).
47
+ - Enhance weak arguments with evidence or rephrase if no evidence could be provided.
48
+ - If article links to external sites, check that sites exist and if not: Search for the site and fix link or remove it if not found.
49
+
50
+ ## Formatting Rules
51
+
52
+ - The first line (after frontmatter) is the article's main title and must be H1 header level. There should only be 1 H1 title.
53
+ - Keep H2 headers as short as possible, but still unique.
54
+ - Ensure logical header hierarchy (no skipped levels).
55
+ - Large sections (> 25 lines) should be subdivided into smaller subsections.
56
+ - Use numerical points if the article mentions a specific sequence or priority.
57
+ - Use bullet points only to list items.
58
+ - Convert `--` double hyphens in quoted text to em dashes.
59
+ - Quoted sources are formatted as `> Quoted text — Source`. Note that the em dash is wrapped with spaces on both sides. The source could be a bible verse, a name of another author or book, or a link to an external website.
60
+ - If quoted source is bible verse, then include bible book abbreviation (for example: `John 3:16 (ESV)`); otherwise omit book abbreviation for inline bible references.
61
+ - Correct bible verses of different books are separated by semicolons `;`, for example: `Genesis 1; Exodus 1:1; Leviticus 1`.
62
+ - Correct bible verses of the same book but different chapters are separated by a comma and a space `, ` for example `Genesis 1:1, 2:1, 3:1`.
63
+ - Correct bible verses of the same book and chapter are separated by a comma only `,` (without spaces) for example `Genesis 1:1-3,5-7,11,13`. If no colon `:` is included, you may assume the number refers to a verse of the previously stated chapter, for example `Genesis 1:1,3` means Genesis 1:1 and Genesis 1:3.
64
+
65
+ ## Markdown Rules
66
+
67
+ - Convert underscore headers `-------------` to hashed prefix headers `##`
68
+ - Content should be Markdown linter compliant
69
+ - Code samples must be displayed in md code blocks specifying the correct language attribute
70
+ - Add Markdown links in text to online websites or external md files in content if content was based on an external source
71
+ - Double spaces before EOL character are allowed as they indicate line breaks in Markdown
72
+ - Ensure that Markdown links within the same document to anchors/headers are valid.
73
+ - Fragments are preserved, for example `path/page.md#anchor`
74
+ - Images are co-located in the same directory as Markdown, unless they link to an external website
75
+ - Image naming: `{page}.{descriptor}.{ext}` (avoid duplication if the image has the same name as the page, for example `church.church.jpg`)
76
+ - Provide alt text for accessibility
77
+ - Use mermaid diagrams to explain complex relationships, integrations or architectures
78
+ - Strikethrough text as Markdown strikethrough: ~~strikethrough~~
79
+ - Inline math formulas as Markdown inline math: $E = mc^2$
80
+ - Block math formulas as Markdown block math: $$ ... $$
81
+ - Links to online sources as Markdown links: [source name](url)
82
+ - Public logos, icons, illustrations as Markdown images: ![alt text](url)
83
+
84
+ ## Layout Rules
85
+
86
+ Default md layout (unless different layout was requested):
87
+ ```
88
+ ---
89
+ description: [Description]
90
+ keywords: [Keywords]
91
+ ---
92
+
93
+ # [Title]
94
+
95
+ [Introduction]
96
+
97
+ ## [Content Sections]
98
+
99
+ ### [Optional Sub-Sections]
100
+
101
+ #### [Optional Sub-Sub-Sections...]
102
+
103
+ ## Conclusion
104
+
105
+ [Conclusion Content]
106
+ ```
107
+
108
+ - Conclusion should not repeat the problem, but summarize the solution to the problem mentioned in introduction
109
+ - Conclusion MUST contain Markdown links to anchors within the article where the solution was displayed in more detail (like a TOC in natural language)
110
+ - Prefer grouping instructions and examples together so that reader can follow instructions without jumping around in article
111
+
112
+ ## Frontmatter Rules
113
+
114
+ - By default add frontmatter to each article (unless user indicates otherwise).
115
+ - The article description will be used as a meta tag element that describes the page for SEO. Ensure that the description is search engine compliant and not longer than 160 characters. The description should compliment the introduction of the article by providing a brief description of which topic the article will explore without giving away the main argument or point of the article. The like the introduction, description should also be non-offensive to any group or view point. Description should not start with a verb, but rather a short intro explaining the problem the article address in such a way that it does not give away the solution but rather trigger curiosity to read further.
116
+ - Update the `keywords` field of the frontmatter with sensible csv keywords related to the main points of this article. Use unique keywords that would make this article stand out among other articles. Avoid using common or generic terms as keywords.
@@ -0,0 +1,18 @@
1
+ ---
2
+ name: author-caveman
3
+ description: Use `author-caveman` to write Caveman English.
4
+ ---
5
+
6
+ # Caveman English
7
+
8
+ Verbose English: "Sure! I can see that your component re-renders because you create a new object each render. Perhaps wrap it in useMemo."
9
+ Caveman English: "New obj each render. New ref = re-render. Wrap in useMemo."
10
+
11
+ Caveman English Rules:
12
+ - Cut pleasantries, filler, hedging, articles (a/an/the) when meaning stays clear
13
+ - Prefer short plain words. Keep exact technical terms.
14
+ - Use common abbreviations
15
+ - Fragments OK if cause/action stays clear
16
+ - Emoji only when it clarifies
17
+
18
+ You MUST write Caveman English except: multi-step steps instructions, SQL, errors, quotes, links, code, technical terms, values.
@@ -0,0 +1,199 @@
1
+ ---
2
+ name: author-readme
3
+ description: Use `author-readme` to get "README.md Format" when reviewing/writing or updating README.md files.
4
+ ---
5
+
6
+ # README.md Format
7
+
8
+ - README.md must be written for humans in professional, user-manual style natural language
9
+ - Use full sentences except diagrams and listing items like features
10
+ - Use British English by default (unless specified otherwise)
11
+ - Assume user has limited technical knowledge, but understand technical terminology (no need to explain basic technical terms like "docker", "compile", "proxy", etc.)
12
+ - Code examples must specify the correct language attribute for syntax highlighting
13
+ - Do not invent exact command output. If exact output is not known, describe the expected result in prose.
14
+ - Use only links that are present in the repository, existing README, package metadata, build files, or supplied documentation.
15
+ - Do not create links to internal files unless the file path is known.
16
+ - Prefer relative links for repository files.
17
+ - Mermaid diagrams must be high-level, readable, and syntactically valid.
18
+ - Prefer `flowchart TD` for integration and component diagrams.
19
+ - Use short node labels.
20
+ - Do not include secrets, environment-specific hostnames, or internal credentials in diagrams.
21
+ - Use one H1 heading only.
22
+ - Use sequential heading levels without skipping levels.
23
+ - Surround headings and fenced code blocks with blank lines.
24
+ - Specify a language for every fenced code block, for example `bash`, `json`, `yaml`, `sql`, `text`, or `mermaid`.
25
+ - Do not use trailing spaces.
26
+ - Use hyphens for unordered lists.
27
+
28
+ ## README.md Layout
29
+
30
+ ```markdown
31
+ <p align="center">[LOGO]</p>
32
+
33
+ <h1 align="center">[Project Name]</h1>
34
+
35
+ <h3 align="center">[HERO]</p>
36
+
37
+ [PURPOSE]
38
+
39
+ ---
40
+
41
+ ## Features
42
+
43
+ [FEATURES]
44
+
45
+ [INTEGRATION]
46
+
47
+ ## Installation
48
+
49
+ [PREREQUISITES]
50
+
51
+ [LOCAL SETUP STEPS]
52
+
53
+ [STARTUP STEPS]
54
+
55
+ ## Usage
56
+
57
+ [COMMON USAGE]
58
+
59
+ [TUTORIAL]
60
+
61
+ ## Configuration
62
+
63
+ [CONFIGURATION]
64
+
65
+ ## Development
66
+
67
+ [ARCHITECTURE]
68
+
69
+ [DEVELOPER NOTES]
70
+
71
+ ### Testing
72
+
73
+ [TESTING]
74
+
75
+ ### Deployment
76
+
77
+ [PACKAGING STEPS]
78
+
79
+ [DEPLOYMENT STEPS]
80
+
81
+ ## Terminology
82
+
83
+ [ACRONYMS]
84
+
85
+ [DEFINITIONS]
86
+
87
+ ```
88
+
89
+ Replace placeholders in README.md as follows:
90
+
91
+ - [LOGO]: Determine the logo as follow:
92
+ 1. Use `autocode_logo_find` tool to find a logo.
93
+ 2. If `autocode_logo_find` returns a logo path, replace [LOGO] with `<img src="{path to logo}" alt="Project Logo" height="128">`.
94
+ 3. If no logo was found, use an appropriate emoji to replace [LOGO] with `<span style="font-size: 96px; text-shadow: -3px -3px 0 #000, 3px -3px 0 #000, -3px 3px 0 #000, 3px 3px 0 #000, 0 -3px 0 #000, 0 3px 0 #000, -3px 0 0 #000, 3px 0 0 #000;">{emoji}</span>`.
95
+ - [Project Name]: Project name in a natural title format. If unknown: derive title from repo name
96
+ - [HERO]: Catching advertising title as follows:
97
+ - Summarize what project does in positive way like marketing advert
98
+ - Max 20 words
99
+ - No definitions in this section
100
+ - Use only common words, not project specific terminology (except for naming components)
101
+ - [PURPOSE]: Motivate why this project should exist as follows:
102
+ - Briefly describe problem it solves and solution/benefit of using this project
103
+ - Use marking style: Wording should encourage stakeholders to invest time to setup and use system
104
+ - Do not list any technical features, instead mention problems it solve (use cases)
105
+ - Max 80 words
106
+ - No definitions in this section
107
+ - Use only common words, not project specific terminology (except for naming components)
108
+ - [FEATURES]: Advertise core features in markdown bullets as follows:
109
+ - 1 feature per bullet
110
+ - Unique emoji per feature
111
+ - Max 40 words per feature
112
+ - No definitions in this section
113
+ - Use only common words, not project specific terminology (except for naming components)
114
+ - [INTEGRATION]: Explain how project integration with external systems (like miroservices):
115
+ - Title summarize how it integrations (max 7 words), like "REST Integration" or "Microservice Architecture"
116
+ - Include high-level Mermaid diagram of how it integrates
117
+ - Only include [INTEGRATION] section if this project does integrate with external systems
118
+ - [PREREQUISITES]: System requirements and dependencies needed before installation as follows:
119
+ - List prerequisites as bullet points: 1 per dependency
120
+ - Provide markdown links in text to online sources that provide guidance where to download or how to install dependency
121
+ - Only include [PREREQUISITES] if project does depend on other systems
122
+ - [LOCAL SETUP STEPS]: Commands and steps to set up the project locally as follows:
123
+ - Provide sequential steps
124
+ - Each step must include an example command/config/user action
125
+ - Each step must include an example response/output (if known)
126
+ - Provide minimal configuration/commands just to get a demo/basic version going
127
+ - Format examples with proper markdown block formatting where appropriate
128
+ - Only include [LOCAL SETUP STEPS] if project does require a setup
129
+ - [STARTUP STEPS]: Commands to start the project
130
+ - Provide sequential steps
131
+ - Each step must include an example command/config/user action
132
+ - Each step must include an example response/output (if known)
133
+ - Format examples with proper markdown block formatting where appropriate
134
+ - Explain different modes project support (for example development vs production mode)
135
+ - If startup modes are vastly different organize it in different sub-sections
136
+ - Only include [STARTUP STEPS] if project does require a server/service to start
137
+ - [COMMON USAGE]: Explain how to use system as follows:
138
+ - Provide primary commands (if applicable)
139
+ - Provide primary URLs (if applicable)
140
+ - Explain how user can navigate through application to reach primary features (if applicable)
141
+ - Include example input/output in markdown blocks/tables (if possible)
142
+ - ONLY include usage of feature that is currently available
143
+ - NEVER include deprecated/uninplemented/planned/future features
144
+ - [TUTORIAL]: Step-by-step guide for common user flows as per `author-tutorial` skill.
145
+ - [CONFIGURATION]: Explain every project specific configuration setting as follow:
146
+ - Provide tables of every custom config key/property/env var that project accepts with descriptions and default values and valid ranges or alternative enums
147
+ - NEVER include standard framework properties like Spring Boot/Angular/Nuxt configs or any standard OS env vars
148
+ - ONLY include known (proven) configuration (no guessing)
149
+ - Only include this section if project has custom configuration
150
+ - [ARCHITECTURE]: Explain how project fulfill its purpose describe in [PURPOSE] as follow:
151
+ - If project is full stack: Include high-level Mermaid diagram of how different components of project interact with each other
152
+ - If project contains complex event system: Include high-level Mermaid diagram of how events/data flow
153
+ - If project contains multiple pages of static web content: Include high-level Mermaid diagram of primary pages link to each other (sitemap)
154
+ - If project is library or monolithic application: Include high-level Mermaid diagram of primary internal components and how they relate to each other
155
+ - If project is CLI tool: Include high-level Mermaid diagram of how data typically flow through this tool: inputs -> processes -> outputs
156
+ - Project may solve more than 1 problem (multi-purpose project): In such case identify each primary goal, then for each goal:
157
+ - Write 1 paragraph per goal (max 200 words) how it solves that specific goal
158
+ - Include markdown links in text to core source files responsible for solution or where additional documentation could be found
159
+ - Omit this section is project architecture is unclear, empty or new (no guessing)
160
+ - [DEVELOPER NOTES]: Any special notes that developers of the project should be aware of like: Special commands to build project, common pitfalls, unusual file locations/config/commands required, quality standards, etc.
161
+ - May contain sub-sections (max 200 words per section)
162
+ - Must be human readable and may contain examples to explain intend
163
+ - Keep this section as lean as possible and AVOID REPEATING any info mentioned in other sections of this document
164
+ - Only include this optional section if you have important info to make developers aware of
165
+ - [TESTING]: Steps how to test local development quality as follow:
166
+ - Provide sequential steps
167
+ - Each step must include an example command/config/user action
168
+ - Each step must include an example response/output (if known)
169
+ - Format examples with proper markdown block formatting where appropriate
170
+ - Only include this section if project does contain tests
171
+ - [PACKAGING STEPS]: Steps to build/package for production as follows:
172
+ - Provide sequential steps
173
+ - Each step must include an example command/config/user action
174
+ - Each step must include an example response/output (if known)
175
+ - Format examples with proper markdown block formatting where appropriate
176
+ - Only contain this section if project needs packing for production deployment
177
+ - [DEPLOYMENT STEPS]: Steps to deploy to production as follows:
178
+ - Provide sequential steps
179
+ - Each step must include an example command/config/user action
180
+ - Each step must include an example response/output (if known)
181
+ - Format examples with proper markdown block formatting where appropriate
182
+ - If different deployment environments are supported (e.g. local vs docker): Organize in sub-sections
183
+ - Only include this section if production deployment is different from [LOCAL SETUP STEPS]
184
+
185
+ ## Rules for Updates
186
+ - If current README.md already follows this layout, only update outdated or missing sections
187
+ - If current README.md already exist, but in different format:
188
+ 1. Identify critical info to keep
189
+ 2. Reorganize original README.md according to this specification
190
+ 3. Verify that critical info is still included and in correct section
191
+ - Remove empty sections or sections with no factual content (no guessing or "coming soon" placeholders)
192
+ - Ensure all markdown links to internal project files or external sites are valid
193
+ - Updated/Remove outdated info (if detected)
194
+ - Avoid duplicated content (instead add markdown links in text that refers to previous sections of same content applies)
195
+ - First time non-standard acronym is used: include definition in round brackets (), for example: "It guard UST (User Security Tables) when configured."
196
+ - First time non-standard definition is used: include an INFO block below the paragraph where it was used to explain what it is in < 20 words.
197
+ - NEVER repeat definitions, only first occurrence.
198
+ - NEVER mention deprecated tools or configs
199
+ - Keep examples updated with current tools/APIs/configs
@@ -0,0 +1,182 @@
1
+ ---
2
+ name: author-rules
3
+ description: Use `author-rules` get Agent Rule Format when reviewing/writing agent prompts, commands or AGENTS.md
4
+ ---
5
+
6
+ # Agent Rule Format
7
+
8
+ When writing agent prompts, commands or AGENTS.md apply this layout:
9
+
10
+ ## Layout
11
+
12
+ Layout Template:
13
+
14
+ ```
15
+ # [TITLE]
16
+
17
+ [PURPOSE]
18
+
19
+ [USER REQUEST ANALYSIS]
20
+
21
+ [WORKFLOW]
22
+
23
+ [CONDITIONAL INSTRUCTIONS]
24
+
25
+ [USER CONTENT]
26
+
27
+ [RULES]
28
+ ```
29
+
30
+ Replace above [PLACEHOLDERS] in Layout Template with:
31
+
32
+ [TITLE]
33
+ - Unique description of rules file
34
+ - Must be < 7 words
35
+ - Type of rule file determine title:
36
+ - Agent prompt: [TITLE] = Agent role (e.g. "Java Coder")
37
+ - Skill: [TITLE] = What knowledge and/or ability agent should expect (e.g. "Spring Boot Applications")
38
+ - AGENTS.md: [TITLE] = Scope of instructions (e.g. Project name for root AGENTS.md "Autocode Plugin" or Package purpose for sub AGENTS.md like "Business Services")
39
+
40
+ [PURPOSE]
41
+ - Agent prompt + multiple AGENTS.md files + skill files will be concatenated into 1 system prompt which may confuse agent about when to apply which rules
42
+ - Solution: Define purpose for rule set such that agent understands when or how to apply rules
43
+ - Must be < 20 words
44
+ - Type of rule file determine title:
45
+ - Agent prompts: [PURPOSE] = High-level responsibilities of agent (e.g. "You write professional Java Code...")
46
+ - Skill: [PURPOSE] = Conditions when rules become relevant (e.g. "When designing Spring Boot Application...")
47
+ - AGENTS.md: [PURPOSE] = What content to find in scope AGENTS.md file covers: root AGENTS.md summarize purpose of entire project; sub AGENTS.md summarize purpose of sub-scope
48
+
49
+ [USER REQUEST ANALYSIS]
50
+ - Only include [USER REQUEST ANALYSIS] for agent prompts or commands
51
+ - Defining "user request":
52
+ - commands: "user request" = existing session context
53
+ - agent prompts: "user request" = user's original prompt
54
+
55
+ 1. This section must first indicate how to categorize each type of supported "user request" in < 20 words per category
56
+ 2. Then this section must map each category to workflow/conditional instructions and/or any special rules that may apply for that condition in < 40 words per category
57
+
58
+ - [USER REQUEST ANALYSIS] must also indicate how to handle unsupported "user requests" in < 20 words
59
+ - Omit [USER REQUEST ANALYSIS] section entirely if all user request should be treated the same
60
+
61
+ [CONDITIONAL INSTRUCTIONS]
62
+ - Conditional Instructions may be 1 or more primary sections
63
+ - Unlike Workflows that contain fixed sequential steps, conditional instructions apply ad-hoc based on conditions
64
+ - Typical examples:
65
+ - Interviewing User
66
+ - Handling Errors
67
+ - Presenting Report
68
+ - Each Conditional Instruction section must start with condition: when to apply instructions
69
+ - Numeric list of sequential instructions agent must follow
70
+ - Keep instructions concise but understandable in < 40 words per instruction
71
+ - Large (40+ lines) or complex [CONDITIONAL INSTRUCTIONS] should be moved to separate skills or references/ folders to be loaded ad-hoc
72
+
73
+ [USER CONTENT]
74
+ - Omit entire [USER CONTENT] section by default, unless user specified additional content
75
+ - Format content according to user request
76
+ - May span across multiple primary sections
77
+ - May include examples
78
+ - Preferably keep write content as concise bullet points (unless user specified different format)
79
+
80
+ [RULES]
81
+ - Must be section final in md file
82
+ - Only include very critical (dangerous consequence if not adhered - e.g. forbidden actions/limiting scope) rules or common rules that always applies (edge-cases belong in [CONDITIONAL INSTRUCTIONS] section)
83
+ - When rules contradict: Add conditions when each contradicting rule applies
84
+ - Must be < 40 words per rule (excluding conditions)
85
+
86
+ [WORKFLOW]
87
+ - Only include [WORKFLOW] section if rules contain sequential instructions (steps)
88
+ - It usually follows default happy path to accomplish specific purpose of agent
89
+ - ALWAYS omit entire [WORKFLOW] section for AGENTS.md (too general)
90
+
91
+ Workflow Template:
92
+
93
+ ```
94
+
95
+ ---
96
+
97
+ ## Workflow
98
+
99
+ [WORKFLOW TOC]
100
+
101
+ ### STEP 1: [STEP TITLE]
102
+
103
+ [STEP GOAL]
104
+
105
+ [STEP INSTRUCTIONS]
106
+
107
+ [STEP EXAMPLE]
108
+
109
+ ### Step 2...
110
+
111
+ ---
112
+
113
+ ```
114
+
115
+ Line dividers (`---`) helps to organize large Workflow with its steps together
116
+
117
+ Replace above [PLACEHOLDERS] in Workflow Template with:
118
+
119
+ [WORKFLOW TOC]
120
+ Include every step section's header without "STEP X: " prefixes in same order steps appear
121
+
122
+ For example:
123
+
124
+ ```md
125
+
126
+ ---
127
+
128
+ ## Workflow
129
+
130
+ 1. Analyze Problem
131
+ 2. Solve Problem
132
+ 3. Test Solution
133
+
134
+ ### STEP 1: Analyze Problem
135
+ ...
136
+
137
+ ### STEP 2: Solve Problem
138
+ ...
139
+
140
+ ### STEP 3: Test Solution
141
+ ...
142
+
143
+ ---
144
+
145
+ ```
146
+
147
+ [STEP GOAL]
148
+
149
+ Briefly describe goal of specific STEP in < 20 words
150
+
151
+ [STEP INSTRUCTIONS]
152
+
153
+ - Numeric list of sequential step instructions agent must follow
154
+ - Keep instructions concise but understandable in < 40 words per instruction
155
+
156
+ [STEP EXAMPLE]
157
+
158
+ - Only include examples for complex STEPS or specific templates
159
+ - User provided examples MUST be keep as-is (no stripping, reducing, formatting or any other modifications allowed)
160
+ - Keep generated examples minimalistic but understandable to limited LLM
161
+ - Generate max 1 good example per step (if no user example was provided)
162
+ - Generate only bad examples if common pitfalls are expected that should be avoided
163
+ - Never generate examples for obvious steps
164
+ - When writing skills: Extract large examples/templates (> 40 lines) to template files (located in `.agents/skills/{skill-name}/templates/`) with references to `templates/{template-file}` in original skill
165
+
166
+ ## Rules
167
+
168
+ - ALWAYS speak and write Caveman English
169
+ - Each point < 20 words
170
+ - No repetitions
171
+ - Only use emojis to highlight important aspects to LLM, like attention, warning, checklists, correct vs wrong
172
+ - Always keep md < 400 lines by:
173
+ - Cleaning up redundant content
174
+ - Removing excessive examples
175
+ - Only if skill's [USER CONTENT] section is > 200 lines:
176
+ 1. Divide content into smaller < 200 line sections
177
+ 2. Divided skills user content should not overlap
178
+ 3. Move subdivided content to reference files (located in `.agents/skills/{skill-name}/references/`)
179
+ 4. Refer to `reference/{reference-name}` references in original `SKILL.md` with instruction when load which reference
180
+ 5. Report list of skill files you created to user
181
+ - Otherwise summarize trivial info in [USER CONTENT] section
182
+ - As last resort: Reducing/grouping obvious instructions agent can derive by itself
@@ -0,0 +1,78 @@
1
+ ---
2
+ name: author-skill
3
+ description: Use `author-rules` to get Skill File Authoring when you need to review/write skill files for agents.
4
+ ---
5
+
6
+ # Skill File Authoring
7
+
8
+ Use this Skill Template to review/write skill files:
9
+
10
+ ---
11
+
12
+ ## Skill Template
13
+
14
+ Write skill Template:
15
+
16
+ ```markdown
17
+ ---
18
+ name: [NAME]
19
+ description: Use `[NAME]` to get [TOPIC] if [CONDITION].
20
+ ---
21
+
22
+ # [TOPIC]
23
+
24
+ [TRIGGERS]
25
+
26
+ ---
27
+
28
+ [CONTENT]
29
+
30
+ ---
31
+
32
+ [RULES]
33
+ ```
34
+
35
+ Replace above [PLACEHOLDERS] in Layout Template with:
36
+
37
+ * Replace [NAME] with short skill name as follows:
38
+ - 4 words max
39
+ - Prefix with `author-` for skill related to human readable content, articles
40
+ - Prefix with `code-` for skill related to project source code, configurations, scripts
41
+ - Prefix with `design-` for skill related to project designs (architecture)
42
+ * [TOPIC] with short topic in Caveman English as follows:
43
+ - Unique header summarizing topic skill addresses - What knowledge and/or ability agent should expect (e.g. "Deploying Spring Boot Applications")
44
+ - Must be < 7 words
45
+ - Use exact phrase and case consistently
46
+ * [TRIGGERS] with description of when topic is relevant (< 20 words) like "Understand how to build and package Spring Boot Application for production deployments, ..."
47
+ * [CONTENT] translate content from user request into Caveman English:
48
+ - Preferably format as structured sequence lists or bullet points
49
+ - May include formatted examples when applicable
50
+ - Prefer linking to templates, scripts, references, external sources instead of embedding verbose content to keep SKILL.md lean
51
+ * [RULES] important rules regarding agents behavior to apply skill:
52
+ - Optional: Only include if behavioral changes are required
53
+ - Must be last section SKILL.md
54
+ - Only include very critical instructions or limitations that always apply
55
+ - When rules contradict: Add conditions when each contradicting rule applies
56
+
57
+ ---
58
+
59
+ ## Rules
60
+
61
+ - ALWAYS write skill files in `.agents/skills/{name}/SKILL.md`
62
+ - Place templates, scripts, references in subdirectories from skill directory `.agents/skills/{name}/` and link to it from `SKILL.md`, for example: `templates/email_template.html`, `scripts/process_data.py`
63
+ - Keep templates, scripts, reference files also lean (only keep important info and valuable example snippets).
64
+ - No repetitions
65
+ - Only use emojis to highlight important aspects to LLM, like attention, warning, checklists, correct vs wrong
66
+ - ALWAYS keep md < 400 lines by:
67
+ - Cleaning up redundant content
68
+ - Removing excessive examples
69
+ - Summarize trivial info in [CONTENT] section
70
+ - Only if skill's [CONTENT] section is > 200 lines:
71
+ 1. Divide content into smaller < 200 line sections
72
+ 2. Divided skills user content should not overlap
73
+ 3. Move subdivided content to reference files (located in `.agents/skills/{name}/`) and link to it
74
+ - As last resort: Reducing/grouping obvious instructions agent can derive by itself
75
+
76
+ ___
77
+
78
+ Use this same skill text as an example on how to format other skills.
@@ -0,0 +1,24 @@
1
+ ---
2
+ name: author-tutorial
3
+ description: Use `author-tutorial` to get Tutorial Format when reviewing/writing tutorial or manual user step guide.
4
+ ---
5
+
6
+ # Tutorial Format
7
+
8
+ A tutorial guide a human user to complete an assignment manually.
9
+
10
+ 1. Determine goal of assignment (tutorial)
11
+ 2. Breakdown human assignment into practical steps.
12
+ 3. Each step must be formatted as a subsection of tutorial section and formatted as follows:
13
+ - Must include an example command/config/user action
14
+ - Must include an example response/output (if known)
15
+
16
+ ## Important Tutorial Rules
17
+
18
+ - Communicate to human: Full but concise sentences, first person as guide
19
+ - Tutorial Steps must be placed in correct sequential order
20
+ - Entire tutorial must be < 400 lines (remove trivial examples if necessary)
21
+ - Where user can decide on different workflow paths, format each workflow as different subsection
22
+ - Include warnings about common pitfalls
23
+ - Use emojis to highlight important info
24
+ - Start every step title with emoji