aiwf 0.1.0 → 0.3.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 (163) hide show
  1. package/CHANGELOG.md +46 -0
  2. package/CLAUDE.md +19 -0
  3. package/LICENSE +1 -1
  4. package/README.ko.md +90 -62
  5. package/README.md +109 -62
  6. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/01_PROJECT_DOCS/ARCHITECTURE.md +1 -1
  7. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/M01_milestone_meta.md +5 -1
  8. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/PRD_AMEND_01_Auth_Flow_Update.md +5 -1
  9. package/claude-code/{simone/.simone/03_SPRINTS/CLAUDE.MD → aiwf/en/.aiwf/03_SPRINTS/CLAUDE.md} +28 -7
  10. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/03_SPRINTS/S01_M01_Initial_API/S01_sprint_meta.md +8 -1
  11. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/03_SPRINTS/S01_M01_Initial_API/T01_S01_Setup_Project_Structure.md +5 -1
  12. package/claude-code/aiwf/en/.aiwf/04_GENERAL_TASKS/CLAUDE.md +96 -0
  13. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/04_GENERAL_TASKS/T002_API_Rate_Limiting.md +7 -2
  14. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/04_GENERAL_TASKS/TX001_Refactor_Logging_Module.md +7 -2
  15. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/05_ARCHITECTURAL_DECISIONS/ADR001_Chosen_Database_System.md +7 -1
  16. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/05_ARCHITECTURAL_DECISIONS/ADR002_API_Authentication_Method.md +7 -1
  17. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-needs-focus.md +139 -0
  18. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-test-alignment.md +155 -0
  19. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-13-00-50-solid-progress.md +122 -0
  20. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-14-08-30-infrastructure-challenges.md +141 -0
  21. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-16-21-48-critical-foundation-issues.md +177 -0
  22. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-17-15-08-solid-progress.md +149 -0
  23. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/index.json +5 -0
  24. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/sync-index.js +78 -0
  25. package/claude-code/aiwf/en/.aiwf/98_PROMPTS/github_integration.md +130 -0
  26. package/claude-code/aiwf/en/.aiwf/98_PROMPTS/useful-prompts.md +31 -0
  27. package/claude-code/aiwf/en/.aiwf/98_PROMPTS/vibe-front-prompts.md +89 -0
  28. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/task_template.md +1 -0
  29. package/claude-code/{simone/.simone/CLAUDE.MD → aiwf/en/.aiwf/CLAUDE.md} +13 -4
  30. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/README.md +6 -6
  31. package/claude-code/aiwf/en/.claude/CLAUDE_BE.md +276 -0
  32. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_changelog.md +82 -0
  33. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_code_review.md +88 -0
  34. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_commit.md +160 -0
  35. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_general_task.md +147 -0
  36. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_milestone_plan.md +194 -0
  37. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_prd.md +272 -0
  38. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_sprint_tasks.md +189 -0
  39. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_sprints_from_milestone.md +121 -0
  40. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_discuss_review.md +29 -0
  41. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_do_task.md +109 -0
  42. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_docs.md +225 -0
  43. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_infinite.md +202 -0
  44. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_initialize.md +134 -0
  45. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_issue_create.md +65 -0
  46. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_language_manager.md +287 -0
  47. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_language_status.md +246 -0
  48. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_mermaid.md +272 -0
  49. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_pr_create.md +76 -0
  50. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_prime.md +9 -0
  51. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_project_review.md +261 -0
  52. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_switch_language.md +160 -0
  53. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_test.md +125 -0
  54. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_testing_review.md +198 -0
  55. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_tm-run-all-subtask.md +206 -0
  56. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_ultrathink_code_advanced.md +460 -0
  57. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_ultrathink_code_basic.md +165 -0
  58. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_ultrathink_general.md +362 -0
  59. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_yolo.md +300 -0
  60. package/claude-code/aiwf/en/.claude/mcp.json +31 -0
  61. package/claude-code/aiwf/en/.claude/settings.json +102 -0
  62. package/claude-code/aiwf/ko/.aiwf/00_PROJECT_MANIFEST.md +49 -0
  63. package/claude-code/aiwf/ko/.aiwf/01_PROJECT_DOCS/ARCHITECTURE.md +55 -0
  64. package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/CLAUDE.md +78 -0
  65. package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/M01_milestone_meta.md +42 -0
  66. package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/PRD_AMEND_01_Auth_Flow_Update.md +73 -0
  67. package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/PRD_Backend_Setup.md +98 -0
  68. package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/SPECS_API_V1.md +232 -0
  69. package/claude-code/aiwf/ko/.aiwf/03_SPRINTS/CLAUDE.md +83 -0
  70. package/claude-code/aiwf/ko/.aiwf/03_SPRINTS/S01_M01_Initial_API/S01_sprint_meta.md +49 -0
  71. package/claude-code/aiwf/ko/.aiwf/03_SPRINTS/S01_M01_Initial_API/T01_S01_Setup_Project_Structure.md +60 -0
  72. package/claude-code/aiwf/ko/.aiwf/04_GENERAL_TASKS/CLAUDE.md +96 -0
  73. package/claude-code/aiwf/ko/.aiwf/04_GENERAL_TASKS/T002_API_Rate_Limiting.md +54 -0
  74. package/claude-code/aiwf/ko/.aiwf/04_GENERAL_TASKS/TX001_Refactor_Logging_Module.md +58 -0
  75. package/claude-code/aiwf/ko/.aiwf/05_ARCHITECTURAL_DECISIONS/ADR001_Chosen_Database_System.md +119 -0
  76. package/claude-code/aiwf/ko/.aiwf/05_ARCHITECTURAL_DECISIONS/ADR002_API_Authentication_Method.md +124 -0
  77. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-needs-focus.md +139 -0
  78. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-test-alignment.md +155 -0
  79. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-13-00-50-solid-progress.md +122 -0
  80. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-14-08-30-infrastructure-challenges.md +141 -0
  81. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-16-21-48-critical-foundation-issues.md +177 -0
  82. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-17-15-08-solid-progress.md +149 -0
  83. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/index.json +5 -0
  84. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/sync-index.js +78 -0
  85. package/claude-code/aiwf/ko/.aiwf/98_PROMPTS/github_integration.md +130 -0
  86. package/claude-code/aiwf/ko/.aiwf/98_PROMPTS/useful-prompts.md +31 -0
  87. package/claude-code/aiwf/ko/.aiwf/98_PROMPTS/vibe-front-prompts.md +89 -0
  88. package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/adr_template.md +49 -0
  89. package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/milestone_meta_template.md +25 -0
  90. package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/project_manifest_template.md +39 -0
  91. package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/sprint_meta_template.md +23 -0
  92. package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/task_template.md +36 -0
  93. package/claude-code/aiwf/ko/.aiwf/CLAUDE.md +76 -0
  94. package/claude-code/aiwf/ko/.aiwf/README.md +97 -0
  95. package/claude-code/aiwf/ko/.claude/CLAUDE_BE.md +276 -0
  96. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_changelog.md +82 -0
  97. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_code_review.md +88 -0
  98. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_commit.md +160 -0
  99. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_general_task.md +147 -0
  100. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_milestone_plan.md +194 -0
  101. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_prd.md +280 -0
  102. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_sprint_tasks.md +189 -0
  103. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_sprints_from_milestone.md +121 -0
  104. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_discuss_review.md +29 -0
  105. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_do_task.md +109 -0
  106. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_docs.md +225 -0
  107. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_infinite.md +202 -0
  108. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_initialize.md +134 -0
  109. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_issue_create.md +65 -0
  110. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_language_manager.md +287 -0
  111. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_language_status.md +246 -0
  112. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_mermaid.md +272 -0
  113. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_pr_create.md +76 -0
  114. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_prime.md +9 -0
  115. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_project_review.md +261 -0
  116. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_switch_language.md +160 -0
  117. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_test.md +124 -0
  118. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_testing_review.md +198 -0
  119. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_tm-run-all-subtask.md +210 -0
  120. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_ultrathink_code_advanced.md +460 -0
  121. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_ultrathink_code_basic.md +165 -0
  122. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_ultrathink_general.md +305 -0
  123. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_yolo.md +300 -0
  124. package/claude-code/aiwf/ko/.claude/mcp.json +31 -0
  125. package/claude-code/aiwf/ko/.claude/settings.json +102 -0
  126. package/{AI-WORKFLOW.md → docs/AI-WORKFLOW.ko.md} +38 -24
  127. package/docs/AI-WORKFLOW.md +299 -0
  128. package/docs/COMMANDS_GUIDE.ko.md +727 -0
  129. package/docs/COMMANDS_GUIDE.md +726 -0
  130. package/docs/CONTRIBUTING.md +406 -0
  131. package/docs/DEVELOPMENT_GUIDE.md +727 -0
  132. package/docs/Enhanced_Installation_Flow_Design.md +498 -0
  133. package/docs/PRD.ko.md +148 -0
  134. package/docs/PRD.md +150 -0
  135. package/docs/moonklabs-metadata-system-prd.md +127 -0
  136. package/index.js +1493 -122
  137. package/jest.config.js +4 -0
  138. package/language-cli.js +279 -0
  139. package/language-utils.js +330 -0
  140. package/package.json +23 -10
  141. package/scripts/validate-commands.cjs +338 -0
  142. package/scripts/validate-commands.js +254 -0
  143. package/tests/basic.test.js +62 -0
  144. package/tests/commands.test.js +127 -0
  145. package/tests/installer.test.js +129 -0
  146. package/tests/language-utils.test.js +271 -0
  147. package/COMMANDS_GUIDE.md +0 -462
  148. package/PRD.ko.md +0 -96
  149. package/PRD.md +0 -98
  150. package/claude-code/simone/.simone/04_GENERAL_TASKS/CLAUDE.MD +0 -51
  151. package/claude-code/simone/CHANGELOG.md +0 -71
  152. package/claude-code/simone/LICENSE +0 -21
  153. package/claude-code/simone/README.md +0 -219
  154. package/claude-code/simone/SYNC_GUIDE.md +0 -172
  155. package/claude-code/simone/sync-simone.sh +0 -138
  156. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/00_PROJECT_MANIFEST.md +0 -0
  157. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/CLAUDE.md +0 -0
  158. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/PRD_Backend_Setup.md +0 -0
  159. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/SPECS_API_V1.md +0 -0
  160. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/adr_template.md +0 -0
  161. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/milestone_meta_template.md +0 -0
  162. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/project_manifest_template.md +0 -0
  163. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/sprint_meta_template.md +0 -0
@@ -1,71 +0,0 @@
1
- # Changelog
2
-
3
- ## 2025-05-30
4
-
5
- ### Added
6
-
7
- - `npx hello-simone` quick start command for easy Simone installation
8
- - Interactive, adaptive initialize command that:
9
- - Auto-detects project type and framework
10
- - Guides users through conversational setup
11
- - Creates documentation through Q&A process
12
- - Adapts to existing vs new projects
13
-
14
- ### Changed
15
-
16
- - initialize command completely rewritten for better user experience
17
- - Removed complex branching logic in favor of adaptive process
18
- - Focus on conversational interaction rather than rigid steps
19
-
20
- ### Improved
21
-
22
- - Better handling of existing documentation during setup
23
- - Smart project detection (Node.js, Python, PHP, etc.)
24
- - Milestone creation now interactive and context-aware
25
-
26
- ## 2025-05-29
27
-
28
- ### Added
29
-
30
- - ADR template for architecture decision records
31
- - Task ID filtering in commit command (T01_S02, TX003 patterns)
32
- - YOLO mode in commit command to skip user approval
33
- - Code review results now write to task Output Log sections
34
- - create_general_task command for structured task creation
35
- - create_sprint_tasks command for detailed sprint planning
36
- - create_sprints_from_milestone command for milestone-based sprint planning
37
- - prime command for quick project context loading
38
- - yolo command for autonomous task execution without user interaction
39
-
40
- ### Changed
41
-
42
- - Date format simplified to YYYY-MM-DD HH:MM in templates
43
- - Milestone template heading structure updated
44
- - do_task command now uses parallel subagents and updates project manifest
45
- - project_review command removes timeline pressure and focuses on current state
46
-
47
- ### Removed
48
-
49
- - create_sprint, create_task, plan_milestone commands (replaced by new workflow)
50
-
51
- ## Developer Notes
52
-
53
- This update represents a significant evolution based on real-world usage and user feedback. The command architecture has been substantially enhanced with better use of parallel agents, loops, and conditionals, which work surprisingly well in practice.
54
-
55
- **Command Complexity**: The enhanced commands may behave differently between Claude Opus and Sonnet models. While the complexity might be challenging for Sonnet, testing suggests it should handle the workflows effectively.
56
-
57
- **Task Quality Improvements**: The new `create_sprint_tasks` and `create_general_task` commands now provide much better context and codebase references, resulting in notably higher quality task generation with specific implementation guidance.
58
-
59
- **YOLO Mode Warning**: The standalone `yolo` command requires extreme caution. It should only be used:
60
-
61
- - Within isolated development environments
62
- - With Claude Code's permission-skipping mode enabled (`claude --dangerously-skip-permissions`)
63
- - Never on production systems or systems with important data
64
-
65
- The YOLO mode can potentially modify or delete files outside your project directory. Use at your own risk and only in completely isolated environments.
66
-
67
- **Feedback Welcome**: Submit issues or pull requests on GitHub. This framework continues to evolve based on real-world usage patterns.
68
-
69
- ## 2025-05-23
70
-
71
- Initial release of Simone framework
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2025 moonklabs
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
@@ -1,219 +0,0 @@
1
- # Simone for Claude Code
2
-
3
- ## What is this?
4
-
5
- Simone is a directory-based project management system I built to work better with Claude Code. It's basically a set of folders, markdown files, and custom commands that help break down software projects into manageable chunks that AI can handle effectively.
6
-
7
- **⚠️ Complexity Warning**: Simone is a sophisticated system that requires time to understand properly. It's not a simple plug-and-play solution, but rather a framework that works best when you take the time to learn how it operates and adapt it to your workflow.
8
-
9
- **📋 Latest Updates**: See [CHANGELOG.md](CHANGELOG.md) for recent changes and improvements.
10
-
11
- ## How to Get Started
12
-
13
- ### 1. Install Simone
14
-
15
- ```bash
16
- npx hello-simone
17
- ```
18
-
19
- This sets up the folder structure and installs/updates the command files in your project. Can also be used to update an existing installation - command files get backed up automatically.
20
-
21
- ### 2. Initialize Your Project
22
-
23
- Open your project in Claude Code and run:
24
-
25
- ```
26
- /project:simone:initialize
27
- ```
28
-
29
- This guides you through the basic setup process. Works with new or existing codebases, and can help you create project documentation (PRDs, architecture docs) or work with documents you already have.
30
-
31
- ### 3. Set Up Your First Milestone
32
-
33
- Create a milestone folder in `.simone/02_REQUIREMENTS/` named `M01_Your_Milestone_Name` (e.g., `M01_Basic_Application`). Include at least:
34
-
35
- - `M01_PRD.md` - Product requirements document
36
- - Other specs as needed: `M01_Database_Schema.md`, `M01_API_Specs.md`, etc.
37
-
38
- *Note: There's no command for this yet. Use the existing chat from step 2 to guide Claude through milestone creation, ensuring proper naming with the `M##_` prefix and underscores.*
39
-
40
- ### 4. Break Down into Sprints
41
-
42
- ```
43
- /project:simone:create_sprints_from_milestone
44
- ```
45
-
46
- This analyzes your milestone and breaks it down into logical sprints. It looks at the entire scope and creates meaningful sprint boundaries without detailed tasks yet.
47
-
48
- ### 5. Create Your First Tasks
49
-
50
- ```
51
- /project:simone:create_sprint_tasks
52
- ```
53
-
54
- This analyzes your sprints, reviews documentation, researches necessary information, and identifies knowledge gaps to gain comprehensive understanding of your project. Creates detailed, actionable tasks for the current sprint.
55
-
56
- *Important: Only create tasks for your next sprint, not all sprints upfront. After completing Sprint 1, then create tasks for Sprint 2. This ensures the system can reference your existing codebase and incorporate completed work into future task creation.*
57
-
58
- ### 6. Start Working
59
-
60
- ```
61
- /project:simone:do_task
62
- ```
63
-
64
- This will automatically pick a task from your general tasks or sprints. For faster execution, specify a task ID:
65
-
66
- ```
67
- /project:simone:do_task T01_S01
68
- ```
69
-
70
- Claude will then work through the specified task with full project context.
71
-
72
- That's the basic workflow to get started! You can also:
73
-
74
- - Create general tasks with `/project:simone:create_general_task`
75
- - Use YOLO mode to run a full sprint autonomously
76
- - Explore other commands in `.claude/commands/simone/`
77
-
78
- **Important**: Simone is a complex system, not a simple set-and-forget tool. It works best when you understand how it operates. Take time to read through the commands and consider adapting them to your workflow.
79
-
80
- ## How it Works
81
-
82
- Simone organizes your project into:
83
-
84
- - **Milestones**: Major features or project phases
85
- - **Sprints**: Groups of related tasks within a milestone
86
- - **Tasks**: Individual work items scoped for one Claude session
87
-
88
- Each task gets full project context so Claude knows exactly what to build and how it fits into your architecture.
89
-
90
- ## Why I built this
91
-
92
- AI coding tools have become incredibly powerful, but they all face the same fundamental challenge: context management. The context window is limited in size, and we have little control over what stays in context and what doesn't.
93
-
94
- The problem with long-running sessions is context decay - as you work, critical project knowledge silently falls off the end of the context window. You don't know what's been forgotten until something goes wrong.
95
-
96
- My solution: Start fresh for each task, but provide rich surrounding context. By keeping tasks focused and well-scoped, I can dedicate more of the context window to relevant project knowledge, requirements, and architectural decisions. This way:
97
-
98
- - Each task starts with exactly the project context it needs
99
- - No critical knowledge gets lost in long sessions
100
- - Claude can work confidently with full awareness of requirements
101
- - The surrounding context guides development, not just the task description
102
-
103
- The result is a task-based workflow where Claude always has the right context for the job at hand.
104
-
105
- ## Key Components
106
-
107
- ### 00_PROJECT_MANIFEST.md
108
-
109
- The central document containing the project's vision, goals, and high-level overview. It serves as the starting point for Claude to understand the project. **Important**: The manifest file must be named exactly `00_PROJECT_MANIFEST.md`, not `MANIFEST.md`.
110
-
111
- ### 01_PROJECT_DOCS/
112
-
113
- Contains general project documentation including technical specifications, user guides, and API documentation that Claude can reference.
114
-
115
- ### 02_REQUIREMENTS/
116
-
117
- Organized by milestones, this directory stores product requirements documents (PRDs) and their amendments, providing a clear view of what needs to be built. This helps Claude understand the project requirements. Milestone folders must follow the naming convention `M##_Milestone_Name/` (e.g., `M01_Backend_Setup/`).
118
-
119
- ### 03_SPRINTS/
120
-
121
- Contains sprint plans and task definitions organized by milestone and sprint sequence. Each sprint folder contains individual task files with detailed information for Claude to work on.
122
-
123
- ### 04_GENERAL_TASKS/
124
-
125
- Stores task definitions for work not tied to a specific sprint. Completed tasks use a `TX` prefix (e.g., `TX001_Completed_Task.md`), making it easy for Claude to identify what's been done.
126
-
127
- ### 05_ARCHITECTURAL_DECISIONS/
128
-
129
- Captures significant architectural decisions as Architecture Decision Records (ADRs), documenting the context, options considered, and rationale. This provides critical context for Claude when making technical decisions. Uses a structured ADR template for consistency.
130
-
131
- ### 10_STATE_OF_PROJECT/
132
-
133
- Contains timestamped project review snapshots created by the `project_review` command. These provide a historical record of project health, technical decisions, and progress over time.
134
-
135
- ### 99_TEMPLATES/
136
-
137
- Contains standardized templates for different document types to ensure consistency for both humans and Claude:
138
-
139
- - Task templates with structured objectives and acceptance criteria
140
- - Sprint and milestone metadata templates
141
- - ADR template for documenting architectural decisions
142
- - All templates use simplified date formats (YYYY-MM-DD HH:MM)
143
-
144
- ### .claude/commands/simone/
145
-
146
- Custom Claude Code commands that power the Simone workflow:
147
-
148
- - `initialize` - Set up project structure and documentation
149
- - `create_sprints_from_milestone` - Break milestones into logical sprints
150
- - `create_sprint_tasks` - Generate detailed tasks from sprint plans
151
- - `do_task` - Execute individual tasks with full context
152
- - `yolo` - Autonomous sprint execution (use with caution)
153
- - And many more for testing, reviewing, and project management
154
-
155
- ## Directory Structure
156
-
157
- ```plaintext
158
- .simone/
159
- ├── 00_PROJECT_MANIFEST.md
160
- ├── 01_PROJECT_DOCS/
161
- ├── 02_REQUIREMENTS/
162
- │ ├── M01_Backend_Setup/
163
- │ ├── M02_Frontend_Setup/
164
- │ └── ...
165
- ├── 03_SPRINTS/
166
- │ ├── S01_M01_Initial_API/
167
- │ ├── S02_M01_Database_Schema/
168
- │ └── ...
169
- ├── 04_GENERAL_TASKS/
170
- │ ├── TX001_Refactor_Logging_Module.md # Completed task
171
- │ ├── T002_API_Rate_Limiting.md # Open task
172
- │ └── ...
173
- ├── 05_ARCHITECTURE_DECISIONS/
174
- │ ├── ADR001_Database_Selection.md
175
- │ └── ...
176
- ├── 10_STATE_OF_PROJECT/ # Project review snapshots
177
- └── 99_TEMPLATES/
178
- ├── task_template.md
179
- ├── sprint_meta_template.md
180
- └── milestone_meta_template.md
181
- ```
182
-
183
- ## Configuration Tips
184
-
185
- ### Enabling Parallel Task Execution
186
-
187
- While Simone commands like `create_sprint_tasks` support the `useParallelSubagents` instruction, Claude Code needs to be configured to actually execute tasks in parallel. By default, it only runs one task at a time.
188
-
189
- To enable parallel execution:
190
-
191
- ```bash
192
- # Set the number of parallel tasks (example: 3)
193
- claude config set --global "parallelTasksCount" 3
194
-
195
- # Check your current configuration
196
- claude config list -g
197
- ```
198
-
199
- **Important considerations:**
200
-
201
- - Choose the number based on your system's capabilities and rate limits
202
- - Parallel execution increases API usage significantly
203
- - Some tasks may have conflicts when run in parallel
204
- - Start with a small number (2-3) and adjust based on your experience
205
-
206
- ## Contributing & Feedback
207
-
208
- I'd love to hear from you! This is very much shaped by how I work, and I'm sure there are tons of improvements to be made.
209
-
210
- - **GitHub Issues**: Best place for bugs and feature requests
211
- - **Anthropic Discord**: Find me @helmi if you want to chat about it
212
- - **Pull Requests**: Very welcome! Let's make this better together
213
-
214
- I'm particularly interested in:
215
-
216
- - How you're using it differently
217
- - What's missing for your workflow
218
- - Ideas for better Claude Code integration
219
- - Different organizational approaches
@@ -1,172 +0,0 @@
1
- # Simone Framework Sync Guide
2
-
3
- ## Overview
4
-
5
- This guide explains how to sync Simone framework updates from development projects (like Synapsa) back to the canonical `claude-simone` repository.
6
-
7
- **Important**: This is a ONE-WAY sync process. Framework improvements flow from active development projects → claude-simone, not the other way around.
8
-
9
- ## Current Development Context
10
-
11
- - **Primary Development**: Happens in Synapsa project
12
- - **Framework Evolution**: New commands, templates, and improvements are tested in real use
13
- - **Sync Direction**: Synapsa → claude-simone (when improvements are stable)
14
- - **Manual Review**: Each sync should be carefully reviewed, not automated
15
-
16
- ## What to Consider When Syncing
17
-
18
- Before syncing, ask yourself:
19
- 1. Is this change Synapsa-specific or would it benefit all Simone users?
20
- 2. Has this been tested enough in real use?
21
- 3. Will this break existing workflows?
22
- 4. Is the change documented clearly?
23
-
24
- ## What Gets Synced
25
-
26
- ### Framework Core (Always Sync)
27
- ```
28
- /.claude/commands/simone/ # All command definitions
29
- /.simone/99_TEMPLATES/ # All templates
30
- /.simone/CLAUDE.MD # Framework instructions
31
- /.simone/README.md # Framework documentation
32
- ```
33
-
34
- ### Framework Structure (Sync Structure Only)
35
- ```
36
- /.simone/10_STATE_OF_PROJECT/ # Directory only, not contents
37
- ```
38
-
39
- ### Project-Specific (Never Sync)
40
- ```
41
- /.simone/00_PROJECT_MANIFEST.md
42
- /.simone/01_PROJECT_DOCS/*
43
- /.simone/02_REQUIREMENTS/*
44
- /.simone/03_SPRINTS/*
45
- /.simone/04_GENERAL_TASKS/*
46
- /.simone/05_ARCHITECTURAL_DECISIONS/*
47
- /.simone/10_STATE_OF_PROJECT/* (contents)
48
- ```
49
-
50
- ## Manual Sync Process (Synapsa → claude-simone)
51
-
52
- 1. **Identify What Changed**
53
- ```bash
54
- # From claude-simone directory
55
- # Compare commands
56
- diff -r ./.claude/commands/simone/ ~/code/synapsa/.claude/commands/simone/
57
-
58
- # Compare templates
59
- diff -r ./.simone/99_TEMPLATES/ ~/code/synapsa/.simone/99_TEMPLATES/
60
-
61
- # Check for new structural elements
62
- ls -la ~/code/synapsa/.simone/
63
- ```
64
-
65
- 2. **Review Each Change Carefully**
66
- - Read through command changes - are they improvements or project-specific?
67
- - Check template modifications - are they more generic or more specific?
68
- - Look for new directories or conventions
69
-
70
- 3. **Selective Manual Copy**
71
- - Copy only framework improvements
72
- - Leave out Synapsa-specific adaptations
73
- - Preserve generic examples in claude-simone
74
-
75
- 4. **Test in claude-simone Context**
76
- - Ensure examples still make sense
77
- - Verify commands work with generic project structure
78
- - Check that documentation is project-agnostic
79
-
80
- 5. **Document Changes for Users**
81
- - Update README.md with new features or changes
82
- - Add usage examples for new commands
83
- - Note any breaking changes or migration needs
84
- - Consider creating a CHANGELOG.md for version history
85
-
86
- 6. **Prepare for GitHub Push**
87
- - Review all documentation for clarity
88
- - Ensure examples are helpful and generic
89
- - Check that getting started instructions still work
90
- - Commit with clear message about what's new
91
-
92
- ## Sync Decision Tree
93
-
94
- ```
95
- Is it a command file? → YES → Sync it
96
- ↓ NO
97
- Is it a template? → YES → Sync it
98
- ↓ NO
99
- Is it CLAUDE.MD or README.md in .simone/? → YES → Sync it
100
- ↓ NO
101
- Is it a new directory structure? → YES → Create directory only
102
- ↓ NO
103
- Don't sync (project-specific content)
104
- ```
105
-
106
- ## Handling Conflicts
107
-
108
- ### Command Updates
109
- - New commands: Add directly
110
- - Modified commands: Review changes, ensure compatibility
111
- - Removed commands: Keep if still used in project
112
-
113
- ### Template Changes
114
- - Always take latest version from claude-simone
115
- - Templates should be generic enough for all projects
116
-
117
- ### Structure Changes
118
- - New directories: Add to all projects
119
- - Directory renames: Carefully migrate with content preservation
120
-
121
- ## Best Practices
122
-
123
- 1. **Regular Syncs**: Sync framework updates monthly or when new features are announced
124
- 2. **Test After Sync**: Run a few commands to ensure everything works
125
- 3. **Document Custom Changes**: If you modify framework files, document why
126
- 4. **Contribute Back**: If you improve templates or commands, PR to claude-simone
127
-
128
- ## Example: Syncing to Synapsa
129
-
130
- ```bash
131
- # From synapsa directory
132
- cd ~/code/synapsa
133
-
134
- # Dry run first
135
- rsync -av --dry-run \
136
- --include='/.claude/commands/simone/***' \
137
- --include='/.simone/99_TEMPLATES/***' \
138
- --include='/.simone/CLAUDE.MD' \
139
- --include='/.simone/README.md' \
140
- --exclude='/*' \
141
- ~/code/claude-simone/ ./
142
-
143
- # If looks good, run without --dry-run
144
- rsync -av \
145
- --include='/.claude/commands/simone/***' \
146
- --include='/.simone/99_TEMPLATES/***' \
147
- --include='/.simone/CLAUDE.MD' \
148
- --include='/.simone/README.md' \
149
- --exclude='/*' \
150
- ~/code/claude-simone/ ./
151
-
152
- # Create any new directories
153
- mkdir -p .simone/10_STATE_OF_PROJECT
154
- ```
155
-
156
- ## Troubleshooting
157
-
158
- ### Missing Directories
159
- Create them manually: `mkdir -p .simone/10_STATE_OF_PROJECT`
160
-
161
- ### Command Not Working
162
- Check if it depends on new directory structures or conventions
163
-
164
- ### Merge Conflicts
165
- Always prefer claude-simone version for framework files
166
-
167
- ## Future Improvements
168
-
169
- - [ ] Automated sync script with safety checks
170
- - [ ] Version tracking for framework components
171
- - [ ] Compatibility matrix for different Simone versions
172
- - [ ] Migration guides for breaking changes
@@ -1,138 +0,0 @@
1
- #!/bin/bash
2
- # Simone Framework Sync Script
3
- #
4
- # NOTE: This script is kept for reference but should be used with extreme caution.
5
- # The primary sync flow is: Active Development (Synapsa) → claude-simone
6
- # Not the other way around. Manual review is strongly recommended over automated sync.
7
- #
8
- # Original purpose: Syncs framework components from claude-simone to a project
9
- # Current reality: Development happens in Synapsa, syncs back to claude-simone
10
-
11
- set -e
12
-
13
- # Colors for output
14
- RED='\033[0;31m'
15
- GREEN='\033[0;32m'
16
- YELLOW='\033[1;33m'
17
- NC='\033[0m' # No Color
18
-
19
- # Default source path (can be overridden)
20
- SOURCE_PATH="${SIMONE_SOURCE:-$HOME/code/claude-simone}"
21
- TARGET_PATH="."
22
-
23
- # Usage
24
- usage() {
25
- echo "Usage: $0 [options]"
26
- echo "Options:"
27
- echo " -s, --source PATH Source claude-simone path (default: $SOURCE_PATH)"
28
- echo " -t, --target PATH Target project path (default: current directory)"
29
- echo " -d, --dry-run Show what would be synced without doing it"
30
- echo " -h, --help Show this help message"
31
- exit 1
32
- }
33
-
34
- # Parse arguments
35
- DRY_RUN=""
36
- while [[ $# -gt 0 ]]; do
37
- case $1 in
38
- -s|--source)
39
- SOURCE_PATH="$2"
40
- shift 2
41
- ;;
42
- -t|--target)
43
- TARGET_PATH="$2"
44
- shift 2
45
- ;;
46
- -d|--dry-run)
47
- DRY_RUN="--dry-run"
48
- shift
49
- ;;
50
- -h|--help)
51
- usage
52
- ;;
53
- *)
54
- echo "Unknown option: $1"
55
- usage
56
- ;;
57
- esac
58
- done
59
-
60
- # Verify source exists
61
- if [ ! -d "$SOURCE_PATH/.simone" ]; then
62
- echo -e "${RED}Error: Source path doesn't appear to be a claude-simone repository${NC}"
63
- echo "Path: $SOURCE_PATH"
64
- exit 1
65
- fi
66
-
67
- # Verify target exists
68
- if [ ! -d "$TARGET_PATH/.simone" ]; then
69
- echo -e "${RED}Error: Target path doesn't appear to have Simone installed${NC}"
70
- echo "Path: $TARGET_PATH"
71
- exit 1
72
- fi
73
-
74
- # Show what we're doing
75
- echo -e "${GREEN}Simone Framework Sync${NC}"
76
- echo "Source: $SOURCE_PATH"
77
- echo "Target: $TARGET_PATH"
78
- if [ -n "$DRY_RUN" ]; then
79
- echo -e "${YELLOW}DRY RUN MODE - No changes will be made${NC}"
80
- fi
81
- echo ""
82
-
83
- # Function to sync a component
84
- sync_component() {
85
- local component=$1
86
- local description=$2
87
-
88
- echo -e "${GREEN}Syncing $description...${NC}"
89
-
90
- # Build rsync command
91
- if [[ "$component" == *"***" ]]; then
92
- # It's a directory with contents
93
- rsync -av $DRY_RUN \
94
- --include="$component" \
95
- --exclude='/*' \
96
- "$SOURCE_PATH/" "$TARGET_PATH/"
97
- else
98
- # It's a single file
99
- rsync -av $DRY_RUN \
100
- "$SOURCE_PATH/$component" "$TARGET_PATH/$component"
101
- fi
102
- }
103
-
104
- # Sync commands
105
- sync_component "/.claude/commands/simone/***" "Claude commands"
106
-
107
- # Sync templates
108
- sync_component "/.simone/99_TEMPLATES/***" "Project templates"
109
-
110
- # Sync framework docs
111
- echo -e "${GREEN}Syncing framework documentation...${NC}"
112
- rsync -av $DRY_RUN \
113
- "$SOURCE_PATH/.simone/CLAUDE.MD" \
114
- "$SOURCE_PATH/.simone/README.md" \
115
- "$TARGET_PATH/.simone/"
116
-
117
- # Create new directories if needed
118
- echo -e "${GREEN}Ensuring directory structure...${NC}"
119
- if [ -z "$DRY_RUN" ]; then
120
- mkdir -p "$TARGET_PATH/.simone/10_STATE_OF_PROJECT"
121
- echo "Created: .simone/10_STATE_OF_PROJECT/"
122
- else
123
- echo "Would create: .simone/10_STATE_OF_PROJECT/"
124
- fi
125
-
126
- # Summary
127
- echo ""
128
- echo -e "${GREEN}Sync complete!${NC}"
129
- if [ -n "$DRY_RUN" ]; then
130
- echo -e "${YELLOW}This was a dry run. Run without -d to apply changes.${NC}"
131
- else
132
- echo "Framework components have been updated."
133
- echo ""
134
- echo "Next steps:"
135
- echo "1. Test a few commands to ensure everything works"
136
- echo "2. Review SYNC_GUIDE.md for any manual steps"
137
- echo "3. Commit the framework updates"
138
- fi