@supportpages.io/wtfm 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.
- package/LICENSE +201 -0
- package/NOTICE +23 -0
- package/README.md +392 -2
- package/dist/actions.d.ts +98 -0
- package/dist/actions.js +86 -0
- package/dist/actions.js.map +1 -0
- package/dist/agent-settings.d.ts +22 -0
- package/dist/agent-settings.js +35 -0
- package/dist/agent-settings.js.map +1 -0
- package/dist/api.d.ts +14 -0
- package/dist/api.js +159 -0
- package/dist/api.js.map +1 -0
- package/dist/article-link.d.ts +16 -0
- package/dist/article-link.js +25 -0
- package/dist/article-link.js.map +1 -0
- package/dist/artifacts.d.ts +45 -0
- package/dist/artifacts.js +144 -0
- package/dist/artifacts.js.map +1 -0
- package/dist/brand.d.ts +4 -0
- package/dist/brand.js +9 -0
- package/dist/brand.js.map +1 -0
- package/dist/bridge.d.ts +2964 -0
- package/dist/bridge.js +1036 -0
- package/dist/bridge.js.map +1 -0
- package/dist/capacity.d.ts +5 -0
- package/dist/capacity.js +11 -0
- package/dist/capacity.js.map +1 -0
- package/dist/credentials.d.ts +13 -0
- package/dist/credentials.js +88 -0
- package/dist/credentials.js.map +1 -0
- package/dist/development-tls.d.ts +8 -0
- package/dist/development-tls.js +38 -0
- package/dist/development-tls.js.map +1 -0
- package/dist/errors.d.ts +15 -0
- package/dist/errors.js +18 -0
- package/dist/errors.js.map +1 -0
- package/dist/export.d.ts +11 -0
- package/dist/export.js +91 -0
- package/dist/export.js.map +1 -0
- package/dist/hosted-operations.d.ts +108 -0
- package/dist/hosted-operations.js +120 -0
- package/dist/hosted-operations.js.map +1 -0
- package/dist/hosting-benefits.d.ts +66 -0
- package/dist/hosting-benefits.js +67 -0
- package/dist/hosting-benefits.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +49 -0
- package/dist/index.js.map +1 -0
- package/dist/local-inventory.d.ts +22 -0
- package/dist/local-inventory.js +59 -0
- package/dist/local-inventory.js.map +1 -0
- package/dist/local-setup.d.ts +208 -0
- package/dist/local-setup.js +140 -0
- package/dist/local-setup.js.map +1 -0
- package/dist/pairing.d.ts +71 -0
- package/dist/pairing.js +235 -0
- package/dist/pairing.js.map +1 -0
- package/dist/preferences.d.ts +18 -0
- package/dist/preferences.js +44 -0
- package/dist/preferences.js.map +1 -0
- package/dist/progress.d.ts +205 -0
- package/dist/progress.js +224 -0
- package/dist/progress.js.map +1 -0
- package/dist/reminders.d.ts +31 -0
- package/dist/reminders.js +73 -0
- package/dist/reminders.js.map +1 -0
- package/dist/replace-connection.d.ts +6 -0
- package/dist/replace-connection.js +77 -0
- package/dist/replace-connection.js.map +1 -0
- package/dist/repository-actions.d.ts +18 -0
- package/dist/repository-actions.js +9 -0
- package/dist/repository-actions.js.map +1 -0
- package/dist/repository-benefits.d.ts +96 -0
- package/dist/repository-benefits.js +64 -0
- package/dist/repository-benefits.js.map +1 -0
- package/dist/run-update.d.ts +17 -0
- package/dist/run-update.js +27 -0
- package/dist/run-update.js.map +1 -0
- package/dist/runs.d.ts +541 -0
- package/dist/runs.js +146 -0
- package/dist/runs.js.map +1 -0
- package/dist/runtime.d.ts +12 -0
- package/dist/runtime.js +58 -0
- package/dist/runtime.js.map +1 -0
- package/dist/schema.d.ts +277 -0
- package/dist/schema.js +66 -0
- package/dist/schema.js.map +1 -0
- package/dist/server.d.ts +4 -0
- package/dist/server.js +298 -0
- package/dist/server.js.map +1 -0
- package/dist/session.d.ts +1714 -0
- package/dist/session.js +619 -0
- package/dist/session.js.map +1 -0
- package/dist/settings.d.ts +9 -0
- package/dist/settings.js +21 -0
- package/dist/settings.js.map +1 -0
- package/dist/sync.d.ts +495 -0
- package/dist/sync.js +191 -0
- package/dist/sync.js.map +1 -0
- package/dist/telemetry-scrub.d.ts +13 -0
- package/dist/telemetry-scrub.js +51 -0
- package/dist/telemetry-scrub.js.map +1 -0
- package/dist/telemetry.d.ts +73 -0
- package/dist/telemetry.js +173 -0
- package/dist/telemetry.js.map +1 -0
- package/dist/walkthroughs.d.ts +224 -0
- package/dist/walkthroughs.js +109 -0
- package/dist/walkthroughs.js.map +1 -0
- package/dist/workspace.d.ts +14 -0
- package/dist/workspace.js +127 -0
- package/dist/workspace.js.map +1 -0
- package/dist/writer-agent.d.ts +21 -0
- package/dist/writer-agent.js +27 -0
- package/dist/writer-agent.js.map +1 -0
- package/dist/writer-entry.d.ts +171 -0
- package/dist/writer-entry.js +233 -0
- package/dist/writer-entry.js.map +1 -0
- package/dist/writing-style.d.ts +7 -0
- package/dist/writing-style.js +52 -0
- package/dist/writing-style.js.map +1 -0
- package/engine/SYNC.json +4 -0
- package/engine/VERSION +1 -0
- package/engine/detect-project/README.md +141 -0
- package/engine/detect-project/SKILL.md +1421 -0
- package/engine/detect-project/assets/desktop/desktop-frame.css +428 -0
- package/engine/detect-project/assets/game/game-frame.css +132 -0
- package/engine/detect-project/assets/macosui/LICENSE-puppertino.txt +21 -0
- package/engine/detect-project/assets/macosui/VERSIONS.txt +1 -0
- package/engine/detect-project/assets/macosui/fonts.css +15 -0
- package/engine/detect-project/assets/macosui/macos-frame.css +481 -0
- package/engine/detect-project/assets/macosui/puppertino.css +2153 -0
- package/engine/detect-project/assets/mobileui/LICENSE-fonts.txt +13 -0
- package/engine/detect-project/assets/mobileui/LICENSE-framework7.txt +52 -0
- package/engine/detect-project/assets/mobileui/VERSIONS.txt +6 -0
- package/engine/detect-project/assets/mobileui/device-frame.css +316 -0
- package/engine/detect-project/assets/mobileui/f7-color-theme.mjs +1345 -0
- package/engine/detect-project/assets/mobileui/f7-icons-names.json +1254 -0
- package/engine/detect-project/assets/mobileui/fonts.css +16 -0
- package/engine/detect-project/assets/mobileui/framework7-components.css +39 -0
- package/engine/detect-project/assets/mobileui/framework7-core.css +5245 -0
- package/engine/detect-project/assets/mobileui/icons.css +31 -0
- package/engine/detect-project/assets/mobileui/md3-defaults.css +89 -0
- package/engine/detect-project/assets/mobileui/platforms.json +46 -0
- package/engine/detect-project/assets/tailwind-fallback.css +1729 -0
- package/engine/detect-project/assets/webtui/LICENSE-webtui.txt +28 -0
- package/engine/detect-project/assets/webtui/VERSIONS.txt +7 -0
- package/engine/detect-project/assets/webtui/terminal-frame.css +195 -0
- package/engine/detect-project/assets/webtui/theme-catppuccin.css +1 -0
- package/engine/detect-project/assets/webtui/theme-everforest.css +1 -0
- package/engine/detect-project/assets/webtui/theme-gruvbox.css +1 -0
- package/engine/detect-project/assets/webtui/theme-nord.css +1 -0
- package/engine/detect-project/assets/webtui/theme-vitesse.css +1 -0
- package/engine/detect-project/assets/webtui/themes.json +37 -0
- package/engine/detect-project/assets/webtui/webtui-core.css +1 -0
- package/engine/detect-project/assets/win32ui/7css.css +2 -0
- package/engine/detect-project/assets/win32ui/LICENSE-7css.txt +21 -0
- package/engine/detect-project/assets/win32ui/VERSIONS.txt +1 -0
- package/engine/detect-project/assets/win32ui/win32-frame.css +278 -0
- package/engine/detect-project/package-lock.json +12 -0
- package/engine/detect-project/package.json +10 -0
- package/engine/detect-project/scripts/apply_runtime_profiles.js +313 -0
- package/engine/detect-project/scripts/check_css_health.js +412 -0
- package/engine/detect-project/scripts/check_project_map.js +150 -0
- package/engine/detect-project/scripts/check_runtime_coverage.js +311 -0
- package/engine/detect-project/scripts/check_runtime_recipe_quality.js +184 -0
- package/engine/detect-project/scripts/classify_app_type.sh +246 -0
- package/engine/detect-project/scripts/classify_surface.sh +95 -0
- package/engine/detect-project/scripts/classify_workspace.js +39 -0
- package/engine/detect-project/scripts/compile_css.sh +447 -0
- package/engine/detect-project/scripts/detect_static.js +645 -0
- package/engine/detect-project/scripts/detect_structure.js +187 -0
- package/engine/detect-project/scripts/include_census.js +451 -0
- package/engine/detect-project/scripts/json_get.js +142 -0
- package/engine/detect-project/scripts/merge_json.js +52 -0
- package/engine/detect-project/scripts/recommend_model_tier.js +252 -0
- package/engine/detect-project/scripts/resolve_route_chains.js +135 -0
- package/engine/detect-project/scripts/run_css_build.sh +40 -0
- package/engine/detect-project/scripts/sanitize_css.js +83 -0
- package/engine/detect-project/scripts/test_classify_surface.js +108 -0
- package/engine/detect-project/scripts/test_node_helpers.js +142 -0
- package/engine/detect-project/scripts/test_recommend_model_tier.js +119 -0
- package/engine/detect-project/scripts/test_resolve_route_chains.js +182 -0
- package/engine/detect-project/scripts/test_runtime_coverage.js +323 -0
- package/engine/detect-project/scripts/test_runtime_recipe_quality.js +187 -0
- package/engine/detect-project/scripts/theme_overrides.js +169 -0
- package/engine/detect-project/scripts/write_branding.js +129 -0
- package/engine/generate-illustrated-article/SKILL.md +461 -0
- package/engine/generate-illustrated-article/contracts/desktop.md +90 -0
- package/engine/generate-illustrated-article/contracts/game.md +38 -0
- package/engine/generate-illustrated-article/contracts/label-evidence.md +38 -0
- package/engine/generate-illustrated-article/contracts/macos.md +79 -0
- package/engine/generate-illustrated-article/contracts/mobile.md +40 -0
- package/engine/generate-illustrated-article/contracts/terminal.md +29 -0
- package/engine/generate-illustrated-article/contracts/win32.md +43 -0
- package/engine/generate-illustrated-article/package-lock.json +366 -0
- package/engine/generate-illustrated-article/package.json +15 -0
- package/engine/generate-illustrated-article/scripts/article_blocks.js +34 -0
- package/engine/generate-illustrated-article/scripts/check_article_json.js +105 -0
- package/engine/generate-illustrated-article/scripts/emit_walkthrough_signals.js +100 -0
- package/engine/generate-illustrated-article/scripts/extract_images.js +187 -0
- package/engine/generate-illustrated-article/scripts/generate_content_images.js +376 -0
- package/engine/generate-illustrated-article/scripts/include_census.js +451 -0
- package/engine/generate-illustrated-article/scripts/inject_assets.js +1691 -0
- package/engine/generate-illustrated-article/scripts/jit_mockup_css.js +191 -0
- package/engine/generate-illustrated-article/scripts/label_evidence.js +87 -0
- package/engine/generate-illustrated-article/scripts/lint_article_copy.js +252 -0
- package/engine/generate-illustrated-article/scripts/lint_mockup_fidelity.js +2403 -0
- package/engine/generate-illustrated-article/scripts/polish_tickets.js +1148 -0
- package/engine/generate-illustrated-article/scripts/related_repos.sh +52 -0
- package/engine/generate-illustrated-article/scripts/render_all.js +177 -0
- package/engine/generate-illustrated-article/scripts/render_mockup.js +665 -0
- package/engine/generate-illustrated-article/scripts/render_ready.js +164 -0
- package/engine/generate-illustrated-article/scripts/resolve_workspace.sh +86 -0
- package/engine/generate-illustrated-article/scripts/runtime_region_geometry.js +55 -0
- package/engine/generate-illustrated-article/scripts/source_paths.js +49 -0
- package/engine/generate-illustrated-article/scripts/test_control_visibility.js +30 -0
- package/engine/generate-illustrated-article/scripts/test_emit_walkthrough_signals.js +157 -0
- package/engine/generate-illustrated-article/scripts/test_generate_content_images.js +168 -0
- package/engine/generate-illustrated-article/scripts/test_include_census.js +126 -0
- package/engine/generate-illustrated-article/scripts/test_label_evidence.js +49 -0
- package/engine/generate-illustrated-article/scripts/test_lint_article_copy.js +138 -0
- package/engine/generate-illustrated-article/scripts/test_lint_mockup_fidelity.js +653 -0
- package/engine/generate-illustrated-article/scripts/test_node_ports.js +152 -0
- package/engine/generate-illustrated-article/scripts/test_polish_tickets.js +481 -0
- package/engine/generate-illustrated-article/scripts/test_related_repos.js +64 -0
- package/engine/generate-illustrated-article/scripts/test_render_ready.js +85 -0
- package/engine/generate-illustrated-article/scripts/test_source_paths.js +68 -0
- package/engine/generate-illustrated-article/scripts/trace_hook.js +79 -0
- package/engine/generate-illustrated-article/scripts/trace_hook.sh +4 -0
- package/engine/generate-illustrated-article/scripts/validate_html.js +114 -0
- package/engine/generate-illustrated-article/scripts/watermark.js +69 -0
- package/install.sh +14 -0
- package/package.json +57 -4
- package/scripts/auth.mjs +33 -0
- package/scripts/auto-update.mjs +7 -0
- package/scripts/build-plugin.mjs +58 -0
- package/scripts/build-release.mjs +94 -0
- package/scripts/check-release.mjs +40 -0
- package/scripts/check-runtime.mjs +10 -0
- package/scripts/cli.mjs +8 -0
- package/scripts/install.mjs +64 -0
- package/scripts/lib/agent-runner.mjs +181 -0
- package/scripts/lib/agent-settings.mjs +215 -0
- package/scripts/lib/article-skills.mjs +82 -0
- package/scripts/lib/auto-update.mjs +50 -0
- package/scripts/lib/brand.mjs +9 -0
- package/scripts/lib/browser.mjs +12 -0
- package/scripts/lib/claude-connection.mjs +33 -0
- package/scripts/lib/claude-permissions.mjs +47 -0
- package/scripts/lib/claude-plugin.mjs +15 -0
- package/scripts/lib/claude-writer.mjs +10 -0
- package/scripts/lib/cli-main.mjs +85 -0
- package/scripts/lib/cli.mjs +888 -0
- package/scripts/lib/codex-config.mjs +51 -0
- package/scripts/lib/codex-integration.mjs +61 -0
- package/scripts/lib/codex-skill.mjs +34 -0
- package/scripts/lib/harness-models.mjs +109 -0
- package/scripts/lib/install.mjs +269 -0
- package/scripts/lib/managed-writer.mjs +38 -0
- package/scripts/lib/planning.mjs +263 -0
- package/scripts/lib/prepare-update.mjs +85 -0
- package/scripts/lib/refresh-writers.mjs +12 -0
- package/scripts/lib/remove.mjs +167 -0
- package/scripts/lib/renderer.mjs +34 -0
- package/scripts/lib/terminal.mjs +252 -0
- package/scripts/lib/uninit.mjs +72 -0
- package/scripts/lib/update.mjs +55 -0
- package/scripts/lib/writer-recovery.mjs +35 -0
- package/scripts/lib/yolo.mjs +362 -0
- package/scripts/plugin-session.mjs +65 -0
- package/scripts/prepare-update.mjs +12 -0
- package/scripts/publish-release.mjs +92 -0
- package/scripts/skills/supportpages/SKILL.md +120 -0
- package/scripts/smoke-release.mjs +101 -0
- package/server.json +27 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
SupportPages Writer
|
|
2
|
+
Copyright 2026 Surface Layer Limited
|
|
3
|
+
|
|
4
|
+
This product is licensed under the Apache License, Version 2.0 (see LICENSE).
|
|
5
|
+
"SupportPages" and "supportpages.io" are trademarks of their owner; the license
|
|
6
|
+
grants no rights to use them (Apache License 2.0, section 6).
|
|
7
|
+
|
|
8
|
+
Third-party components
|
|
9
|
+
----------------------
|
|
10
|
+
|
|
11
|
+
engine/detect-project/assets/ vendors UI stylesheets, each with its license
|
|
12
|
+
file beside it:
|
|
13
|
+
- WebTUI (webtui/LICENSE-webtui.txt)
|
|
14
|
+
- Framework7 and its fonts (mobileui/LICENSE-framework7.txt, LICENSE-fonts.txt)
|
|
15
|
+
- 7.css (win32ui/LICENSE-7css.txt)
|
|
16
|
+
- Puppertino (macosui/LICENSE-puppertino.txt)
|
|
17
|
+
|
|
18
|
+
engine/detect-project/assets/tailwind-fallback.css contains a reset derived from
|
|
19
|
+
Tailwind CSS Preflight (MIT License, Copyright (c) Tailwind Labs, Inc.) and
|
|
20
|
+
modern-normalize (MIT License, Copyright (c) Sindre Sorhus).
|
|
21
|
+
|
|
22
|
+
Standalone release archives also bundle Node.js and npm, which carry their own
|
|
23
|
+
licenses inside the archive.
|
package/README.md
CHANGED
|
@@ -1,3 +1,393 @@
|
|
|
1
|
-
|
|
1
|
+
<h1 align="center">WTFM</h1>
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<p align="center">
|
|
4
|
+
<strong>Write the F***ing Manual.</strong><br>
|
|
5
|
+
A plugin for your coding agent that writes the user docs. Screenshots included.
|
|
6
|
+
</p>
|
|
7
|
+
|
|
8
|
+
<p align="center">
|
|
9
|
+
<a href="LICENSE"><img alt="License: Apache 2.0" src="https://img.shields.io/badge/license-Apache%202.0-blue.svg"></a>
|
|
10
|
+
<img alt="Platforms: macOS and Linux" src="https://img.shields.io/badge/platform-macOS%20%7C%20Linux-lightgrey.svg">
|
|
11
|
+
<img alt="Works with Claude Code and Codex" src="https://img.shields.io/badge/works%20with-Claude%20Code%20%7C%20Codex-8A2BE2.svg">
|
|
12
|
+
</p>
|
|
13
|
+
|
|
14
|
+
<p align="center">
|
|
15
|
+
<a href="#install">Install</a> ·
|
|
16
|
+
<a href="#quick-start">Quick start</a> ·
|
|
17
|
+
<a href="#examples">Examples</a> ·
|
|
18
|
+
<a href="#cli-commands">CLI</a> ·
|
|
19
|
+
<a href="#publish">Publish</a> ·
|
|
20
|
+
<a href="#faq">FAQ</a> ·
|
|
21
|
+
<a href="https://wtfm.supportpages.io">Docs</a> ·
|
|
22
|
+
<a href="https://supportpages.io/wtfm">Website</a>
|
|
23
|
+
</p>
|
|
24
|
+
|
|
25
|
+
<p align="center">
|
|
26
|
+
<img src="docs/images/demo.gif" width="880" alt="Claude Code writing an illustrated guide to adding a site in Plausible Analytics: the prompt, the writer's progress, and the finished article with screenshots">
|
|
27
|
+
<br>
|
|
28
|
+
<sub>Real output from <a href="https://github.com/plausible/analytics">plausible/analytics</a>, replayed fast. A real run takes a few minutes.</sub>
|
|
29
|
+
</p>
|
|
30
|
+
|
|
31
|
+
**WTFM is a plugin for your coding agent that writes your user docs.** Ask
|
|
32
|
+
[Claude Code](https://claude.com/claude-code) or [Codex](https://github.com/openai/codex)
|
|
33
|
+
for a guide and it reads your source, writes the steps in plain language, and shows every
|
|
34
|
+
screen with a screenshot rendered from your real templates and CSS. No running app, no
|
|
35
|
+
manual captures, no account.
|
|
36
|
+
|
|
37
|
+
Not API reference, not a README: docs for the people who will never read your code,
|
|
38
|
+
like the customer who can't find the export button, or the admin inviting their team.
|
|
39
|
+
|
|
40
|
+
> WTFM was formerly SupportPages Writer. The `supportpages` command still works as
|
|
41
|
+
> an alias for `wtfm`, and existing installations, settings and `SUPPORTPAGES_*`
|
|
42
|
+
> environment variables are unchanged.
|
|
43
|
+
|
|
44
|
+
Set it up once in your terminal, then just ask your agent:
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
curl -fsSL https://wtfm.sh/install | bash
|
|
48
|
+
```
|
|
49
|
+
```sh
|
|
50
|
+
wtfm setup # once per computer
|
|
51
|
+
```
|
|
52
|
+
```sh
|
|
53
|
+
wtfm init # once per project
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
> **You → Claude Code:** Write an illustrated guide to inviting a teammate.
|
|
57
|
+
|
|
58
|
+
## Features
|
|
59
|
+
|
|
60
|
+
- **Written from your source.** Routes, button labels and flows come from the code,
|
|
61
|
+
not from a description you type, so the steps match what users actually see.
|
|
62
|
+
- **Screenshots without running the app.** Mockups are rebuilt from your own markup,
|
|
63
|
+
styles and branding, then rendered to PNG in a local headless Chromium.
|
|
64
|
+
- **Plain Markdown output.** Each article is an `index.md` with its images beside it,
|
|
65
|
+
ready to commit next to your code or drop into any docs site.
|
|
66
|
+
- **Checked before it's saved.** Every article passes structure, copy and screenshot
|
|
67
|
+
checks first.
|
|
68
|
+
- **Uses the agent you already have.** Claude Code or Codex, with your own subscription
|
|
69
|
+
and model settings.
|
|
70
|
+
- **Local-first.** Nothing is sent to SupportPages.io unless you choose to publish.
|
|
71
|
+
|
|
72
|
+
## Examples
|
|
73
|
+
|
|
74
|
+
The same loop on other open-source codebases. Each image is one screenshot from a
|
|
75
|
+
guide WTFM wrote from that repository's source; the apps were never run.
|
|
76
|
+
|
|
77
|
+
| [immich-app/immich](https://github.com/immich-app/immich) · SvelteKit | [paperless-ngx/paperless-ngx](https://github.com/paperless-ngx/paperless-ngx) · Angular | [maybe-finance/maybe](https://github.com/maybe-finance/maybe) · Rails |
|
|
78
|
+
| --- | --- | --- |
|
|
79
|
+
| <img src="docs/images/immich.png" alt="Immich albums page, from How to create a new album"> | <img src="docs/images/paperless.png" alt="Paperless-ngx Create new tag dialog, from How to create a tag and apply it to a document"> | <img src="docs/images/maybe.png" alt="Maybe Enter account balance dialog, from How to add a new account"> |
|
|
80
|
+
| How to create a new album | How to create a tag and apply it to a document | How to add a new account |
|
|
81
|
+
|
|
82
|
+
For a whole help centre, see [WTFM's own docs](https://wtfm.supportpages.io): every
|
|
83
|
+
article and screenshot there was written by WTFM from this repository.
|
|
84
|
+
|
|
85
|
+
## Install
|
|
86
|
+
|
|
87
|
+
```sh
|
|
88
|
+
curl -fsSL https://wtfm.sh/install | bash
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
The installer downloads a checksum-verified release with its own Node.js, installs
|
|
92
|
+
the `wtfm` command into `~/.local/bin` (no `sudo`), and offers to add it to your
|
|
93
|
+
`PATH`. It also installs `supportpages` as an alias for `wtfm`.
|
|
94
|
+
|
|
95
|
+
**You'll need:**
|
|
96
|
+
|
|
97
|
+
- macOS or Linux, on ARM64 or x64 (on Windows, use WSL)
|
|
98
|
+
- [Claude Code](https://claude.com/claude-code) or [Codex](https://github.com/openai/codex),
|
|
99
|
+
installed and signed in
|
|
100
|
+
- Git
|
|
101
|
+
|
|
102
|
+
Chromium for screenshots is downloaded the first time you run `wtfm setup`.
|
|
103
|
+
|
|
104
|
+
**Updating:** releases check for updates once a day and install them in the background.
|
|
105
|
+
Run `wtfm update` to update now, or set `SUPPORTPAGES_AUTO_UPDATE=0` to turn
|
|
106
|
+
automatic updates off.
|
|
107
|
+
|
|
108
|
+
### Build from source
|
|
109
|
+
|
|
110
|
+
You'll need Node.js 22.12 or later, npm and Git.
|
|
111
|
+
|
|
112
|
+
```sh
|
|
113
|
+
git clone https://github.com/SupportPages-io/wtfm.git
|
|
114
|
+
cd wtfm
|
|
115
|
+
./install-cli.sh
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
This builds your checkout and installs it as `wtfm` (with the `supportpages` alias).
|
|
119
|
+
Run `./install-cli.sh` again after pulling changes.
|
|
120
|
+
|
|
121
|
+
## Quick start
|
|
122
|
+
|
|
123
|
+
Configure once in the terminal, then do everything else in your coding agent.
|
|
124
|
+
|
|
125
|
+
### 1. Set up your computer
|
|
126
|
+
|
|
127
|
+
```sh
|
|
128
|
+
wtfm setup
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
This connects Claude Code and/or Codex, adds the SupportPages writer to them and
|
|
132
|
+
downloads the screenshot renderer. When it asks how you want to work, choose
|
|
133
|
+
**Save articles in my projects without an account**.
|
|
134
|
+
|
|
135
|
+
### 2. Set up your project
|
|
136
|
+
|
|
137
|
+
```sh
|
|
138
|
+
cd path/to/your-product
|
|
139
|
+
wtfm init
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Pick where articles should be saved and which model to use. WTFM then
|
|
143
|
+
studies the project's structure, styles and branding once, so every article starts
|
|
144
|
+
from that analysis.
|
|
145
|
+
|
|
146
|
+
### 3. Ask your coding agent
|
|
147
|
+
|
|
148
|
+
Open Claude Code or Codex in your project (restart any session that was already open)
|
|
149
|
+
and ask for an article in plain words:
|
|
150
|
+
|
|
151
|
+
> Write an illustrated guide to inviting a teammate.
|
|
152
|
+
|
|
153
|
+
A few minutes later the article is in your project:
|
|
154
|
+
|
|
155
|
+
```text
|
|
156
|
+
output/articles/how-to-invite-a-teammate/
|
|
157
|
+
├── index.md
|
|
158
|
+
├── block_open-settings.png
|
|
159
|
+
├── block_invite-form.png
|
|
160
|
+
└── block_send-invite.png
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
That's the whole loop. Some other things to ask:
|
|
164
|
+
|
|
165
|
+
> What help articles do we have?
|
|
166
|
+
|
|
167
|
+
> Write a troubleshooting article for when a sign-in link has expired.
|
|
168
|
+
|
|
169
|
+
## CLI commands
|
|
170
|
+
|
|
171
|
+
You only need the terminal to set things up and keep them running. Writing happens in
|
|
172
|
+
your coding agent.
|
|
173
|
+
|
|
174
|
+
| Command | What it does |
|
|
175
|
+
| --- | --- |
|
|
176
|
+
| `wtfm setup` | Set up this computer: connect your coding agents and install the renderer |
|
|
177
|
+
| `wtfm init` | Set up this project: where articles go, which model, project analysis |
|
|
178
|
+
| `wtfm configure` | Change this project's agent, model, writing style or article folder |
|
|
179
|
+
| `wtfm analyse` | Re-run project analysis after big changes (`--refresh`) |
|
|
180
|
+
| `wtfm status` | Show this project's setup and article progress |
|
|
181
|
+
| `wtfm doctor` | Check that everything is installed and connected |
|
|
182
|
+
| `wtfm telemetry off` | Stop anonymous usage counts and crash reports (`on`, `status`) |
|
|
183
|
+
| `wtfm update` | Install the latest release |
|
|
184
|
+
| `wtfm uninit` | Forget this project's setup (keeps a recovery archive) |
|
|
185
|
+
| `wtfm remove` | Disconnect from your coding agents (keeps projects and articles) |
|
|
186
|
+
|
|
187
|
+
Run `wtfm --help` for every option. `status` and `doctor` accept `--json`.
|
|
188
|
+
|
|
189
|
+
## Your articles
|
|
190
|
+
|
|
191
|
+
- **Where they go.** `output/articles/<slug>/` by default. To keep them in your repo,
|
|
192
|
+
choose a folder like `docs/help` during `init` or with `wtfm configure`.
|
|
193
|
+
- **Writing style.** Pick from friendly, minimal, technical or formal with
|
|
194
|
+
`wtfm configure`.
|
|
195
|
+
- **Screenshots.** Each article gets up to three. The main path gets them first;
|
|
196
|
+
optional branches are described in text. Every screenshot carries a small
|
|
197
|
+
"created automatically by supportpages.io" strip.
|
|
198
|
+
|
|
199
|
+
## How it works
|
|
200
|
+
|
|
201
|
+
1. `setup` connects a local [MCP](https://modelcontextprotocol.io) server and a
|
|
202
|
+
writer agent to Claude Code or Codex.
|
|
203
|
+
2. `init` has your agent map the project once: framework, routes, layouts, CSS and
|
|
204
|
+
branding.
|
|
205
|
+
3. When you ask for an article, the writer agent reads the relevant source, writes the
|
|
206
|
+
steps, and builds each screenshot as an HTML mockup of your real UI.
|
|
207
|
+
4. The mockups are rendered to PNG with a local Chromium, checked against your source,
|
|
208
|
+
and saved with the article.
|
|
209
|
+
|
|
210
|
+
## Publish
|
|
211
|
+
|
|
212
|
+
**Give your users somewhere to read it.** A Markdown folder in your repo helps nobody
|
|
213
|
+
who can't find it. [SupportPages.io](https://supportpages.io/?utm_source=wtfm&utm_medium=readme),
|
|
214
|
+
made by the same team, turns the guides WTFM writes into a help centre your users can
|
|
215
|
+
search and ask: on your own domain, in your branding, and kept current as the product
|
|
216
|
+
changes.
|
|
217
|
+
|
|
218
|
+
<p align="center">
|
|
219
|
+
<img src="docs/images/help-centre.png" width="720" alt="help.supportpages.io, a help centre hosted on SupportPages.io: AI search, suggested questions and article categories">
|
|
220
|
+
</p>
|
|
221
|
+
|
|
222
|
+
- **Kept current on every merge.** When a pull request merges, SupportPages.io reads
|
|
223
|
+
the diff and drafts the article updates for you to review.
|
|
224
|
+
- **Video walkthroughs.** Each guide can come with a narrated video that clicks through
|
|
225
|
+
the same steps, with captions.
|
|
226
|
+
- **Answers, not just search.** Readers ask in their own words and get an answer drawn
|
|
227
|
+
from your articles, with the sources linked.
|
|
228
|
+
- Your branding on your own domain, an editor to review drafts before anyone sees them,
|
|
229
|
+
and publishing straight from your coding agent.
|
|
230
|
+
|
|
231
|
+
Everything above works without it, and a free account hosts up to 10 articles.
|
|
232
|
+
|
|
233
|
+
The same pattern applies: connect once in the terminal, then work in your agent.
|
|
234
|
+
|
|
235
|
+
**Connect a project:**
|
|
236
|
+
|
|
237
|
+
```sh
|
|
238
|
+
wtfm publish
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
You'll sign in or create an account in your browser and choose a help centre. Any
|
|
242
|
+
articles you've already saved upload as drafts. (Setting up a new project? Choose
|
|
243
|
+
**Publish them to a SupportPages.io help centre** during `wtfm init` instead.)
|
|
244
|
+
|
|
245
|
+
**Then keep asking your agent:**
|
|
246
|
+
|
|
247
|
+
> Write a guide to exporting a report.
|
|
248
|
+
|
|
249
|
+
New articles arrive in the help centre as drafts, with a link to review them in the
|
|
250
|
+
editor. Publishing is always a separate step: click **Publish** in the editor, or ask:
|
|
251
|
+
|
|
252
|
+
> Publish the guide to exporting a report.
|
|
253
|
+
|
|
254
|
+
| Command | What it does |
|
|
255
|
+
| --- | --- |
|
|
256
|
+
| `wtfm publish` | Sign in, pick a help centre and upload this project's saved articles |
|
|
257
|
+
| `wtfm yolo` | Write the whole manual on SupportPages.io (account required; drafts only) |
|
|
258
|
+
| `wtfm login` / `logout` | Sign this computer in or out |
|
|
259
|
+
| `wtfm sync` | Refresh help-centre settings and article history |
|
|
260
|
+
|
|
261
|
+
A help centre never needs access to your GitHub or Bitbucket. Only `wtfm yolo` does.
|
|
262
|
+
|
|
263
|
+
### `wtfm yolo`: write the whole manual
|
|
264
|
+
|
|
265
|
+
Starting from nothing? `wtfm yolo` plans every guide your product needs and
|
|
266
|
+
writes them all at once, on SupportPages.io's servers instead of your computer and your
|
|
267
|
+
coding agent's usage.
|
|
268
|
+
|
|
269
|
+
```sh
|
|
270
|
+
wtfm yolo
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
It walks you through whatever is missing: browser sign-in, choosing or creating a help
|
|
274
|
+
centre, and connecting your repository (SupportPages.io needs read access to write from
|
|
275
|
+
your code). It then shows your plan's article allowance and asks before starting
|
|
276
|
+
(`--yes` skips the question). The free plan covers your first 10 guides.
|
|
277
|
+
|
|
278
|
+
Progress shows live: sections, recommended articles, then drafts as they are written.
|
|
279
|
+
Everything lands as drafts; nothing goes live until you publish it in the editor, whose
|
|
280
|
+
link is printed at the end. Ctrl+C only stops watching: the run keeps going, and
|
|
281
|
+
`wtfm status` picks it up again. If a run fails, run `wtfm yolo` again to resume it
|
|
282
|
+
without losing the drafts already written.
|
|
283
|
+
|
|
284
|
+
## Privacy
|
|
285
|
+
|
|
286
|
+
- **Local projects send only anonymous usage counts and crash reports** to
|
|
287
|
+
SupportPages.io (see below). Your coding agent and its model provider read your
|
|
288
|
+
source, as they do for any other task.
|
|
289
|
+
- **Publishing uploads** the article, its images and a small provenance record.
|
|
290
|
+
Your source code is never uploaded.
|
|
291
|
+
- **`wtfm yolo` writes on SupportPages.io** from the repository you connect there;
|
|
292
|
+
it is the only command that gives SupportPages.io access to your code.
|
|
293
|
+
- **Credentials** are stored in private files under `~/.config/supportpages`, never in
|
|
294
|
+
your repository.
|
|
295
|
+
- **Project analysis runs unattended.** `init` and `analyse` start your agent with its
|
|
296
|
+
permission prompts off (`--dangerously-skip-permissions` for Claude Code,
|
|
297
|
+
`--dangerously-bypass-approvals-and-sandbox` for Codex). Writing articles uses the
|
|
298
|
+
agent's normal approval prompts.
|
|
299
|
+
|
|
300
|
+
### Anonymous usage counts and crash reports
|
|
301
|
+
|
|
302
|
+
WTFM tells us how many installs are in use and when something breaks, so we
|
|
303
|
+
can fix it. It says so the first time you set up a project, and it's easy to turn
|
|
304
|
+
off. It is sent to SupportPages.io without your sign-in, so it can't be linked to
|
|
305
|
+
your account.
|
|
306
|
+
|
|
307
|
+
**What is sent**
|
|
308
|
+
|
|
309
|
+
- A random install ID created on this computer (not derived from it), the WTFM
|
|
310
|
+
version, the coding client's name (e.g. `claude-code`), your OS, CPU architecture
|
|
311
|
+
and Node.js major version.
|
|
312
|
+
- A count when WTFM is first used, when a project is set up (local or hosted),
|
|
313
|
+
and when an article or video walkthrough finishes: its outcome, where it went
|
|
314
|
+
(local, uploaded or generated on SupportPages.io), an error code if it failed,
|
|
315
|
+
and how many seconds it took; likewise when a `wtfm yolo` run starts and ends.
|
|
316
|
+
- For unexpected errors only: the error type and code, and stack frames with every
|
|
317
|
+
path outside WTFM replaced by `<external>`. Messages from other code are
|
|
318
|
+
never sent.
|
|
319
|
+
|
|
320
|
+
**What is never sent:** your code, file names or paths, article titles or content,
|
|
321
|
+
repository or project names, your email or account, or credentials. Your IP address
|
|
322
|
+
is not stored.
|
|
323
|
+
|
|
324
|
+
**Turn it off** with any of these:
|
|
325
|
+
|
|
326
|
+
- ask your coding agent to turn off SupportPages telemetry;
|
|
327
|
+
- run `wtfm telemetry off`;
|
|
328
|
+
- set `SUPPORTPAGES_TELEMETRY=0` or `DO_NOT_TRACK=1`.
|
|
329
|
+
|
|
330
|
+
It is always off in CI. `wtfm doctor` shows whether it's on and why; set
|
|
331
|
+
`SUPPORTPAGES_TELEMETRY_DEBUG=1` to print each report to stderr as it is sent.
|
|
332
|
+
|
|
333
|
+
## FAQ
|
|
334
|
+
|
|
335
|
+
**Is this for API docs or READMEs?**
|
|
336
|
+
No. WTFM writes end-user documentation: how-to and troubleshooting guides for the
|
|
337
|
+
people who use your product, with screenshots. Your agent already handles developer
|
|
338
|
+
docs well.
|
|
339
|
+
|
|
340
|
+
**Why not just ask Claude Code to write the docs?**
|
|
341
|
+
It will write you decent steps. It won't show the screen, and it guesses at labels it
|
|
342
|
+
hasn't looked up. WTFM adds a project analysis, a renderer that builds screenshots from
|
|
343
|
+
your own UI code, and checks that run before anything is saved.
|
|
344
|
+
|
|
345
|
+
**What does it cost?**
|
|
346
|
+
WTFM is free and Apache 2.0. Articles run on your own Claude Code or Codex subscription.
|
|
347
|
+
`wtfm yolo` is the exception: it runs on SupportPages.io and needs an account; the free
|
|
348
|
+
plan covers 10 guides.
|
|
349
|
+
|
|
350
|
+
**`wtfm: command not found`**
|
|
351
|
+
Open a new terminal, or run the `PATH` command the installer printed.
|
|
352
|
+
|
|
353
|
+
**My agent can't see the SupportPages tools.**
|
|
354
|
+
Restart any Claude Code or Codex sessions that were open during `wtfm setup`.
|
|
355
|
+
|
|
356
|
+
**Setup won't finish.**
|
|
357
|
+
Run `wtfm doctor`, fix what it reports, then run `wtfm init` again.
|
|
358
|
+
|
|
359
|
+
**An article was interrupted halfway.**
|
|
360
|
+
Ask your agent to continue it, or run `wtfm status` to see where it stopped.
|
|
361
|
+
|
|
362
|
+
**Does it collect usage data?**
|
|
363
|
+
Only anonymous counts and crash reports, never your code or articles. See
|
|
364
|
+
[Anonymous usage counts and crash reports](#anonymous-usage-counts-and-crash-reports)
|
|
365
|
+
to see exactly what is sent or turn it off.
|
|
366
|
+
|
|
367
|
+
**Can I use it on Windows?**
|
|
368
|
+
Yes, inside WSL.
|
|
369
|
+
|
|
370
|
+
More on [supportpages.io/wtfm](https://supportpages.io/wtfm).
|
|
371
|
+
|
|
372
|
+
## Contributing
|
|
373
|
+
|
|
374
|
+
Bug reports and pull requests are welcome. When reporting a bug, include your OS,
|
|
375
|
+
`wtfm --version`, the command you ran and its output, with credentials and
|
|
376
|
+
private code removed. For larger changes, open an issue first so we can agree on the
|
|
377
|
+
approach.
|
|
378
|
+
|
|
379
|
+
To work on the code:
|
|
380
|
+
|
|
381
|
+
```sh
|
|
382
|
+
npm ci
|
|
383
|
+
npm test
|
|
384
|
+
node scripts/cli.mjs --help
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
The article engine in `engine/` is synced from upstream on each engine release, so
|
|
388
|
+
changes there are reviewed here and ported back by the maintainers.
|
|
389
|
+
|
|
390
|
+
## License
|
|
391
|
+
|
|
392
|
+
[Apache 2.0](LICENSE). The UI stylesheets bundled under `engine/` keep their own
|
|
393
|
+
licenses; see [NOTICE](NOTICE). The license doesn't cover the SupportPages name or logo.
|