tadforce 0.0.0-stage → 0.3.0

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 (141) hide show
  1. package/.claude-plugin/marketplace.json +20 -0
  2. package/.claude-plugin/plugin.json +13 -0
  3. package/LICENSE +202 -0
  4. package/NOTICE +11 -0
  5. package/README.md +266 -2
  6. package/assets/logo-mark.svg +24 -0
  7. package/assets/logo.svg +31 -0
  8. package/bin/tadforce.js +4 -0
  9. package/commands/tadforce-review.md +8 -0
  10. package/commands/tadforce-update.md +6 -0
  11. package/commands/tadforce.md +10 -0
  12. package/package.json +60 -4
  13. package/skills/tadforce/SKILL.md +73 -0
  14. package/skills/tadforce/references/axes-rules.md +29 -0
  15. package/skills/tadforce/references/evidence-rules.md +40 -0
  16. package/skills/tadforce/references/exclusion-heuristics.md +40 -0
  17. package/skills/tadforce/references/figure-rules.md +42 -0
  18. package/skills/tadforce/references/markdown-conventions.md +67 -0
  19. package/skills/tadforce/references/modules/agentforce-ai.md +24 -0
  20. package/skills/tadforce/references/modules/analytics.md +19 -0
  21. package/skills/tadforce/references/modules/commerce.md +25 -0
  22. package/skills/tadforce/references/modules/data-cloud.md +23 -0
  23. package/skills/tadforce/references/modules/experience-cloud.md +24 -0
  24. package/skills/tadforce/references/modules/field-service.md +25 -0
  25. package/skills/tadforce/references/modules/industries.md +21 -0
  26. package/skills/tadforce/references/modules/integration-platforms.md +19 -0
  27. package/skills/tadforce/references/modules/marketing.md +24 -0
  28. package/skills/tadforce/references/modules/omnistudio.md +24 -0
  29. package/skills/tadforce/references/modules/platform-events.md +19 -0
  30. package/skills/tadforce/references/modules/revenue-cpq.md +25 -0
  31. package/skills/tadforce/references/modules/sales-cloud.md +26 -0
  32. package/skills/tadforce/references/modules/security-shield.md +18 -0
  33. package/skills/tadforce/references/modules/service-cloud.md +27 -0
  34. package/skills/tadforce/references/naming-external-systems.md +32 -0
  35. package/skills/tadforce/references/questions.md +59 -0
  36. package/skills/tadforce/references/salesforce-skills.md +27 -0
  37. package/skills/tadforce/references/workflow.md +95 -0
  38. package/skills/tadforce/references/writing-rules.md +47 -0
  39. package/skills/tadforce-review/SKILL.md +53 -0
  40. package/skills/tadforce-update/SKILL.md +48 -0
  41. package/src/build/brand.js +107 -0
  42. package/src/build/browser.js +70 -0
  43. package/src/build/directives.js +293 -0
  44. package/src/build/export.js +60 -0
  45. package/src/build/figures.js +119 -0
  46. package/src/build/mermaid.js +107 -0
  47. package/src/build/render.js +299 -0
  48. package/src/build/serve.js +59 -0
  49. package/src/cli.js +68 -0
  50. package/src/commands/docs.js +204 -0
  51. package/src/commands/doctor.js +370 -0
  52. package/src/commands/init.js +132 -0
  53. package/src/commands/org.js +151 -0
  54. package/src/commands/review.js +35 -0
  55. package/src/commands/spec.js +91 -0
  56. package/src/commands/update.js +154 -0
  57. package/src/facts/extractors/apex.js +111 -0
  58. package/src/facts/extractors/automation.js +85 -0
  59. package/src/facts/extractors/data.js +94 -0
  60. package/src/facts/extractors/integration.js +76 -0
  61. package/src/facts/extractors/misc.js +100 -0
  62. package/src/facts/extractors/security.js +92 -0
  63. package/src/facts/extractors/ui.js +120 -0
  64. package/src/facts/fingerprints.js +32 -0
  65. package/src/facts/heuristics/exclusions.js +143 -0
  66. package/src/facts/heuristics/modules.js +85 -0
  67. package/src/facts/heuristics/naming.js +31 -0
  68. package/src/facts/heuristics/signals.js +76 -0
  69. package/src/facts/index.js +197 -0
  70. package/src/facts/org.js +87 -0
  71. package/src/facts/xml.js +85 -0
  72. package/src/sf/sf.js +120 -0
  73. package/src/util/args.js +21 -0
  74. package/src/util/config.js +104 -0
  75. package/src/util/fsx.js +58 -0
  76. package/src/util/i18n.js +49 -0
  77. package/src/util/log.js +31 -0
  78. package/src/util/paths.js +11 -0
  79. package/src/validate/index.js +126 -0
  80. package/templates/axes/en/00-document-control.md +3 -0
  81. package/templates/axes/en/01-summary.md +7 -0
  82. package/templates/axes/en/02-method.md +9 -0
  83. package/templates/axes/en/03-findings.md +19 -0
  84. package/templates/axes/en/04-register.md +3 -0
  85. package/templates/axes/en/05-roadmap.md +3 -0
  86. package/templates/axes/en/99-appendix.md +5 -0
  87. package/templates/axes/fr/00-document-control.md +3 -0
  88. package/templates/axes/fr/01-summary.md +7 -0
  89. package/templates/axes/fr/02-method.md +9 -0
  90. package/templates/axes/fr/03-findings.md +19 -0
  91. package/templates/axes/fr/04-register.md +3 -0
  92. package/templates/axes/fr/05-roadmap.md +3 -0
  93. package/templates/axes/fr/99-appendix.md +5 -0
  94. package/templates/html/cover.html +12 -0
  95. package/templates/html/editor.js +502 -0
  96. package/templates/html/style.css +255 -0
  97. package/templates/html/template.html +88 -0
  98. package/templates/i18n/en.json +366 -0
  99. package/templates/i18n/fr.json +366 -0
  100. package/templates/manifest/package-tad.xml +543 -0
  101. package/templates/specs/sections.yml +494 -0
  102. package/templates/tad/en/00-document-control.md +7 -0
  103. package/templates/tad/en/01-summary.md +17 -0
  104. package/templates/tad/en/02-purpose.md +35 -0
  105. package/templates/tad/en/03-context.md +17 -0
  106. package/templates/tad/en/04-general.md +29 -0
  107. package/templates/tad/en/05-functional.md +7 -0
  108. package/templates/tad/en/06-data.md +71 -0
  109. package/templates/tad/en/07-application.md +49 -0
  110. package/templates/tad/en/08-ui.md +41 -0
  111. package/templates/tad/en/09-integrations.md +53 -0
  112. package/templates/tad/en/10-security.md +59 -0
  113. package/templates/tad/en/11-reporting.md +13 -0
  114. package/templates/tad/en/12-operations.md +25 -0
  115. package/templates/tad/en/13-nfr.md +9 -0
  116. package/templates/tad/en/14-decisions.md +3 -0
  117. package/templates/tad/en/15-outlook.md +3 -0
  118. package/templates/tad/en/99-appendices.md +119 -0
  119. package/templates/tad/fr/00-document-control.md +7 -0
  120. package/templates/tad/fr/01-summary.md +17 -0
  121. package/templates/tad/fr/02-purpose.md +35 -0
  122. package/templates/tad/fr/03-context.md +17 -0
  123. package/templates/tad/fr/04-general.md +29 -0
  124. package/templates/tad/fr/05-functional.md +7 -0
  125. package/templates/tad/fr/06-data.md +71 -0
  126. package/templates/tad/fr/07-application.md +49 -0
  127. package/templates/tad/fr/08-ui.md +41 -0
  128. package/templates/tad/fr/09-integrations.md +53 -0
  129. package/templates/tad/fr/10-security.md +59 -0
  130. package/templates/tad/fr/11-reporting.md +13 -0
  131. package/templates/tad/fr/12-operations.md +25 -0
  132. package/templates/tad/fr/13-nfr.md +9 -0
  133. package/templates/tad/fr/14-decisions.md +3 -0
  134. package/templates/tad/fr/15-outlook.md +3 -0
  135. package/templates/tad/fr/99-appendices.md +119 -0
  136. package/templates/vendor/LICENSE-html-docx-js.txt +21 -0
  137. package/templates/vendor/LICENSE-html2canvas.txt +22 -0
  138. package/templates/vendor/LICENSE-mermaid.txt +21 -0
  139. package/templates/vendor/html-docx.js +13216 -0
  140. package/templates/vendor/html2canvas.min.js +20 -0
  141. package/templates/vendor/mermaid.min.js +2314 -0
@@ -0,0 +1,20 @@
1
+ {
2
+ "name": "tadforce",
3
+ "owner": {
4
+ "name": "Jihad AZAMI HASSANI"
5
+ },
6
+ "metadata": {
7
+ "description": "TADForce — AI-Powered Salesforce Technical Documentation, written by your agent from the org's own metadata."
8
+ },
9
+ "plugins": [
10
+ {
11
+ "name": "tadforce",
12
+ "source": "./",
13
+ "description": "AI-Powered Salesforce Technical Documentation: generate, review, validate and update the Technical Architecture Document of any Salesforce org (/tadforce, /tadforce-review, /tadforce-update).",
14
+ "version": "0.3.0",
15
+ "author": { "name": "Jihad AZAMI HASSANI" },
16
+ "license": "Apache-2.0",
17
+ "category": "documentation"
18
+ }
19
+ ]
20
+ }
@@ -0,0 +1,13 @@
1
+ {
2
+ "name": "tadforce",
3
+ "version": "0.3.0",
4
+ "description": "AI-Powered Salesforce Technical Documentation — the Technical Architecture Document of any Salesforce org, written from the org's own metadata: evidence-based, reproducible, reviewable in the browser, kept up to date. All Salesforce products and industries.",
5
+ "author": {
6
+ "name": "Jihad AZAMI HASSANI",
7
+ "url": "https://github.com/azamiji"
8
+ },
9
+ "homepage": "https://github.com/azamiji/TADForce",
10
+ "repository": "https://github.com/azamiji/TADForce",
11
+ "license": "Apache-2.0",
12
+ "keywords": ["salesforce", "architecture", "documentation", "technical-architecture-document", "sfdx", "well-architected"]
13
+ }
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,11 @@
1
+ TADForce
2
+ Copyright 2026 Jihad AZAMI HASSANI
3
+
4
+ This product includes software developed by third parties, shipped unmodified in templates/vendor/:
5
+ - Mermaid 11.4.1 (MIT License) — https://mermaid.js.org
6
+ - html2canvas 1.4.1 (MIT License) — https://html2canvas.hertzen.com
7
+ - html-docx-js 0.3.1 (MIT License) — https://github.com/evidenceprime/html-docx-js
8
+ Their license texts are in templates/vendor/LICENSE-*.txt.
9
+
10
+ Salesforce and related product names are trademarks of Salesforce, Inc. TADForce is an independent
11
+ community project, not affiliated with, sponsored or endorsed by Salesforce.
package/README.md CHANGED
@@ -1,3 +1,267 @@
1
- # Temporary Holding Version
1
+ <div align="center">
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ <img src="assets/banner.svg" alt="TADForce — point it at a Salesforce org, get the architecture document a senior architect would write" width="100%">
4
+
5
+ ### AI-Powered Salesforce Technical Documentation
6
+
7
+ **Four commands. One org. One Technical Architecture Document — evidence-based, reproducible, reviewable in the browser.**
8
+
9
+ [![npm](https://img.shields.io/npm/v/tadforce?color=7B3FE4&label=npm&logo=npm)](https://www.npmjs.com/package/tadforce)
10
+ [![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-1E88FF)](LICENSE)
11
+ [![GitHub stars](https://img.shields.io/github/stars/azamiji/TADForce?style=flat&color=FFD54F&logo=github)](https://github.com/azamiji/TADForce/stargazers)
12
+ [![CI](https://img.shields.io/github/actions/workflow/status/azamiji/TADForce/ci.yml?label=tests&logo=githubactions&logoColor=white)](https://github.com/azamiji/TADForce/actions)
13
+ ![Node](https://img.shields.io/badge/node-%E2%89%A520-339933?logo=nodedotjs&logoColor=white)
14
+ ![Salesforce CLI](https://img.shields.io/badge/sf%20CLI-v2-00A1E0)
15
+
16
+ [![Agent Skills](https://img.shields.io/badge/Agent%20Skills-open%20standard-0B2545)](https://agentskills.io)
17
+ [![Claude Code](https://img.shields.io/badge/Claude%20Code-plugin-D97757)](#-quick-start)
18
+ [![Codex](https://img.shields.io/badge/Codex-skill-111111)](#-quick-start)
19
+ [![Cursor](https://img.shields.io/badge/Cursor-skill-3B82F6)](#-quick-start)
20
+ [![Copilot](https://img.shields.io/badge/GitHub%20Copilot-skill-6E40C9)](#-quick-start)
21
+ [![Read-only](https://img.shields.io/badge/org%20access-read--only-16A34A)](#-read-only-by-design)
22
+
23
+ [**Live demo**](https://azamiji.github.io/TADForce/) · [Quick start](#-quick-start) · [The four commands](#-four-commands) · [Every project type](#-every-kind-of-salesforce-project)
24
+
25
+ </div>
26
+
27
+ <img src="assets/divider.svg" width="100%" alt="">
28
+
29
+ ## Why TADForce
30
+
31
+ Writing the Technical Architecture Document of a Salesforce org takes weeks, and it is out of date at the next release. A generic AI chat writes it in an hour, then you spend days checking what it made up.
32
+
33
+ TADForce reads the org the way a senior Salesforce architect would — every class, flow, object, permission set group, named credential and OmniScript — and your AI agent writes the document from that evidence. One rule: **no evidence, no sentence.** If the metadata does not prove it, the agent asks you or writes *to be confirmed*. It never guesses the name of a system, never documents a feature you switched off, and never types a number by hand.
34
+
35
+ <div align="center">
36
+ <img src="assets/gifs/document.gif" alt="Navigating a Technical Architecture Document generated by TADForce" width="92%">
37
+ <br><sub>The generated document: navigable contents, KPI tiles that link to their appendix, figures drawn from the metadata.</sub>
38
+ </div>
39
+
40
+ ## 🚀 Quick start
41
+
42
+ **Prerequisites:** Node.js 20+, the [Salesforce CLI](https://developer.salesforce.com/tools/salesforcecli) (`sf`), Chrome or Edge, and an AI agent. `doctor` checks all of it and installs what it can.
43
+
44
+ From your Salesforce DX project (or an empty folder):
45
+
46
+ ```bash
47
+ npx tadforce doctor
48
+ ```
49
+
50
+ Then, in your AI agent (Claude Code, Codex, Cursor, Copilot…):
51
+
52
+ ```text
53
+ /tadforce
54
+ ```
55
+
56
+ <table>
57
+ <tr><th width="33%">A — Claude Code plugin</th><th width="33%">B — Any agent (Agent Skills)</th><th width="33%">C — Deterministic / CI</th></tr>
58
+ <tr valign="top"><td>
59
+
60
+ ```text
61
+ /plugin marketplace add azamiji/TADForce
62
+ /plugin install tadforce@tadforce
63
+ /tadforce
64
+ ```
65
+
66
+ </td><td>
67
+
68
+ ```bash
69
+ npx tadforce doctor
70
+ # skills land in .claude/, .agents/,
71
+ # .cursor/, .codex/… (detected)
72
+ ```
73
+ then ask your agent: *“run /tadforce”*
74
+
75
+ </td><td>
76
+
77
+ ```bash
78
+ npx tadforce prepare --org prod
79
+ npx tadforce build --pdf --docx
80
+ npx tadforce validate --json
81
+ ```
82
+
83
+ </td></tr>
84
+ </table>
85
+
86
+ ## 🧭 Four commands
87
+
88
+ | Command | What it does | Your part |
89
+ |---|---|---|
90
+ | `npx tadforce doctor` | Everything before the writing, in one loop until all is green: tools, SFDX project, org connection (reuses the project's `target-org`, opens the browser only when needed), metadata (retrieved from the org with a `*` manifest, or your local sources), client logo and colours, then the questions only a human can answer | Log in once; confirm the answers it recommends; name the external systems; confirm what is unused or decommissioned |
91
+ | `npx tadforce build` | Your agent writes each section from its specification and the facts, then the document is built: **HTML** always, **PDF** and **Word** on demand, and validated | — |
92
+ | `npx tadforce review` | Opens the document to comment it. **Save writes into the same file** — one file per document, no copies, no lost comments. Then `/tadforce-review` turns every comment into a fix | Comment a passage or capture an area, Save |
93
+ | `npx tadforce update` | Months later: reads the org again, archives the previous facts, lists the sections touched by what changed (a new Apex class, a modified flow, new counts…), bumps the version. `/tadforce-update` rewrites only those sections | — |
94
+
95
+ <div align="center">
96
+ <img src="assets/gifs/doctor.gif" alt="tadforce doctor asking the few questions only a human can answer" width="80%">
97
+ <br><sub><code>doctor</code>: one loop, a recommended answer for every question.</sub>
98
+ </div>
99
+
100
+ ```mermaid
101
+ flowchart LR
102
+ A["doctor<br>tools · org · metadata · questions"]:::h --> B["write<br>15 chapters"]:::a
103
+ B --> C["build<br>HTML · PDF · DOCX"]:::s
104
+ C --> D["review<br>comments in the HTML"]:::h
105
+ D --> B
106
+ C -. months later .-> E["update<br>what changed"]:::s
107
+ E --> B
108
+ classDef s fill:#E8F1FF,stroke:#2F6FE4,color:#0B2545
109
+ classDef a fill:#F1E8FF,stroke:#7B3FE4,color:#2A1458
110
+ classDef h fill:#FFF2E2,stroke:#E0861F,color:#4A2A05
111
+ ```
112
+
113
+ <sub>Blue: the CLI (deterministic). Violet: your agent (judgement). Orange: you (one login, one batch of questions, one review).</sub>
114
+
115
+ The fine-grained commands (`manifest`, `retrieve`, `facts`, `next`, `validate`…) are still there for CI and experts: `npx tadforce help --all`.
116
+
117
+ ## 📦 What you get
118
+
119
+ | Deliverable | For | Contents |
120
+ |---|---|---|
121
+ | **Technical Architecture Document** — HTML | the client | Navigable, searchable, **edit in place**, **comment a passage or capture an area**, saved in the same file, export PDF / Word from the page |
122
+ | **Technical Architecture Document** — PDF / DOCX | the client's archive | Print-ready A4 with page numbers; Word document from the same source; the version in the file name |
123
+ | **Improvement Axes** — HTML / PDF / DOCX | the integrator | Measured signals per Well-Architected pillar, register `AX-nn`, roadmap — kept out of the client document |
124
+ | `facts/facts.json` | everyone | The deterministic inventory of the org, byte-identical from one run to the next |
125
+
126
+ The document carries **the client's logo and colours**: the logo is searched in the org (static resources, content assets, site assets) or given by you; the colours come from the org's Lightning theme, else from the logo — always readable (WCAG contrast checked). The integrator and the author are optional: leave them blank and the document names the client only.
127
+
128
+ <div align="center">
129
+ <img src="assets/gifs/review.gif" alt="Commenting a passage in the HTML and saving it into the same file" width="92%">
130
+ <br><sub>The review loop: comment in the page, Save into the same file, then <code>/tadforce-review</code> resolves each comment and answers it.</sub>
131
+ </div>
132
+
133
+ ## 🧩 Every kind of Salesforce project
134
+
135
+ | Your situation | How TADForce handles it |
136
+ |---|---|
137
+ | **A whole org**, as-built | `doctor` retrieves everything with a curated `*` manifest (130 types, foldered reports and dashboards, standard objects) |
138
+ | **One project in a shared org** (several BUs, several integrators) | Scope: `--scope "NWB_*,Loan*"` or `--package-dirs`. Out-of-scope components leave facts, counts and tables; standard objects and org-wide settings stay |
139
+ | **Before or during the build** | Give your functional specifications (`--specs SFD.pdf,…`): they become evidence (level P2/P3) next to the metadata |
140
+ | **No org access**, sources only | `--source local` documents the package directories of the project |
141
+ | **Unlocked or managed packages** | Namespaces and installed packages are detected and documented with their evidence |
142
+ | **Any cloud, any industry** | Sections switch on only when the product is detected, each with its writing guide (below) |
143
+ | **Any language** | English and French built in. Any other language (Spanish, German, Italian, Portuguese, Arabic, Japanese…): pick it in `doctor`, your agent translates the headings and labels once, then writes in that language. Salesforce terms stay in English |
144
+
145
+ ### Products and industries
146
+
147
+ <table>
148
+ <tr><td>
149
+
150
+ **Clouds** · Sales Cloud · Service Cloud · Field Service · Experience Cloud · Marketing (Connect, Account Engagement) · Commerce & Order Management · CPQ, Billing, Revenue Cloud
151
+
152
+ </td><td>
153
+
154
+ **Industries** · Financial Services · Insurance · Health · Life Sciences · Manufacturing · Automotive · Consumer Goods · Communications / Media / Energy · Public Sector · Education · Nonprofit · Loyalty · Net Zero
155
+
156
+ </td><td>
157
+
158
+ **Platform** · OmniStudio · Data Cloud · Agentforce & Einstein · CRM Analytics · Platform Events & CDC · Shield · MuleSoft, Heroku, Slack, External Services
159
+
160
+ </td></tr>
161
+ </table>
162
+
163
+ ## 🏛️ The document model
164
+
165
+ Every org gets **the same skeleton** — that is what makes two TADForce documents comparable:
166
+
167
+ | # | Chapter | Highlights |
168
+ |---|---|---|
169
+ | — | Document control | Reference, version, classification, history (kept up to date by `update`) |
170
+ | 1 | Executive summary | KPI tiles, capabilities, key achievements, principles |
171
+ | 2 | Purpose, scope, references | Method, scope, exclusions applied, reading conventions |
172
+ | 3 | Context and vision | Drivers, populations, functional scope, key figures |
173
+ | 4 | General architecture | Generated context view, products with evidence, layered view, naming conventions |
174
+ | 5 | Functional architecture | One section per business domain, with sequences and state diagrams |
175
+ | 6 | Data | Generated ERDs (Lookup / Master-Detail only), external IDs, record types, Custom Metadata, events, volumes |
176
+ | 7 | Application | Apex layers, triggers and order of execution, async, flows, OmniStudio, Agentforce, key sequences |
177
+ | 8 | User interface | Apps, pages, LWC by domain, communication, sites, telephony and Omni-Channel |
178
+ | 9 | Integrations | Patterns, `FLX-nn` flow catalogue, one section per connected system, inbound APIs, SSO |
179
+ | 10 | Security | Personas and PSGs, generated role hierarchy, OWD, sharing, application security, Shield |
180
+ | 11-15 | Reporting · Operations · NFR & Well-Architected · ADRs · Outlook | |
181
+ | A-K | Appendices | Generated from facts: Apex, automation, objects, OmniStudio, UI, access, endpoints, packages, traceability, glossary |
182
+
183
+ ## 🔒 Read-only by design
184
+
185
+ | Guarantee | How |
186
+ |---|---|
187
+ | Never changes the org | Every `sf` call goes through an allow-list: `org list/display/login`, `list metadata`, `retrieve`, `data query`, `config get`. `deploy`, `delete`, `apex run`… are refused. |
188
+ | Never reads business data | SOQL guard: only org configuration objects, or aggregates (`COUNT()`, `MAX(CreatedDate)`, `GROUP BY` counts on users and assignments). |
189
+ | Never touches your project | Retrieve goes to `tadforce/.snapshot` (git-ignored); `force-app` is untouched. |
190
+ | Never leaks secrets | Credentials are never retrieved; `validate` blocks tokens, passwords, private keys and org IDs in the text. |
191
+
192
+ ### What leaves your machine
193
+
194
+ The TADForce CLI sends nothing anywhere: no telemetry, no server, no account. It talks to your org through your own Salesforce CLI, and to the web only when **you** give it a logo URL. Your AI agent reads the metadata, the facts and the specifications you provide in order to write — exactly as when you ask it to read your code. Use the agent and the data-handling settings your company approved for client work.
195
+
196
+ ## 🎯 Reproducible by construction
197
+
198
+ - **Facts are code, not prose.** `facts.json` is extracted deterministically (sorted, stable) — tested byte for byte.
199
+ - **Numbers are placeholders.** Writers type `{{n:apex.classes}}`, never `132`. Tables, ERDs, role trees, KPIs and appendices are generated.
200
+ - **Specs, not prompts.** 84 section specifications (`intent · facts · must · never`) drive every agent the same way.
201
+ - **A gate, not a hope.** `npx tadforce validate` fails on unwritten sections, unknown placeholders, identifiers that do not exist in the org, excluded or decommissioned components, forbidden terms, broken anchors, Mermaid errors and secrets.
202
+ - **Knowledge that sticks.** Client vocabulary, system names and exclusions live in `knowledge/*.yml`, so a regeneration never brings back a mistake a reader already fixed.
203
+
204
+ ## ⚔️ With vs without TADForce
205
+
206
+ | | Writing by hand | A generic AI chat | **TADForce** |
207
+ |---|---|---|---|
208
+ | Time to a first complete draft | weeks | hours, then days of fact-checking | **an afternoon** |
209
+ | Figures match the org | until the next release | rarely | **always — generated from facts** |
210
+ | Same structure across clients | depends on the author | never | **always — one skeleton, 84 specs** |
211
+ | System names and decommissioned features | tribal knowledge | hallucinated | **asked once, enforced forever** |
212
+ | Client review | Word comments, copy-paste | — | **comments in the HTML, resolved by the agent** |
213
+ | Three months later | start again | start again | **`update`: only what changed** |
214
+ | Debt and risks | mixed with the description | mixed | **separate Improvement Axes document** |
215
+
216
+ ## 🧱 Built on
217
+
218
+ [Salesforce CLI](https://developer.salesforce.com/tools/salesforcecli) · [Agent Skills](https://agentskills.io) · [Salesforce skills (`forcedotcom/sf-skills`)](https://github.com/forcedotcom/sf-skills) · [Mermaid](https://mermaid.js.org) · [Puppeteer](https://pptr.dev) · [markdown-it](https://github.com/markdown-it/markdown-it) · [html2canvas](https://html2canvas.hertzen.com) · [html-docx-js](https://github.com/evidenceprime/html-docx-js)
219
+
220
+ ## 🗺️ Roadmap
221
+
222
+ - [ ] Built-in skeletons for more languages (es, de, pt, it) — any language already works through the agent; contributions welcome
223
+ - [ ] Your own template: add, hide or rename chapters from `tadforce/templates/`
224
+ - [ ] More examples: Service + Experience Cloud, an ISV package
225
+ - [ ] Salesforce CLI plugin wrapper (`sf tad …`)
226
+ - [ ] Dependency graph from `MetadataComponentDependency` (Tooling API)
227
+ - [ ] Export to Confluence / SharePoint
228
+
229
+ ## 🤝 Contributing
230
+
231
+ Issues and pull requests are welcome — new product modules, new extractors, new languages. Read [CONTRIBUTING.md](CONTRIBUTING.md). Run `npm test` before opening a PR: it includes the unit tests and the genericity guard.
232
+
233
+ ## 👥 Community
234
+
235
+ TADForce was born for the **Salesforce ecosystem**: architects, consultants, integrators and in-house teams who need documentation they can trust.
236
+
237
+ Your experience is what makes it better. Tell us, in the [issues](https://github.com/azamiji/TADForce/issues) and [discussions](https://github.com/azamiji/TADForce/discussions):
238
+
239
+ - **How it went** — the kind of org and project, the time it took, what worked out of the box.
240
+ - **How good the result was** — sections that read like a senior architect wrote them, and sections that did not.
241
+ - **What to improve** — a product it should detect better, a section that misses the point, a question it should have asked.
242
+
243
+ Please share your feedback, not your documents: they describe your clients' systems.
244
+
245
+ If TADForce saved you a week, **star the repo** ⭐ — it is how other Salesforce teams find it.
246
+
247
+ ## 👤 Author
248
+
249
+ <table>
250
+ <tr>
251
+ <td width="110"><img src="https://github.com/azamiji.png" width="96" alt="Jihad AZAMI HASSANI"></td>
252
+ <td>
253
+
254
+ **Jihad AZAMI HASSANI**<br>
255
+ Salesforce Technical Architect, 10+ years of experience · Claude Certified Architect · Salesforce Architect Community Group Leader, Casablanca<br>
256
+ [![Claude Certified Architect](https://img.shields.io/badge/Claude-Certified%20Architect-D97757?logo=claude&logoColor=white)](https://www.linkedin.com/in/jihadazami/)<br>
257
+ [LinkedIn](https://www.linkedin.com/in/jihadazami/) · [GitHub](https://github.com/azamiji)
258
+
259
+ </td>
260
+ </tr>
261
+ </table>
262
+
263
+ ## ⚖️ License
264
+
265
+ [Apache-2.0](LICENSE) © Jihad AZAMI HASSANI.
266
+
267
+ <sub>Salesforce, Sales Cloud, Service Cloud, Agentforce and the other product names are trademarks of Salesforce, Inc. TADForce is an independent community project, not affiliated with, sponsored or endorsed by Salesforce. The example organization (Northwind Bank, Acme Integrators) is fictional.</sub>
@@ -0,0 +1,24 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128" width="128" height="128" role="img" aria-label="TADForce">
2
+ <defs>
3
+ <linearGradient id="g" x1="0" y1="0" x2="1" y2="1">
4
+ <stop offset="0" stop-color="#1E88FF"/>
5
+ <stop offset="1" stop-color="#9B1FE8"/>
6
+ </linearGradient>
7
+ <pattern id="grid" width="12" height="12" patternUnits="userSpaceOnUse">
8
+ <path d="M12 0H0V12" fill="none" stroke="#ffffff" stroke-opacity=".16" stroke-width="1"/>
9
+ </pattern>
10
+ </defs>
11
+ <rect width="128" height="128" rx="30" fill="url(#g)"/>
12
+ <rect width="128" height="128" rx="30" fill="url(#grid)"/>
13
+ <!-- blueprint sheet with a folded corner -->
14
+ <path d="M38 20h38l20 20v62a6 6 0 0 1-6 6H38a6 6 0 0 1-6-6V26a6 6 0 0 1 6-6z" fill="#ffffff"/>
15
+ <path d="M76 20v14a6 6 0 0 0 6 6h14z" fill="#D6E4FF"/>
16
+ <!-- the T: crossbar + compass legs -->
17
+ <path d="M44 50h40" stroke="#0B2545" stroke-width="7" stroke-linecap="round"/>
18
+ <path d="M64 52L55 96" stroke="#0B2545" stroke-width="6" stroke-linecap="round"/>
19
+ <path d="M64 52L73 96" stroke="#0B2545" stroke-width="6" stroke-linecap="round"/>
20
+ <circle cx="64" cy="52" r="6.5" fill="#9B1FE8" stroke="#0B2545" stroke-width="3"/>
21
+ <!-- the line the compass draws -->
22
+ <path d="M50 100q14 7 28 0" fill="none" stroke="#9B1FE8" stroke-width="3" stroke-linecap="round" stroke-dasharray="2 5"/>
23
+ <path d="M44 34h18M44 40h12" stroke="#1E88FF" stroke-width="3" stroke-linecap="round" opacity=".55"/>
24
+ </svg>
@@ -0,0 +1,31 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 700 128" width="700" height="128" role="img" aria-label="TADForce">
2
+ <defs>
3
+ <linearGradient id="g" x1="0" y1="0" x2="1" y2="1">
4
+ <stop offset="0" stop-color="#1E88FF"/>
5
+ <stop offset="1" stop-color="#9B1FE8"/>
6
+ </linearGradient>
7
+ <linearGradient id="t" x1="0" y1="0" x2="1" y2="0">
8
+ <stop offset="0" stop-color="#1E88FF"/>
9
+ <stop offset="1" stop-color="#9B1FE8"/>
10
+ </linearGradient>
11
+ <pattern id="grid" width="12" height="12" patternUnits="userSpaceOnUse">
12
+ <path d="M12 0H0V12" fill="none" stroke="#ffffff" stroke-opacity=".16" stroke-width="1"/>
13
+ </pattern>
14
+ </defs>
15
+ <g>
16
+ <rect width="128" height="128" rx="30" fill="url(#g)"/>
17
+ <rect width="128" height="128" rx="30" fill="url(#grid)"/>
18
+ <path d="M38 20h38l20 20v62a6 6 0 0 1-6 6H38a6 6 0 0 1-6-6V26a6 6 0 0 1 6-6z" fill="#ffffff"/>
19
+ <path d="M76 20v14a6 6 0 0 0 6 6h14z" fill="#D6E4FF"/>
20
+ <path d="M44 50h40" stroke="#0B2545" stroke-width="7" stroke-linecap="round"/>
21
+ <path d="M64 52L55 96" stroke="#0B2545" stroke-width="6" stroke-linecap="round"/>
22
+ <path d="M64 52L73 96" stroke="#0B2545" stroke-width="6" stroke-linecap="round"/>
23
+ <circle cx="64" cy="52" r="6.5" fill="#9B1FE8" stroke="#0B2545" stroke-width="3"/>
24
+ <path d="M50 100q14 7 28 0" fill="none" stroke="#9B1FE8" stroke-width="3" stroke-linecap="round" stroke-dasharray="2 5"/>
25
+ <path d="M44 34h18M44 40h12" stroke="#1E88FF" stroke-width="3" stroke-linecap="round" opacity=".55"/>
26
+ </g>
27
+ <text x="152" y="82" font-family="Segoe UI, Inter, Helvetica Neue, Arial, sans-serif" font-size="64" font-weight="800" letter-spacing="-1.5">
28
+ <tspan fill="#0B2545">TAD</tspan><tspan fill="url(#t)">Force</tspan>
29
+ </text>
30
+ <text x="155" y="110" font-family="Segoe UI, Inter, Helvetica Neue, Arial, sans-serif" font-size="14" font-weight="600" fill="#5a6878" letter-spacing="2">THE ARCHITECT'S SCRIBE · NO EVIDENCE, NO SENTENCE</text>
31
+ </svg>
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env node
2
+ import { main } from '../src/cli.js';
3
+
4
+ main(process.argv.slice(2)).then((code) => { process.exitCode = code; });
@@ -0,0 +1,8 @@
1
+ ---
2
+ description: Apply the review comments saved in a TADForce HTML document and rebuild it with the comments resolved
3
+ argument-hint: "[path to the saved HTML]"
4
+ ---
5
+
6
+ Use the `tadforce-review` skill. Comments file: $ARGUMENTS (default: `tadforce/out/TAD_<CODE>.html`, the single file the readers comment through `npx tadforce review`).
7
+
8
+ List the open comments with `npx tadforce review --json`, classify them, apply each correction to the sources and to the knowledge files, record the resolutions in `tadforce/tadforce.config.json`, rebuild with `npx tadforce build --pdf --docx`, and report one line per comment.
@@ -0,0 +1,6 @@
1
+ ---
2
+ description: Bring an existing Technical Architecture Document up to date with what changed in the org since its last version
3
+ argument-hint: "[org alias]"
4
+ ---
5
+
6
+ Use the `tadforce-update` skill. Run `npx tadforce update --json`, rewrite only the sections it lists from the new facts and the changed metadata, rebuild with `npx tadforce build --pdf --docx`, and report what changed in the document.
@@ -0,0 +1,10 @@
1
+ ---
2
+ description: Generate the Technical Architecture Document (and the Improvement Axes) of the current Salesforce org, end to end
3
+ argument-hint: "[org alias] [fr|en]"
4
+ ---
5
+
6
+ Use the `tadforce` skill to produce the Technical Architecture Document of this Salesforce project, end to end: `doctor` (tools, org connection, metadata, the questions only a human can answer), writing every section, `build` (HTML with editing and comments, PDF, DOCX) and validation, then the Improvement Axes document.
7
+
8
+ Arguments (optional): $ARGUMENTS — an org alias and/or the document language.
9
+
10
+ Start with `npx tadforce doctor --json` and loop on it until `ok: true`, following `skills/tadforce/references/workflow.md`. Ask the framing questions in one batch, each with its recommended answer. Stop only when `npx tadforce validate` reports 0 errors, then hand over the paths, the score and the points to confirm.