seo 0.0.15 → 0.1.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/PRIVACY.md +95 -0
- package/README.md +338 -35
- package/SECURITY.md +55 -0
- package/TERMS.md +94 -0
- package/TRADEMARKS.md +27 -0
- package/dist/cli.js +125 -0
- package/dist/cli.js.map +1 -0
- package/dist/dist-CSY2_p-j.js +713 -0
- package/dist/dist-CSY2_p-j.js.map +1 -0
- package/dist/dist-FeAUNn9A.js +3 -0
- package/dist/index.d.ts +17921 -0
- package/dist/index.js +26769 -0
- package/dist/index.js.map +1 -0
- package/dist/mcp.d.ts +57 -0
- package/dist/mcp.js +26744 -0
- package/dist/mcp.js.map +1 -0
- package/dist/package-uzXzqDW6.js +23818 -0
- package/dist/package-uzXzqDW6.js.map +1 -0
- package/package.json +101 -23
- package/skills/README.md +81 -0
- package/skills/affected-urls/SKILL.md +39 -0
- package/skills/affected-urls/agents/openai.yaml +4 -0
- package/skills/ai-readiness/SKILL.md +34 -0
- package/skills/ai-readiness/agents/openai.yaml +4 -0
- package/skills/ai-referrals/SKILL.md +31 -0
- package/skills/ai-referrals/agents/openai.yaml +4 -0
- package/skills/audit-page/SKILL.md +50 -0
- package/skills/audit-page/agents/openai.yaml +4 -0
- package/skills/audit-urls/SKILL.md +39 -0
- package/skills/audit-urls/agents/openai.yaml +4 -0
- package/skills/cannibalisation/SKILL.md +31 -0
- package/skills/cannibalisation/agents/openai.yaml +4 -0
- package/skills/community-intent/SKILL.md +39 -0
- package/skills/community-intent/agents/openai.yaml +4 -0
- package/skills/compare-crawls/SKILL.md +40 -0
- package/skills/compare-crawls/agents/openai.yaml +4 -0
- package/skills/content-optimization/SKILL.md +31 -0
- package/skills/content-optimization/agents/openai.yaml +4 -0
- package/skills/crawl-diff/SKILL.md +51 -0
- package/skills/crawl-diff/agents/openai.yaml +4 -0
- package/skills/crawl-history/SKILL.md +37 -0
- package/skills/crawl-history/agents/openai.yaml +4 -0
- package/skills/crawl-report/SKILL.md +37 -0
- package/skills/crawl-report/agents/openai.yaml +4 -0
- package/skills/crawler-rules/SKILL.md +34 -0
- package/skills/crawler-rules/agents/openai.yaml +4 -0
- package/skills/ctr-underperformers/SKILL.md +31 -0
- package/skills/ctr-underperformers/agents/openai.yaml +4 -0
- package/skills/decaying-pages/SKILL.md +31 -0
- package/skills/decaying-pages/agents/openai.yaml +4 -0
- package/skills/entity-readiness/SKILL.md +34 -0
- package/skills/entity-readiness/agents/openai.yaml +4 -0
- package/skills/explain-crawl-issue/SKILL.md +32 -0
- package/skills/explain-crawl-issue/agents/openai.yaml +4 -0
- package/skills/generate-llms-txt/SKILL.md +37 -0
- package/skills/generate-llms-txt/agents/openai.yaml +4 -0
- package/skills/geo-gaps/SKILL.md +37 -0
- package/skills/geo-gaps/agents/openai.yaml +4 -0
- package/skills/index-coverage/SKILL.md +84 -0
- package/skills/index-coverage/agents/openai.yaml +4 -0
- package/skills/index-coverage-plan/SKILL.md +50 -0
- package/skills/index-coverage-plan/agents/openai.yaml +4 -0
- package/skills/index-monitor/SKILL.md +49 -0
- package/skills/index-monitor/agents/openai.yaml +4 -0
- package/skills/index-watch/SKILL.md +77 -0
- package/skills/index-watch/agents/openai.yaml +4 -0
- package/skills/internal-links/SKILL.md +31 -0
- package/skills/internal-links/agents/openai.yaml +4 -0
- package/skills/link-recovery/SKILL.md +51 -0
- package/skills/link-recovery/agents/openai.yaml +4 -0
- package/skills/llms-txt-audit/SKILL.md +34 -0
- package/skills/llms-txt-audit/agents/openai.yaml +4 -0
- package/skills/measure-change/SKILL.md +52 -0
- package/skills/measure-change/agents/openai.yaml +4 -0
- package/skills/monthly-action-plan/SKILL.md +50 -0
- package/skills/monthly-action-plan/agents/openai.yaml +4 -0
- package/skills/monthly-report/SKILL.md +50 -0
- package/skills/monthly-report/agents/openai.yaml +4 -0
- package/skills/narrative-report/SKILL.md +51 -0
- package/skills/narrative-report/agents/openai.yaml +4 -0
- package/skills/okf-build/SKILL.md +39 -0
- package/skills/okf-build/agents/openai.yaml +4 -0
- package/skills/okf-validate/SKILL.md +43 -0
- package/skills/okf-validate/agents/openai.yaml +4 -0
- package/skills/page-opportunities/SKILL.md +31 -0
- package/skills/page-opportunities/agents/openai.yaml +4 -0
- package/skills/performance/SKILL.md +50 -0
- package/skills/performance/agents/openai.yaml +4 -0
- package/skills/performance-audit/SKILL.md +31 -0
- package/skills/performance-audit/agents/openai.yaml +4 -0
- package/skills/pseo-audit/SKILL.md +103 -0
- package/skills/pseo-audit/agents/openai.yaml +4 -0
- package/skills/query-clusters/SKILL.md +31 -0
- package/skills/query-clusters/agents/openai.yaml +4 -0
- package/skills/quick-wins/SKILL.md +31 -0
- package/skills/quick-wins/agents/openai.yaml +4 -0
- package/skills/redirect-trace/SKILL.md +51 -0
- package/skills/redirect-trace/agents/openai.yaml +4 -0
- package/skills/refresh-priorities/SKILL.md +48 -0
- package/skills/refresh-priorities/agents/openai.yaml +4 -0
- package/skills/search-performance-overview/SKILL.md +48 -0
- package/skills/search-performance-overview/agents/openai.yaml +4 -0
- package/skills/second-page/SKILL.md +50 -0
- package/skills/second-page/agents/openai.yaml +4 -0
- package/skills/segment-impact/SKILL.md +50 -0
- package/skills/segment-impact/agents/openai.yaml +4 -0
- package/skills/seo/SKILL.md +74 -0
- package/skills/seo/agents/openai.yaml +4 -0
- package/skills/seo-fix-queue/SKILL.md +50 -0
- package/skills/seo-fix-queue/agents/openai.yaml +4 -0
- package/skills/seo-geo-readiness/SKILL.md +60 -0
- package/skills/seo-geo-readiness/agents/openai.yaml +4 -0
- package/skills/seo-site-audit/SKILL.md +59 -0
- package/skills/seo-site-audit/agents/openai.yaml +4 -0
- package/skills/seo-to-ai-query/SKILL.md +31 -0
- package/skills/seo-to-ai-query/agents/openai.yaml +4 -0
- package/skills/setup-check/SKILL.md +49 -0
- package/skills/setup-check/agents/openai.yaml +4 -0
- package/skills/site-crawl/SKILL.md +39 -0
- package/skills/site-crawl/agents/openai.yaml +4 -0
- package/skills/striking-distance/SKILL.md +52 -0
- package/skills/striking-distance/agents/openai.yaml +4 -0
- package/skills/technical-watch/SKILL.md +49 -0
- package/skills/technical-watch/agents/openai.yaml +4 -0
- package/skills/top-fixes/SKILL.md +38 -0
- package/skills/top-fixes/agents/openai.yaml +4 -0
- package/skills/traffic-anomaly/SKILL.md +52 -0
- package/skills/traffic-anomaly/agents/openai.yaml +4 -0
- package/skills/update-correlation/SKILL.md +51 -0
- package/skills/update-correlation/agents/openai.yaml +4 -0
- package/skills/update-postmortem/SKILL.md +49 -0
- package/skills/update-postmortem/agents/openai.yaml +4 -0
- package/.jshintrc +0 -18
- package/.npmignore +0 -3
- package/.travis.yml +0 -3
- package/Makefile +0 -10
- package/index.js +0 -2
- package/lib/middleware.js +0 -159
- package/lib/seo.js +0 -32
- package/test/init.js +0 -43
- package/test/middleware.test.js +0 -111
- package/test/seo-page-result.html +0 -9
- package/test/seo-page.html +0 -9
- package/test/seo-routes.js +0 -5
- package/test/vendor/jquery-1.11.1.min.js +0 -4
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 2026 Ian Nuttall
|
|
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/PRIVACY.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# Privacy policy
|
|
2
|
+
|
|
3
|
+
Last updated: 10 July 2026
|
|
4
|
+
|
|
5
|
+
This policy covers the official `seo` command-line tool, library, MCP server,
|
|
6
|
+
and the seoskills.dev website.
|
|
7
|
+
|
|
8
|
+
The current software runs on your machine. It does not create an SEO account,
|
|
9
|
+
upload reports to an SEO service, or send your Google data to the project
|
|
10
|
+
maintainer.
|
|
11
|
+
|
|
12
|
+
## Google data the software can access
|
|
13
|
+
|
|
14
|
+
Google access is optional. If you connect an account, the software asks for
|
|
15
|
+
read-only access to:
|
|
16
|
+
|
|
17
|
+
- your Google account email address, so the local app can identify the account
|
|
18
|
+
you connected;
|
|
19
|
+
- Search Console properties, performance data, and URL Inspection data you can
|
|
20
|
+
already access; and
|
|
21
|
+
- Google Analytics 4 accounts, properties, and report data you can already
|
|
22
|
+
access.
|
|
23
|
+
|
|
24
|
+
The software uses this data to list properties, run the report you requested,
|
|
25
|
+
join search or analytics evidence to crawl findings, and save local report
|
|
26
|
+
history when a command supports it. It does not use Google data for advertising
|
|
27
|
+
or to train general-purpose AI models.
|
|
28
|
+
|
|
29
|
+
The shared desktop OAuth client identifies the `seo` app to Google. OAuth
|
|
30
|
+
tokens and API responses are returned to your machine, not to the project
|
|
31
|
+
maintainer.
|
|
32
|
+
|
|
33
|
+
The use of information received from Google APIs follows the [Google API
|
|
34
|
+
Services User Data Policy](https://developers.google.com/terms/api-services-user-data-policy),
|
|
35
|
+
including its Limited Use requirements.
|
|
36
|
+
|
|
37
|
+
## What stays on your machine
|
|
38
|
+
|
|
39
|
+
The software stores project profiles, settings, OAuth tokens, caches, logs, and
|
|
40
|
+
saved reports in local user directories. `seo privacy` prints the relevant
|
|
41
|
+
paths and file permissions.
|
|
42
|
+
|
|
43
|
+
OAuth tokens use the operating system keychain when that option is enabled.
|
|
44
|
+
The fallback token file and any bring-your-own OAuth client file are written
|
|
45
|
+
with user-only file permissions. You are responsible for the security of your
|
|
46
|
+
device, backups, shell history, exported reports, and any environment variables
|
|
47
|
+
you create.
|
|
48
|
+
|
|
49
|
+
## Network requests
|
|
50
|
+
|
|
51
|
+
Commands connect directly from your machine to the services needed for the
|
|
52
|
+
work you request. These can include Google APIs, public pages and sitemaps you
|
|
53
|
+
choose to crawl, and the npm registry for package update checks. Those services
|
|
54
|
+
receive ordinary request data under their own privacy policies.
|
|
55
|
+
|
|
56
|
+
The CLI does not include project-controlled usage telemetry. Installing the
|
|
57
|
+
package through npm or using GitHub is covered by the policies of those
|
|
58
|
+
services.
|
|
59
|
+
|
|
60
|
+
The seoskills.dev host and security provider may process normal web request
|
|
61
|
+
data such as an IP address, user agent, requested path, and timestamp. Website
|
|
62
|
+
logs do not include the reports, tokens, or Google API responses stored by the
|
|
63
|
+
local software.
|
|
64
|
+
|
|
65
|
+
## Sharing and sale
|
|
66
|
+
|
|
67
|
+
The project maintainer does not receive or sell the Google user data processed
|
|
68
|
+
by the local software. The software sends data to Google only as needed to make
|
|
69
|
+
the API request you initiated. It sends crawl requests to the public sites you
|
|
70
|
+
ask it to inspect.
|
|
71
|
+
|
|
72
|
+
No local report is shared with another person or service unless you export,
|
|
73
|
+
copy, publish, or transmit it yourself.
|
|
74
|
+
|
|
75
|
+
## Removing local data and Google access
|
|
76
|
+
|
|
77
|
+
`seo auth logout` removes locally stored Google tokens. `seo reset --yes`
|
|
78
|
+
removes local SEO configuration, tokens, caches, logs, and saved data managed by
|
|
79
|
+
the tool.
|
|
80
|
+
|
|
81
|
+
You can also revoke the app from your [Google Account connections](https://myaccount.google.com/connections).
|
|
82
|
+
Deleting local files does not delete data held by Google, npm, GitHub, a site
|
|
83
|
+
you crawled, or your operating system backups.
|
|
84
|
+
|
|
85
|
+
## Changes to this policy
|
|
86
|
+
|
|
87
|
+
This policy will change if the product starts collecting data or adds a hosted
|
|
88
|
+
service. The date at the top will be updated when that happens. Earlier versions
|
|
89
|
+
remain available in the public Git history.
|
|
90
|
+
|
|
91
|
+
## Privacy questions
|
|
92
|
+
|
|
93
|
+
Open an issue in the [public GitHub repository](https://github.com/iannuttall/seo/issues).
|
|
94
|
+
Do not include OAuth tokens, private reports, personal data, or other secrets in
|
|
95
|
+
a public issue.
|
package/README.md
CHANGED
|
@@ -1,51 +1,354 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="apps/web/public/favicon.svg" alt="SEO Skills CLI" width="72" height="72">
|
|
3
|
+
</p>
|
|
2
4
|
|
|
3
|
-
|
|
4
|
-
snapshots of single page web apps for search bots. Uses [PhantomJS](http://phantomjs.org/)
|
|
5
|
-
for generating snapshots.
|
|
5
|
+
<h1 align="center">SEO Skills CLI</h1>
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
<p align="center">
|
|
8
|
+
Find what is costing you traffic, which pages are closest to more clicks, and what to fix first. Local SEO tools and skills for people, AI agents, and CI.
|
|
9
|
+
</p>
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
<p align="center">
|
|
12
|
+
<a href="#quick-start">Get started</a>
|
|
13
|
+
·
|
|
14
|
+
<a href="https://seoskills.dev/docs">Documentation</a>
|
|
15
|
+
·
|
|
16
|
+
<a href="https://www.npmjs.com/package/seo">npm</a>
|
|
17
|
+
·
|
|
18
|
+
<a href="https://github.com/iannuttall/seo/issues">Questions</a>
|
|
19
|
+
·
|
|
20
|
+
<a href="https://seoskills.dev/privacy">Privacy</a>
|
|
21
|
+
·
|
|
22
|
+
<a href="SECURITY.md">Security</a>
|
|
23
|
+
·
|
|
24
|
+
<a href="LICENSE">License</a>
|
|
25
|
+
·
|
|
26
|
+
<a href="AGENTS.md">Agent notes</a>
|
|
27
|
+
</p>
|
|
10
28
|
|
|
11
|
-
|
|
12
|
-
|
|
29
|
+
<p align="center">
|
|
30
|
+
<a href="https://github.com/iannuttall/seo/actions/workflows/ci.yml"><img alt="Checks" src="https://img.shields.io/github/actions/workflow/status/iannuttall/seo/ci.yml?branch=main&label=checks&style=flat-square"></a>
|
|
31
|
+
<a href="https://www.npmjs.com/package/seo"><img alt="npm version" src="https://img.shields.io/npm/v/seo?style=flat-square"></a>
|
|
32
|
+
<a href="https://www.npmjs.com/package/seo"><img alt="npm downloads" src="https://img.shields.io/npm/dm/seo?style=flat-square"></a>
|
|
33
|
+
<img alt="Node 22 or newer" src="https://img.shields.io/badge/Node-22%2B-339933?style=flat-square">
|
|
34
|
+
<img alt="TypeScript" src="https://img.shields.io/badge/TypeScript-ready-3178c6?style=flat-square">
|
|
35
|
+
<a href="LICENSE"><img alt="Apache 2.0 license" src="https://img.shields.io/badge/license-Apache--2.0-lightgrey?style=flat-square"></a>
|
|
36
|
+
</p>
|
|
37
|
+
|
|
38
|
+
`seo` turns a local crawl and your own search data into work you can inspect
|
|
39
|
+
and ship. Find technical blockers, recover search demand, improve pages already
|
|
40
|
+
close to more clicks, and catch regressions after a release.
|
|
41
|
+
|
|
42
|
+
## Quick start
|
|
43
|
+
|
|
44
|
+
Requires Node 22 or newer.
|
|
45
|
+
|
|
46
|
+
Install the command once, then add the skills when an agent will use it:
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
npm i -g seo
|
|
50
|
+
npx skills add iannuttall/seo --all
|
|
51
|
+
seo start
|
|
52
|
+
seo report
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
The setup walks you through Google sign-in, your Search Console property, an
|
|
56
|
+
optional GA4 property, and a local project profile. Public releases can include
|
|
57
|
+
the shared Google app. If it is unavailable in your build, setup guides you
|
|
58
|
+
through adding your own desktop OAuth client.
|
|
59
|
+
|
|
60
|
+
That is the normal path. `seo` is then available in every terminal, script,
|
|
61
|
+
CI job, and local MCP client on the machine.
|
|
62
|
+
|
|
63
|
+
The main report uses the evidence you have, explains what it could not check,
|
|
64
|
+
and recommends a short list of follow-up commands. You can start with a local
|
|
65
|
+
technical report before connecting Google.
|
|
66
|
+
|
|
67
|
+
## What you get
|
|
68
|
+
|
|
69
|
+
- Find technical blockers across metadata, links, indexability, canonicals,
|
|
70
|
+
structured data, performance, security, mobile, international SEO, and
|
|
71
|
+
social previews.
|
|
72
|
+
- Rank the work using affected URLs, rule severity, search visibility, and
|
|
73
|
+
analytics value instead of treating every warning equally.
|
|
74
|
+
- See why a finding matters, what evidence supports it, how to fix it, and how
|
|
75
|
+
to verify the change.
|
|
76
|
+
- Save and compare crawl reports without running the same crawl again.
|
|
77
|
+
- Measure SEO changes with matched before and after Search Console windows.
|
|
78
|
+
- Give scripts and agents deterministic JSON, Markdown, stable rule IDs, and a
|
|
79
|
+
compact local MCP surface.
|
|
80
|
+
|
|
81
|
+
## Everyday use
|
|
82
|
+
|
|
83
|
+
`seo start` can save a project profile, which is a local shortcut for a site,
|
|
84
|
+
Search Console property, GA4 property, and brand terms. If you have one default
|
|
85
|
+
project, most commands need no flags.
|
|
86
|
+
|
|
87
|
+
```sh
|
|
88
|
+
seo report
|
|
89
|
+
seo refresh-priorities
|
|
90
|
+
seo quick-wins
|
|
91
|
+
seo second-page
|
|
92
|
+
seo technical-watch
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
Use `--project` when you have more than one:
|
|
96
|
+
|
|
97
|
+
```sh
|
|
98
|
+
seo report --project example
|
|
99
|
+
seo projects list
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
You can also work without a saved profile:
|
|
103
|
+
|
|
104
|
+
```sh
|
|
105
|
+
seo report --site sc-domain:example.com
|
|
106
|
+
seo report --url https://example.com
|
|
107
|
+
seo crawl https://example.com
|
|
108
|
+
seo audit-page --url https://example.com/pricing
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
`seo report --url` crawls the site and saves technical evidence. It does not
|
|
112
|
+
pretend to know traffic, queries, or rankings until you add a Search Console
|
|
113
|
+
property with `seo start`.
|
|
114
|
+
|
|
115
|
+
Run `seo help` for the short path or `seo help all` for the full command list.
|
|
116
|
+
|
|
117
|
+
## Crawl a site
|
|
118
|
+
|
|
119
|
+
Run a readable technical crawl:
|
|
120
|
+
|
|
121
|
+
```sh
|
|
122
|
+
seo crawl https://example.com --format pretty
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Save it, export it, or compare it with an earlier crawl:
|
|
126
|
+
|
|
127
|
+
```sh
|
|
128
|
+
seo crawl https://example.com --save
|
|
129
|
+
seo crawl https://example.com --format html --output report.html
|
|
130
|
+
seo crawl-reports
|
|
131
|
+
seo crawl-reports --compare latest --against previous
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
Useful crawl controls include `--max-pages`, `--max-depth`, `--include`,
|
|
135
|
+
`--exclude`, `--no-sitemap`, `--no-external`, and `--fail-on` for CI.
|
|
136
|
+
|
|
137
|
+
## Use it in CI and scripts
|
|
138
|
+
|
|
139
|
+
JSON mode never prompts. Pass the site or project explicitly in unattended
|
|
140
|
+
runs.
|
|
141
|
+
|
|
142
|
+
```sh
|
|
143
|
+
seo report --project example --json
|
|
144
|
+
seo crawl https://example.com --json --output crawl.json
|
|
145
|
+
seo crawl https://example.com --fail-on high --json
|
|
13
146
|
```
|
|
14
147
|
|
|
15
|
-
|
|
148
|
+
Reports keep observed data, derived findings, skipped sections, limits, and
|
|
149
|
+
provider errors separate so automation can make decisions without parsing
|
|
150
|
+
terminal prose.
|
|
151
|
+
|
|
152
|
+
`seo report --json` returns a compact summary, action queue, and bounded crawl
|
|
153
|
+
evidence so an agent can choose its next call without loading every raw report.
|
|
154
|
+
Use `--full` only when a script needs the complete report object.
|
|
155
|
+
|
|
156
|
+
When a CI job needs Search Console or GA4 data, give it a Google service
|
|
157
|
+
account JSON key through its secret store. The service account needs access to
|
|
158
|
+
the exact properties it will query. This GitHub Actions step runs without a
|
|
159
|
+
browser or a copied local token:
|
|
16
160
|
|
|
17
|
-
|
|
161
|
+
```yaml
|
|
162
|
+
- name: Run the SEO report
|
|
163
|
+
run: |
|
|
164
|
+
npm i -g seo
|
|
165
|
+
seo report --site sc-domain:example.com --json > seo-report.json
|
|
166
|
+
env:
|
|
167
|
+
SEO_GOOGLE_SERVICE_ACCOUNT_JSON: ${{ secrets.SEO_GOOGLE_SERVICE_ACCOUNT_JSON }}
|
|
168
|
+
```
|
|
18
169
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
var app = express();
|
|
170
|
+
The [Google data guide](https://seoskills.dev/docs/google) covers Search
|
|
171
|
+
Console and GA4 permissions, mounted secret files, and how to check the active
|
|
172
|
+
identity safely.
|
|
23
173
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
routes: require('./seo-routes'),
|
|
27
|
-
requestURL: 'http://localhost:8080',
|
|
28
|
-
pageModifier: function (page, callback) {
|
|
29
|
-
// This function can be used to modify a page before it is cached
|
|
30
|
-
// `page` is an instance of PhantomJS's Page object. For an example
|
|
31
|
-
// see `test/middleware.test.js`
|
|
32
|
-
}
|
|
33
|
-
}).init());
|
|
174
|
+
Agents can discover and run the same report catalog as MCP without starting a
|
|
175
|
+
server:
|
|
34
176
|
|
|
35
|
-
|
|
177
|
+
```sh
|
|
178
|
+
seo reports list --category crawl --json
|
|
179
|
+
seo reports describe audit-page --json
|
|
180
|
+
seo reports run audit-page --params '{"url":"https://example.com"}' --json
|
|
36
181
|
```
|
|
37
182
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
183
|
+
Always describe a report before constructing its parameters. The CLI and MCP
|
|
184
|
+
surfaces read from the same registry, so their ids and JSON Schemas cannot
|
|
185
|
+
drift.
|
|
186
|
+
|
|
187
|
+
## Use it with AI agents
|
|
188
|
+
|
|
189
|
+
Agents work best with both parts of the project. The `seo` package runs the
|
|
190
|
+
reports. The skills teach an agent which report to choose, how to read it, and
|
|
191
|
+
what to verify before changing a site.
|
|
41
192
|
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
return false;
|
|
46
|
-
}
|
|
193
|
+
```sh
|
|
194
|
+
npm i -g seo
|
|
195
|
+
npx skills add iannuttall/seo --all
|
|
47
196
|
```
|
|
48
197
|
|
|
49
|
-
|
|
198
|
+
Then install the local stdio MCP server into a supported client:
|
|
199
|
+
|
|
200
|
+
```sh
|
|
201
|
+
seo mcp install
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
The prompt detects installed clients. Scripts can choose one or more explicitly:
|
|
205
|
+
|
|
206
|
+
```sh
|
|
207
|
+
seo mcp install --codex
|
|
208
|
+
seo mcp install --claude-code
|
|
209
|
+
seo mcp install --cursor
|
|
210
|
+
seo mcp install --claude-desktop
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
Your client starts the server when it needs it. Run it directly only for manual
|
|
214
|
+
configuration or testing:
|
|
215
|
+
|
|
216
|
+
```sh
|
|
217
|
+
seo mcp serve
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
The repository ships the focused instructions under `skills/`. They teach
|
|
221
|
+
agents when to discover reports, inspect evidence, and request a smaller
|
|
222
|
+
follow-up instead of loading a giant result into context.
|
|
223
|
+
|
|
224
|
+
The npm package includes the same files for local inspection:
|
|
225
|
+
|
|
226
|
+
```sh
|
|
227
|
+
seo skills list
|
|
228
|
+
seo skills path quick-wins
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
Agents can also discover the complete skill catalog from
|
|
232
|
+
`https://seoskills.dev/.well-known/agent-skills/index.json`. Each entry links to
|
|
233
|
+
the canonical skill instructions and includes a content digest for verification.
|
|
234
|
+
|
|
235
|
+
See [MCP and agents](https://seoskills.dev/docs/agents) for setup and tool
|
|
236
|
+
details.
|
|
237
|
+
|
|
238
|
+
## Use it as a library
|
|
239
|
+
|
|
240
|
+
Install the same unscoped package in any Node 22 or newer project:
|
|
241
|
+
|
|
242
|
+
```sh
|
|
243
|
+
npm install seo
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
Run any public report by id with the same definition, input schema, and
|
|
247
|
+
evidence used by the CLI and MCP server:
|
|
248
|
+
|
|
249
|
+
```ts
|
|
250
|
+
import { describeReport, executeReport } from 'seo/mcp'
|
|
251
|
+
|
|
252
|
+
const description = describeReport('quick-wins')
|
|
253
|
+
const result = await executeReport('quick-wins', {
|
|
254
|
+
site: 'sc-domain:example.com',
|
|
255
|
+
days: 90,
|
|
256
|
+
})
|
|
257
|
+
|
|
258
|
+
console.log(description.inputSchema)
|
|
259
|
+
console.log(result)
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
Or call typed analysis functions directly when your app already knows the job
|
|
263
|
+
it needs to run:
|
|
264
|
+
|
|
265
|
+
```ts
|
|
266
|
+
import { auditPage, crawlSite } from 'seo'
|
|
267
|
+
|
|
268
|
+
const page = await auditPage({
|
|
269
|
+
url: 'https://example.com/pricing',
|
|
270
|
+
})
|
|
271
|
+
|
|
272
|
+
const crawl = await crawlSite({
|
|
273
|
+
url: 'https://example.com',
|
|
274
|
+
maxPages: 100,
|
|
275
|
+
maxDepth: 4,
|
|
276
|
+
})
|
|
277
|
+
|
|
278
|
+
console.log(page.issues)
|
|
279
|
+
console.log(crawl.summary, crawl.issueGroups)
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
The main `seo` export contains the report, provider, crawler, storage, and
|
|
283
|
+
rendering APIs. `seo/mcp` exposes report discovery, report execution, and the
|
|
284
|
+
embeddable MCP server. See the [TypeScript library
|
|
285
|
+
guide](https://seoskills.dev/docs/library) for structured error handling,
|
|
286
|
+
local Google access, and more examples.
|
|
287
|
+
|
|
288
|
+
## Local data and Google access
|
|
289
|
+
|
|
290
|
+
Google OAuth tokens use your system keychain when it is available. On a
|
|
291
|
+
headless machine or a locked keychain, SEO Skills CLI falls back to a private
|
|
292
|
+
`0600` file in your user config directory. Project profiles, crawl reports, and
|
|
293
|
+
provider caches are also local. Use these commands to inspect or remove them:
|
|
294
|
+
|
|
295
|
+
```sh
|
|
296
|
+
seo privacy
|
|
297
|
+
seo doctor
|
|
298
|
+
seo auth logout
|
|
299
|
+
seo reset
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
`seo auth status` shows the active storage mode. Power users can choose it with
|
|
303
|
+
`seo auth storage --keychain` or `seo auth storage --file`.
|
|
304
|
+
|
|
305
|
+
Power users can bring their own Google OAuth client. See
|
|
306
|
+
[getting started](https://seoskills.dev/docs/getting-started) for the available
|
|
307
|
+
auth paths.
|
|
308
|
+
|
|
309
|
+
## Documentation
|
|
310
|
+
|
|
311
|
+
Questions, bug reports, and feature requests go through
|
|
312
|
+
[GitHub Issues](https://github.com/iannuttall/seo/issues). Report suspected
|
|
313
|
+
vulnerabilities privately through the process in [SECURITY.md](SECURITY.md).
|
|
314
|
+
|
|
315
|
+
- [Getting started](https://seoskills.dev/docs/getting-started)
|
|
316
|
+
- [CLI commands](https://seoskills.dev/docs/cli)
|
|
317
|
+
- [Crawler](https://seoskills.dev/docs/crawler)
|
|
318
|
+
- [Reports and data](https://seoskills.dev/docs/reports)
|
|
319
|
+
- [MCP and agents](https://seoskills.dev/docs/agents)
|
|
320
|
+
- [AI-search evidence](https://seoskills.dev/docs/ai-search)
|
|
321
|
+
- [Privacy policy](https://seoskills.dev/privacy)
|
|
322
|
+
- [Terms of use](https://seoskills.dev/terms)
|
|
323
|
+
- [Security policy](https://seoskills.dev/security)
|
|
324
|
+
- [Contributing](CONTRIBUTING.md)
|
|
325
|
+
- [Trademark and brand policy](TRADEMARKS.md)
|
|
326
|
+
|
|
327
|
+
## Develop locally
|
|
328
|
+
|
|
329
|
+
Most users do not need the source checkout. If you want to contribute:
|
|
330
|
+
|
|
331
|
+
```sh
|
|
332
|
+
git clone https://github.com/iannuttall/seo.git
|
|
333
|
+
cd seo
|
|
334
|
+
pnpm install
|
|
335
|
+
pnpm build
|
|
336
|
+
node dist/cli.js start --dry-run
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
Run the full quality gate before opening a pull request:
|
|
340
|
+
|
|
341
|
+
```sh
|
|
342
|
+
pnpm build
|
|
343
|
+
pnpm typecheck
|
|
344
|
+
pnpm test
|
|
345
|
+
pnpm lint
|
|
346
|
+
pnpm pack --dry-run
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
Contributor architecture and report-quality rules live in [AGENTS.md](AGENTS.md).
|
|
350
|
+
|
|
351
|
+
## License
|
|
50
352
|
|
|
51
|
-
|
|
353
|
+
The code is available under [Apache-2.0](LICENSE). Project names and artwork are
|
|
354
|
+
covered separately by the [trademark and brand policy](TRADEMARKS.md).
|