factoryhub 0.0.0-stage → 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 +202 -0
- package/NOTICE +16 -0
- package/README.md +189 -2
- package/factories/README.md +17 -0
- package/factories/client-file-readiness/README.md +3 -0
- package/factories/client-file-readiness/agents/analyst/agent.md +10 -0
- package/factories/client-file-readiness/agents/reviewer/agent.md +10 -0
- package/factories/client-file-readiness/agents/writer/agent.md +11 -0
- package/factories/client-file-readiness/factory.yaml +12 -0
- package/factories/client-file-readiness/flow.yaml +56 -0
- package/factories/competitor-teardown/README.md +3 -0
- package/factories/competitor-teardown/agents/analyst/agent.md +10 -0
- package/factories/competitor-teardown/agents/researcher/agent.md +11 -0
- package/factories/competitor-teardown/agents/reviewer/agent.md +10 -0
- package/factories/competitor-teardown/agents/writer/agent.md +11 -0
- package/factories/competitor-teardown/factory.yaml +11 -0
- package/factories/competitor-teardown/flow.yaml +75 -0
- package/factories/homepage-audit/README.md +3 -0
- package/factories/homepage-audit/agents/analyst/agent.md +10 -0
- package/factories/homepage-audit/agents/researcher/agent.md +11 -0
- package/factories/homepage-audit/agents/reviewer/agent.md +10 -0
- package/factories/homepage-audit/agents/writer/agent.md +11 -0
- package/factories/homepage-audit/factory.yaml +11 -0
- package/factories/homepage-audit/flow.yaml +77 -0
- package/factories/inbox-triage/README.md +3 -0
- package/factories/inbox-triage/agents/analyst/agent.md +10 -0
- package/factories/inbox-triage/agents/reviewer/agent.md +10 -0
- package/factories/inbox-triage/agents/writer/agent.md +11 -0
- package/factories/inbox-triage/factory.yaml +11 -0
- package/factories/inbox-triage/flow.yaml +57 -0
- package/factories/index.json +356 -0
- package/factories/launch-kit/README.md +3 -0
- package/factories/launch-kit/agents/reviewer/agent.md +10 -0
- package/factories/launch-kit/agents/strategist/agent.md +10 -0
- package/factories/launch-kit/agents/writer/agent.md +11 -0
- package/factories/launch-kit/factory.yaml +12 -0
- package/factories/launch-kit/flow.yaml +75 -0
- package/factories/meeting-to-actions/CHANGELOG.md +7 -0
- package/factories/meeting-to-actions/README.md +15 -0
- package/factories/meeting-to-actions/agents/analyst/agent.md +10 -0
- package/factories/meeting-to-actions/agents/reviewer/agent.md +10 -0
- package/factories/meeting-to-actions/agents/writer/agent.md +11 -0
- package/factories/meeting-to-actions/factory.yaml +11 -0
- package/factories/meeting-to-actions/flow.yaml +53 -0
- package/factories/meeting-to-actions/mindburn.requirements.yaml +8 -0
- package/factories/meeting-to-actions/mindburn.tests.yaml +16 -0
- package/factories/outreach-pack/README.md +3 -0
- package/factories/outreach-pack/agents/reviewer/agent.md +5 -0
- package/factories/outreach-pack/agents/writer/agent.md +5 -0
- package/factories/outreach-pack/factory.yaml +9 -0
- package/factories/outreach-pack/flow.yaml +42 -0
- package/factories/prospect-brief/README.md +3 -0
- package/factories/prospect-brief/agents/researcher/agent.md +11 -0
- package/factories/prospect-brief/agents/reviewer/agent.md +10 -0
- package/factories/prospect-brief/agents/strategist/agent.md +10 -0
- package/factories/prospect-brief/agents/writer/agent.md +11 -0
- package/factories/prospect-brief/factory.yaml +11 -0
- package/factories/prospect-brief/flow.yaml +79 -0
- package/package.json +79 -4
- package/packages/cli/bin/factoryhub.mjs +8 -0
- package/packages/cli/package.json +29 -0
- package/packages/cli/src/args.mjs +47 -0
- package/packages/cli/src/commands/export.mjs +55 -0
- package/packages/cli/src/commands/get.mjs +38 -0
- package/packages/cli/src/commands/inspect.mjs +66 -0
- package/packages/cli/src/commands/list.mjs +29 -0
- package/packages/cli/src/commands/mcp.mjs +26 -0
- package/packages/cli/src/commands/new.mjs +148 -0
- package/packages/cli/src/commands/pack.mjs +97 -0
- package/packages/cli/src/commands/resume.mjs +67 -0
- package/packages/cli/src/commands/run.mjs +190 -0
- package/packages/cli/src/commands/search.mjs +31 -0
- package/packages/cli/src/commands/validate.mjs +81 -0
- package/packages/cli/src/main.mjs +68 -0
- package/packages/cli/src/util.mjs +21 -0
- package/packages/engine/lib/catalog.mjs +50 -0
- package/packages/engine/lib/hub.mjs +71 -0
- package/packages/engine/lib/node.mjs +114 -0
- package/packages/engine/lib/providers.mjs +52 -0
- package/packages/engine/lib/run.mjs +131 -0
- package/packages/engine/lib/skill.mjs +229 -0
- package/packages/engine/package.json +39 -0
- package/packages/engine/src/author-tests.mjs +78 -0
- package/packages/engine/src/compose.mjs +150 -0
- package/packages/engine/src/cost.mjs +41 -0
- package/packages/engine/src/diagnostics.mjs +21 -0
- package/packages/engine/src/factory-engine.mjs +1762 -0
- package/packages/engine/src/index.mjs +9 -0
- package/packages/engine/src/markdown.mjs +97 -0
- package/packages/engine/src/package.mjs +116 -0
- package/packages/engine/src/run.mjs +232 -0
- package/packages/mcp/bin/factoryhub-mcp.mjs +6 -0
- package/packages/mcp/package.json +36 -0
- package/packages/mcp/src/server.mjs +280 -0
- package/spec/README.md +36 -0
- package/spec/factory-format.md +621 -0
- package/spec/schema/factory.schema.json +43 -0
- package/spec/schema/flow.schema.json +169 -0
- package/spec/skill-export.md +126 -0
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,16 @@
|
|
|
1
|
+
factoryhub
|
|
2
|
+
Copyright Mindburn Labs
|
|
3
|
+
|
|
4
|
+
This product is licensed under the Apache License, Version 2.0 (LICENSE),
|
|
5
|
+
with two exceptions:
|
|
6
|
+
|
|
7
|
+
- The factories in factories/ each declare their own license in their
|
|
8
|
+
flow.yaml. The eight house factories declare MIT.
|
|
9
|
+
- The ClawHub skill files in integrations/openclaw/factoryhub/ (SKILL.md and
|
|
10
|
+
README.md) are released under MIT No Attribution (MIT-0), because ClawHub
|
|
11
|
+
publishes every skill under MIT-0. Their README holds the license text.
|
|
12
|
+
|
|
13
|
+
The factoryhub name and the artwork in assets/ (and its copy in
|
|
14
|
+
integrations/claude-code-plugin/assets/) identify this project. As
|
|
15
|
+
section 6 of the Apache License says, the license grants no permission to use
|
|
16
|
+
them except to describe where the work comes from.
|
package/README.md
CHANGED
|
@@ -1,3 +1,190 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<picture>
|
|
3
|
+
<source media="(prefers-color-scheme: dark)" srcset="assets/factoryhub-horizontal-inverse.svg">
|
|
4
|
+
<img alt="factoryhub. AI factories, shared. Find a factory. Make it yours." src="assets/factoryhub-social-1200x630.png" width="720">
|
|
5
|
+
</picture>
|
|
6
|
+
</p>
|
|
2
7
|
|
|
3
|
-
|
|
8
|
+
<h3 align="center">AI factories, shared.</h3>
|
|
9
|
+
|
|
10
|
+
<p align="center">
|
|
11
|
+
The open format, engine, command line and MCP server for AI factories:<br>
|
|
12
|
+
small teams of AI agents written as plain files that anyone can read, run, change and share.
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
<p align="center">
|
|
16
|
+
<a href="docs/quickstart.md">Quickstart</a> ·
|
|
17
|
+
<a href="docs/README.md">Docs</a> ·
|
|
18
|
+
<a href="spec/factory-format.md">Spec</a> ·
|
|
19
|
+
<a href="#the-house-factories">Factories</a> ·
|
|
20
|
+
<a href="integrations/README.md">Integrations</a> ·
|
|
21
|
+
<a href="CONTRIBUTING.md">Contributing</a>
|
|
22
|
+
</p>
|
|
23
|
+
|
|
24
|
+
<p align="center">
|
|
25
|
+
<a href="LICENSE"><img alt="License: Apache-2.0" src="https://img.shields.io/badge/license-Apache--2.0-blue"></a>
|
|
26
|
+
<img alt="Node.js 22 or newer" src="https://img.shields.io/badge/node-%E2%89%A522-339933">
|
|
27
|
+
<a href="spec/factory-format.md"><img alt="Format: v1alpha1" src="https://img.shields.io/badge/format-v1alpha1-orange"></a>
|
|
28
|
+
</p>
|
|
29
|
+
|
|
30
|
+
## What a factory is
|
|
31
|
+
|
|
32
|
+
A factory turns what a person gives into a finished, checked document. It
|
|
33
|
+
says who does what, in what order, what gets checked, and where the person
|
|
34
|
+
decides, in three kinds of plain files:
|
|
35
|
+
|
|
36
|
+
```text
|
|
37
|
+
meeting-to-actions/
|
|
38
|
+
factory.yaml name and what it is for
|
|
39
|
+
flow.yaml inputs and steps
|
|
40
|
+
agents/<name>/agent.md one role per agent
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Here is part of a real one, [`factories/meeting-to-actions/flow.yaml`](factories/meeting-to-actions/flow.yaml),
|
|
44
|
+
with some fields left out and its task texts shortened:
|
|
45
|
+
|
|
46
|
+
```yaml
|
|
47
|
+
flow: mindburn.flow/v1
|
|
48
|
+
title: Meeting to actions
|
|
49
|
+
version: "1.1.1"
|
|
50
|
+
inputs:
|
|
51
|
+
notes:
|
|
52
|
+
type: longtext
|
|
53
|
+
help: "The meeting notes or transcript, as rough as they are."
|
|
54
|
+
steps:
|
|
55
|
+
extraction:
|
|
56
|
+
title: Extract what was agreed
|
|
57
|
+
agent: analyst
|
|
58
|
+
kind: work
|
|
59
|
+
task: |
|
|
60
|
+
Read the notes and pull out four lists. Decisions: ...
|
|
61
|
+
followup:
|
|
62
|
+
title: Write the follow-up
|
|
63
|
+
agent: writer
|
|
64
|
+
kind: deliver
|
|
65
|
+
needs: [extraction]
|
|
66
|
+
task: |
|
|
67
|
+
Write the follow-up. Sections, in this order: ...
|
|
68
|
+
check_extraction:
|
|
69
|
+
title: Check against the notes
|
|
70
|
+
agent: reviewer
|
|
71
|
+
kind: check
|
|
72
|
+
needs: [followup]
|
|
73
|
+
checks: followup
|
|
74
|
+
task: |
|
|
75
|
+
Compare the entire follow-up with the original notes. ...
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Steps run in the order their `needs` allow, in parallel where they can. A
|
|
79
|
+
`check` sends weak work back to be redone. An `approve` step stops the run
|
|
80
|
+
until the person decides; nothing decides for them unless they ask for it
|
|
81
|
+
with `--yes`. Every finished run
|
|
82
|
+
writes a receipt: the hash of the factory, every step, every check verdict,
|
|
83
|
+
every decision and the deliverable. [Concepts](docs/concepts.md) explains the
|
|
84
|
+
parts; [the spec](spec/factory-format.md) has every field.
|
|
85
|
+
|
|
86
|
+
## Quickstart
|
|
87
|
+
|
|
88
|
+
You need Node.js 22 or newer and git.
|
|
89
|
+
|
|
90
|
+
```sh
|
|
91
|
+
git clone https://github.com/Mindburn-Labs/factoryhub && cd factoryhub
|
|
92
|
+
npm ci
|
|
93
|
+
npx factoryhub inspect meeting-to-actions
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Then run it with your own model key, or a model on your machine:
|
|
97
|
+
|
|
98
|
+
```sh
|
|
99
|
+
export ANTHROPIC_API_KEY=... # or OPENAI_API_KEY, or OPENROUTER_API_KEY
|
|
100
|
+
npx factoryhub run meeting-to-actions -i notes=@notes.txt
|
|
101
|
+
|
|
102
|
+
npx factoryhub run meeting-to-actions --provider ollama --model <model>
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Make your own with `npx factoryhub new my-factory`; it validates and runs from
|
|
106
|
+
the start. More in the [quickstart](docs/quickstart.md).
|
|
107
|
+
|
|
108
|
+
## What is in this repository
|
|
109
|
+
|
|
110
|
+
| Part | What it does |
|
|
111
|
+
|---|---|
|
|
112
|
+
| [`spec/`](spec) | The factory format v1alpha1: a readable [specification](spec/factory-format.md), JSON Schemas for `factory.yaml` and `flow.yaml`, conformance fixtures that test the schemas against the engine, the [skill export](spec/skill-export.md) mapping, and an [RFC process](spec/rfcs/README.md). |
|
|
113
|
+
| [`packages/engine`](packages/engine) | The engine with no dependencies: parses a factory, runs its flow on Anthropic or any OpenAI-compatible model, writes and verifies receipts. The factoryhub site runs the same engine code. |
|
|
114
|
+
| [`packages/cli`](packages/cli) | `factoryhub`: `list`, `inspect`, `validate`, `run`, `resume`, `new`, `pack`, `export --as skill`, `search`, `get`. [Reference](docs/cli.md). |
|
|
115
|
+
| [`packages/mcp`](packages/mcp) | A local stdio MCP server: list, read, validate, export and run factories from any MCP client. Runs stop at every decision and resume with the person's answer. [Reference](docs/mcp.md). |
|
|
116
|
+
| [`factories/`](factories) | The house factories, each checked by `npm run validate` and the CI workflow, with a generated [`index.json`](factories/index.json). |
|
|
117
|
+
| [`integrations/`](integrations) | An Agent Skill, a Claude Code plugin, OpenClaw and Hermes Agent skills, MCP client entries, and nine examples for seven agent frameworks. |
|
|
118
|
+
|
|
119
|
+
## The house factories
|
|
120
|
+
|
|
121
|
+
<!-- factories:start -->
|
|
122
|
+
<!-- Generated by scripts/generate.mjs from factories/. -->
|
|
123
|
+
|
|
124
|
+
| Factory | What it does | Inputs required | Steps | Asks you to approve | Web tools |
|
|
125
|
+
|---|---|---|---|---|---|
|
|
126
|
+
| [`client-file-readiness`](factories/client-file-readiness) | Compares what a client sent against your checklist, reports what is missing, from the wrong period or unclear, and drafts the message asking for it. | 3 of 4 | 3 | no | none |
|
|
127
|
+
| [`competitor-teardown`](factories/competitor-teardown) | Reads your website and up to three competitors, then writes a decision-ready brief showing where you win, where you lose and what to change this week. | 2 of 3 | 5 | no | web_fetch, web_search |
|
|
128
|
+
| [`homepage-audit`](factories/homepage-audit) | Reads your home page the way a first-time visitor does and returns a prioritised list of fixes with the exact new wording. | 1 of 3 | 4 | no | web_fetch |
|
|
129
|
+
| [`inbox-triage`](factories/inbox-triage) | Sorts a batch of customer messages by urgency and type, drafts a reply to each in your tone, and lists what needs a human decision. | 2 of 3 | 4 | no | none |
|
|
130
|
+
| [`launch-kit`](factories/launch-kit) | Turns a product description into a launch kit with positioning, a landing page draft, a launch email, three follow-ups and posts for social channels, all in one voice. | 2 of 5 | 6 | yes | web_fetch |
|
|
131
|
+
| [`meeting-to-actions`](factories/meeting-to-actions) | Turns rough meeting notes or a transcript into decisions, owned actions with dates, open questions and a follow-up message ready to send. | 1 of 2 | 3 | no | none |
|
|
132
|
+
| [`outreach-pack`](factories/outreach-pack) | Turns checked market research and launch materials into an outreach pack. | 2 of 3 | 3 | no | none |
|
|
133
|
+
| [`prospect-brief`](factories/prospect-brief) | Researches one company you want to sell to and writes a one-page brief plus a first email and follow-up that mention real, checkable facts about them. | 2 of 3 | 7 | yes | web_fetch, web_search |
|
|
134
|
+
|
|
135
|
+
<!-- factories:end -->
|
|
136
|
+
|
|
137
|
+
Add yours: [a factory in five minutes](CONTRIBUTING.md#add-a-factory-in-five-minutes).
|
|
138
|
+
|
|
139
|
+
## Use it from your agent
|
|
140
|
+
|
|
141
|
+
Each integration is marked with what was actually tested at this commit.
|
|
142
|
+
"Tested locally" means exercised on a maintainer's machine with the version
|
|
143
|
+
and result recorded in the [status matrix](integrations/README.md#status);
|
|
144
|
+
"documented only" means written from the tool's current docs and not
|
|
145
|
+
exercised. CI has not run yet, so nothing is marked "tested in CI".
|
|
146
|
+
|
|
147
|
+
| Where | How | Status |
|
|
148
|
+
|---|---|---|
|
|
149
|
+
| Claude Code | [plugin](integrations/claude-code-plugin) with the skill and the MCP server | tested locally |
|
|
150
|
+
| Gemini CLI | [MCP entry](integrations/mcp-clients/gemini.settings.json) | tested locally |
|
|
151
|
+
| Codex | [MCP entry](integrations/mcp-clients/codex.config.toml) | documented only |
|
|
152
|
+
| Cursor | [MCP entry](integrations/mcp-clients/cursor.mcp.json) | documented only |
|
|
153
|
+
| VS Code | [MCP entry](integrations/mcp-clients/vscode.mcp.json) | documented only |
|
|
154
|
+
| Claude Desktop | [MCP entry](integrations/mcp-clients/claude-desktop.json) | documented only |
|
|
155
|
+
| OpenClaw | [skill](integrations/openclaw/factoryhub/SKILL.md) | tested locally (`skills-ref` validator) |
|
|
156
|
+
| Hermes Agent | [skill](integrations/hermes/factoryhub/SKILL.md) | tested locally (its parser, validator and skills guard) |
|
|
157
|
+
| Any agent that reads skills | [Agent Skill](integrations/agent-skills/factoryhub/SKILL.md), or `factoryhub export --as skill` | tested locally (`skills-ref` validator) |
|
|
158
|
+
| Vercel AI SDK, OpenAI Agents SDK (JS and Python), LangChain (JS and Python), smolagents, Hugging Face, CrewAI, LlamaIndex | [framework examples](integrations/frameworks) over MCP | listing tools: tested locally; agents: documented only |
|
|
159
|
+
|
|
160
|
+
Setup for each: [docs/integrations.md](docs/integrations.md).
|
|
161
|
+
|
|
162
|
+
## factory.mindburn.org
|
|
163
|
+
|
|
164
|
+
Mindburn Labs runs a hosted factoryhub at factory.mindburn.org, currently in
|
|
165
|
+
private preview. `factoryhub search` and `factoryhub get` read its published
|
|
166
|
+
catalogue; while the preview lasts they need the access key you were given,
|
|
167
|
+
in `FACTORYHUB_ACCESS_KEY`. Everything else in this repository works without
|
|
168
|
+
it.
|
|
169
|
+
|
|
170
|
+
## Contributing
|
|
171
|
+
|
|
172
|
+
Contributions are welcome: factories, fixes, docs, integrations and format
|
|
173
|
+
proposals. Start with [CONTRIBUTING.md](CONTRIBUTING.md). Changes to the
|
|
174
|
+
format go through [RFCs](spec/rfcs/README.md). The [roadmap](ROADMAP.md) lists
|
|
175
|
+
what comes next.
|
|
176
|
+
|
|
177
|
+
## Community
|
|
178
|
+
|
|
179
|
+
- [Code of Conduct](CODE_OF_CONDUCT.md)
|
|
180
|
+
- [Governance](GOVERNANCE.md)
|
|
181
|
+
- [Getting help](SUPPORT.md)
|
|
182
|
+
- [Security](SECURITY.md): report vulnerabilities privately
|
|
183
|
+
- [Changelog](CHANGELOG.md)
|
|
184
|
+
|
|
185
|
+
## License
|
|
186
|
+
|
|
187
|
+
[Apache-2.0](LICENSE). Each factory declares its own license in its
|
|
188
|
+
`flow.yaml`; the house factories declare MIT. The ClawHub skill files in
|
|
189
|
+
[`integrations/openclaw/factoryhub`](integrations/openclaw/factoryhub) are
|
|
190
|
+
MIT-0, as ClawHub requires. See [NOTICE](NOTICE).
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# House factories
|
|
2
|
+
|
|
3
|
+
The factories that ship with factoryhub. `factoryhub list` lists them,
|
|
4
|
+
`factoryhub inspect <id>` explains one, and [`index.json`](index.json) is the
|
|
5
|
+
generated catalogue with each factory's hash.
|
|
6
|
+
|
|
7
|
+
These folders hold the same source files the factoryhub site has for these
|
|
8
|
+
factories. With the foreman the engine writes from each flow, their hashes
|
|
9
|
+
match the site's. Their own READMEs were written for the site: where one says
|
|
10
|
+
to run an example "on the Hub", that means factory.mindburn.org, which is in
|
|
11
|
+
private preview. Cost figures in a `mindburn.requirements.yaml` are the
|
|
12
|
+
author's estimates from hosted trial runs and were not measured in this
|
|
13
|
+
repository; run the examples yourself with `node run.mjs --test` in a packed
|
|
14
|
+
factory.
|
|
15
|
+
|
|
16
|
+
To add a factory, see
|
|
17
|
+
[CONTRIBUTING.md](../CONTRIBUTING.md#add-a-factory-in-five-minutes).
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Turns raw material into structured findings that can be checked.
|
|
3
|
+
agentType: CUSTOM
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
You are the analyst. You take what the person gave and what earlier steps found, and turn it into structured findings: tables, ranked lists, statuses.
|
|
7
|
+
|
|
8
|
+
- Every finding points at the exact words, file or fact it rests on.
|
|
9
|
+
- You never assume what the material does not show. Where something cannot be told, you say what is missing.
|
|
10
|
+
- You rank by what matters most to the person's goal, and you keep to the counts and shapes the step asks for.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Checks work against stated criteria and sends weak work back.
|
|
3
|
+
agentType: REVIEW
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
You are the reviewer. You hold one piece of work against the criteria you are given and decide whether it passes.
|
|
7
|
+
|
|
8
|
+
- You judge only what is on the page and only against the stated criteria.
|
|
9
|
+
- You fail work for a clear, specific breach you can point to. You never fail it for taste, or for something nobody asked for.
|
|
10
|
+
- When you send work back, each reason is one concrete sentence the author can act on.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Writes the finished words the person will use or send.
|
|
3
|
+
agentType: CUSTOM
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
You are the writer. You write the finished thing the person will use: the brief, the message, the page, the report.
|
|
7
|
+
|
|
8
|
+
- Plain words, short sentences, the reader's own vocabulary. No filler and no hype.
|
|
9
|
+
- You keep to the sections, word limits and order the step asks for.
|
|
10
|
+
- You add no fact that is not in the inputs or earlier results. Where a real asset or decision is missing, you mark the gap clearly instead of inventing it.
|
|
11
|
+
- What you write should be usable as it stands.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
schemaVersion: v1alpha1
|
|
2
|
+
name: client-file-readiness
|
|
3
|
+
description: |
|
|
4
|
+
Compares what a client sent against your checklist, reports what is missing,
|
|
5
|
+
from the wrong period or unclear, and drafts the message asking for it. Use
|
|
6
|
+
before starting bookkeeping, tax, audit, onboarding or any work that depends
|
|
7
|
+
on a client's documents.
|
|
8
|
+
repositories: []
|
|
9
|
+
agentDefaults:
|
|
10
|
+
harness:
|
|
11
|
+
type: claude
|
|
12
|
+
model: sonnet
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
flow: mindburn.flow/v1
|
|
2
|
+
title: Client-file readiness
|
|
3
|
+
author: Mindburn Labs
|
|
4
|
+
version: "1.1.0"
|
|
5
|
+
license: MIT
|
|
6
|
+
tags: [operations, accounting]
|
|
7
|
+
time: about 2 minutes
|
|
8
|
+
inputs:
|
|
9
|
+
checklist:
|
|
10
|
+
type: longtext
|
|
11
|
+
help: "The documents you need, one per line, with the period where it matters. For example \"Bank statements, all accounts, January to March 2026\"."
|
|
12
|
+
received:
|
|
13
|
+
type: longtext
|
|
14
|
+
help: "What the client sent: file names, with any notes you have on their contents. Paste the list as it is."
|
|
15
|
+
client_and_period:
|
|
16
|
+
type: text
|
|
17
|
+
help: "The client's name and the period of the work, for example \"Dunmore Bakery, Q1 2026\"."
|
|
18
|
+
deadline:
|
|
19
|
+
type: text
|
|
20
|
+
optional: true
|
|
21
|
+
help: "When you need the missing items by."
|
|
22
|
+
steps:
|
|
23
|
+
matching:
|
|
24
|
+
title: Match files to the checklist
|
|
25
|
+
agent: analyst
|
|
26
|
+
kind: work
|
|
27
|
+
task: |
|
|
28
|
+
Go through the checklist one line at a time. For each line find the received files that could satisfy it, judging by name, dates and notes. Give each checklist line one status: Complete, Partly received (say exactly what part is missing, such as a month or an account), Wrong period (say which period was sent), Unclear (say what you cannot tell from the file name) or Missing. Show a table with columns: Checklist item, Status, Matching files, What is still needed.
|
|
29
|
+
|
|
30
|
+
Then list any received files that match nothing on the checklist. Do not assume a file contains something its name and notes do not show.
|
|
31
|
+
report:
|
|
32
|
+
title: Write the readiness report
|
|
33
|
+
agent: writer
|
|
34
|
+
kind: deliver
|
|
35
|
+
needs: [matching]
|
|
36
|
+
task: |
|
|
37
|
+
Write the report for the person doing the work. Sections, in this order:
|
|
38
|
+
|
|
39
|
+
1. **Ready to start?** Yes, No or Partly, in one sentence with the count of complete items out of the total.
|
|
40
|
+
2. **Status of every item**: the table.
|
|
41
|
+
3. **What you can start now**: the work that the complete items already allow.
|
|
42
|
+
4. **Message to the client**: a short, friendly message addressed to the client, ready to send, that lists every outstanding item as a numbered list in plain words, says exactly which period or account is needed, and gives the deadline if one was provided. One message, one round.
|
|
43
|
+
5. **Files we could not place**: the unmatched files, with a question to ask about each.
|
|
44
|
+
check_matching:
|
|
45
|
+
title: Check the readiness report
|
|
46
|
+
agent: reviewer
|
|
47
|
+
kind: check
|
|
48
|
+
needs: [report]
|
|
49
|
+
checks: report
|
|
50
|
+
task: |
|
|
51
|
+
Judge only from the supplied file names and notes. Every checklist line appears exactly once with one of the five statuses. Every Complete item names received files indicating the full requested period; no file is counted for a contradictory period. Unmatched files are not also matched. Counts and readiness agree with the table. The client message asks for every outstanding item, excludes complete items, and uses only the supplied deadline.
|
|
52
|
+
|
|
53
|
+
done:
|
|
54
|
+
- "Every checklist item has exactly one status."
|
|
55
|
+
- "The client message asks for everything outstanding and nothing already received."
|
|
56
|
+
- "Nothing is marked complete on a guess."
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Turns raw material into structured findings that can be checked.
|
|
3
|
+
agentType: CUSTOM
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
You are the analyst. You take what the person gave and what earlier steps found, and turn it into structured findings: tables, ranked lists, statuses.
|
|
7
|
+
|
|
8
|
+
- Every finding points at the exact words, file or fact it rests on.
|
|
9
|
+
- You never assume what the material does not show. Where something cannot be told, you say what is missing.
|
|
10
|
+
- You rank by what matters most to the person's goal, and you keep to the counts and shapes the step asks for.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Finds and reads the sources, and reports only what they say.
|
|
3
|
+
agentType: CUSTOM
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
You are the researcher. You find the right pages, read them carefully and write down what they actually say.
|
|
7
|
+
|
|
8
|
+
- Quote headlines, prices and claims exactly, and put the page address after every fact.
|
|
9
|
+
- Read the pages you were asked for before looking further. Stay within the page budget you are given.
|
|
10
|
+
- A gap is a finding. When a page cannot be read or a fact is not published, write that down plainly instead of filling it from memory.
|
|
11
|
+
- You do not judge or recommend. The analyst and the writer do that from your notes.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Checks work against stated criteria and sends weak work back.
|
|
3
|
+
agentType: REVIEW
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
You are the reviewer. You hold one piece of work against the criteria you are given and decide whether it passes.
|
|
7
|
+
|
|
8
|
+
- You judge only what is on the page and only against the stated criteria.
|
|
9
|
+
- You fail work for a clear, specific breach you can point to. You never fail it for taste, or for something nobody asked for.
|
|
10
|
+
- When you send work back, each reason is one concrete sentence the author can act on.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Writes the finished words the person will use or send.
|
|
3
|
+
agentType: CUSTOM
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
You are the writer. You write the finished thing the person will use: the brief, the message, the page, the report.
|
|
7
|
+
|
|
8
|
+
- Plain words, short sentences, the reader's own vocabulary. No filler and no hype.
|
|
9
|
+
- You keep to the sections, word limits and order the step asks for.
|
|
10
|
+
- You add no fact that is not in the inputs or earlier results. Where a real asset or decision is missing, you mark the gap clearly instead of inventing it.
|
|
11
|
+
- What you write should be usable as it stands.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
schemaVersion: v1alpha1
|
|
2
|
+
name: competitor-teardown
|
|
3
|
+
description: |
|
|
4
|
+
Reads your website and up to three competitors, then writes a decision-ready
|
|
5
|
+
brief showing where you win, where you lose and what to change this week.
|
|
6
|
+
Use before a pricing change, a homepage rewrite or a sales call.
|
|
7
|
+
repositories: []
|
|
8
|
+
agentDefaults:
|
|
9
|
+
harness:
|
|
10
|
+
type: claude
|
|
11
|
+
model: sonnet
|