mirror of
https://github.com/browseros-ai/BrowserOS.git
synced 2026-05-14 08:03:58 +00:00
Compare commits
1560 Commits
v0.28.0
...
fix/debug-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bcf0e6f990 | ||
|
|
d21befc509 | ||
|
|
b355b88433 | ||
|
|
673ac0ad68 | ||
|
|
114c3c3796 | ||
|
|
a32a073d43 | ||
|
|
054056017f | ||
|
|
fc014c37b8 | ||
|
|
492f3fcdf2 | ||
|
|
cb0c0dd0c1 | ||
|
|
8712f89f18 | ||
|
|
ba60bf466f | ||
|
|
26afb826c6 | ||
|
|
b2340c8afa | ||
|
|
790a270f47 | ||
|
|
84a79ba0a1 | ||
|
|
6e3306f5e5 | ||
|
|
c244462b29 | ||
|
|
ebf97f74f6 | ||
|
|
561f2baf97 | ||
|
|
df0f45dd29 | ||
|
|
edfc5c751c | ||
|
|
471256f31c | ||
|
|
4c90ca696b | ||
|
|
f2ac87d7c3 | ||
|
|
231bd6821d | ||
|
|
a228c278c6 | ||
|
|
e2ec1991cf | ||
|
|
0c84547e8f | ||
|
|
2ff5c12840 | ||
|
|
d87422eea1 | ||
|
|
1946ca0cf8 | ||
|
|
754f7d0e1d | ||
|
|
85bb3f7b42 | ||
|
|
cb32b8191d | ||
|
|
7a92654abc | ||
|
|
91d3285aa0 | ||
|
|
7bb6dac949 | ||
|
|
d9c254053e | ||
|
|
6b9945f933 | ||
|
|
6a5a7775a9 | ||
|
|
af48a2110c | ||
|
|
c5ff8d75bc | ||
|
|
445a6a6c45 | ||
|
|
72d39b9a0f | ||
|
|
3b47f330f5 | ||
|
|
15a82ff9cb | ||
|
|
427549f081 | ||
|
|
a11f9caa64 | ||
|
|
da1397900b | ||
|
|
368c7dcfe8 | ||
|
|
599f8b6b9c | ||
|
|
27834b1d31 | ||
|
|
aa30eb3aaa | ||
|
|
e045e34b73 | ||
|
|
01d649da9a | ||
|
|
ddbb2cf492 | ||
|
|
711934555d | ||
|
|
5125dffbf3 | ||
|
|
0035893f33 | ||
|
|
4284e88625 | ||
|
|
0b91c735ab | ||
|
|
d189b50b03 | ||
|
|
a407e48209 | ||
|
|
1f75b91fba | ||
|
|
752f42d1fe | ||
|
|
2f8e36546f | ||
|
|
461dcd29e8 | ||
|
|
c6c902a4ab | ||
|
|
6e37742a5a | ||
|
|
1186c2c0d7 | ||
|
|
0288cc040d | ||
|
|
07b7bf5977 | ||
|
|
d1a3d67e29 | ||
|
|
35134518f0 | ||
|
|
4083155e81 | ||
|
|
72ef4f068e | ||
|
|
6b6ed1582c | ||
|
|
a3764e7599 | ||
|
|
c656f6236c | ||
|
|
4d660874ad | ||
|
|
819887a2c5 | ||
|
|
114d5e3a9f | ||
|
|
ecba7de221 | ||
|
|
123a13fe62 | ||
|
|
5ccdbaf87f | ||
|
|
0650f21c80 | ||
|
|
e80ec467f4 | ||
|
|
41374439c4 | ||
|
|
ad99cd6cc1 | ||
|
|
47fc9e1292 | ||
|
|
2a61dcbc58 | ||
|
|
f5a2b7315c | ||
|
|
6de3b3422c | ||
|
|
224b6cd3a8 | ||
|
|
7baee8d57e | ||
|
|
e8e8c36fdb | ||
|
|
3810005457 | ||
|
|
688f7962cb | ||
|
|
526d784d82 | ||
|
|
331fec07e6 | ||
|
|
0652ee8ca8 | ||
|
|
156f5dbc5d | ||
|
|
ebd3200cfe | ||
|
|
4172daa130 | ||
|
|
c1b1e53a86 | ||
|
|
d653883e99 | ||
|
|
f521ebc8dc | ||
|
|
f2a41fdc08 | ||
|
|
b9dc875203 | ||
|
|
20067d90c7 | ||
|
|
67f18bc868 | ||
|
|
2f86020b30 | ||
|
|
dc26ff2554 | ||
|
|
718902a4c7 | ||
|
|
357821de6f | ||
|
|
d34bc64a67 | ||
|
|
3423b31aa8 | ||
|
|
f1c108b2ed | ||
|
|
bf643c68f4 | ||
|
|
1c8edee557 | ||
|
|
1cca265427 | ||
|
|
2171e71e8e | ||
|
|
aff8afd9a4 | ||
|
|
0c96002cf5 | ||
|
|
76e5dcb801 | ||
|
|
a85f94de40 | ||
|
|
6708ab834b | ||
|
|
007208d54b | ||
|
|
dd85ae503f | ||
|
|
452906d3ca | ||
|
|
0397d3e393 | ||
|
|
edd681012c | ||
|
|
ce7c209ba6 | ||
|
|
6548220bcb | ||
|
|
14eeba7c20 | ||
|
|
3c629c5929 | ||
|
|
77dcd37000 | ||
|
|
6d0dff7b1a | ||
|
|
f78068bb9d | ||
|
|
6b18ebb1d8 | ||
|
|
1f2e783ab9 | ||
|
|
df7873562d | ||
|
|
412386b489 | ||
|
|
33617ba9e7 | ||
|
|
6712e1d321 | ||
|
|
94540d9e87 | ||
|
|
bb62213e84 | ||
|
|
dee3086a48 | ||
|
|
8de2bf984f | ||
|
|
1b8720740c | ||
|
|
91be726381 | ||
|
|
ff5386a24a | ||
|
|
a5f3c4da65 | ||
|
|
e5a852dd3d | ||
|
|
aee30ce8e1 | ||
|
|
0833c8d42d | ||
|
|
036c7f280b | ||
|
|
000429277d | ||
|
|
f8535fd96d | ||
|
|
f0cbf77924 | ||
|
|
17be06eb2f | ||
|
|
0e90785500 | ||
|
|
2bb432b0f2 | ||
|
|
565ce18eba | ||
|
|
81350c0d7f | ||
|
|
9bdb2413ec | ||
|
|
ace9307878 | ||
|
|
83a25ad301 | ||
|
|
4b191a759c | ||
|
|
d02b3f74e6 | ||
|
|
86c62f14a5 | ||
|
|
42c3e8fe01 | ||
|
|
517750e880 | ||
|
|
6c053a5f29 | ||
|
|
1c5ffdf878 | ||
|
|
39a7d49c25 | ||
|
|
ed948f4b59 | ||
|
|
aad5bc16fd | ||
|
|
cee318a40b | ||
|
|
febaf58f91 | ||
|
|
aacb47f7ee | ||
|
|
b3003542d8 | ||
|
|
aba7a10430 | ||
|
|
b7462aa042 | ||
|
|
883bcc9670 | ||
|
|
279b41fdc4 | ||
|
|
220577b41c | ||
|
|
03b45013a6 | ||
|
|
aa85907212 | ||
|
|
085352a6f0 | ||
|
|
c0578d0e53 | ||
|
|
663c18ee97 | ||
|
|
48727750b4 | ||
|
|
30a3a96a57 | ||
|
|
6773ce39da | ||
|
|
342a3e4a07 | ||
|
|
09406ea794 | ||
|
|
1f00cbc9cc | ||
|
|
422a829f5e | ||
|
|
ed109fcedf | ||
|
|
19af96d08e | ||
|
|
e0304b203c | ||
|
|
af65bdbcfb | ||
|
|
d79c2a4123 | ||
|
|
e3d57e5347 | ||
|
|
392312f203 | ||
|
|
0f193055c7 | ||
|
|
f45cb58889 | ||
|
|
37ead6d129 | ||
|
|
5ea9463030 | ||
|
|
dde35ccbd5 | ||
|
|
7f20319272 | ||
|
|
c8204efab6 | ||
|
|
fb5143b563 | ||
|
|
fe257cd8d1 | ||
|
|
890d3406dd | ||
|
|
c316e09c11 | ||
|
|
65547c60c0 | ||
|
|
0babc05077 | ||
|
|
1270b5b55c | ||
|
|
e97d8bc1cb | ||
|
|
5109ca4347 | ||
|
|
f14942c6f9 | ||
|
|
86ec88ed80 | ||
|
|
4928b7e84b | ||
|
|
94a1a701f6 | ||
|
|
ecf2efa857 | ||
|
|
026c6a03a3 | ||
|
|
2b53daf641 | ||
|
|
3cc946ded8 | ||
|
|
70be5c5c21 | ||
|
|
0f9d93058f | ||
|
|
cafed57832 | ||
|
|
f157436e7d | ||
|
|
ba7892322b | ||
|
|
4e90b4561a | ||
|
|
86eed82350 | ||
|
|
be6ed22af4 | ||
|
|
149cde118d | ||
|
|
9bc5e666c4 | ||
|
|
2271277b4d | ||
|
|
f865d301a2 | ||
|
|
6f398f0b36 | ||
|
|
8548bcf50a | ||
|
|
e3601bfdc1 | ||
|
|
2b4fdf1aad | ||
|
|
11d15d079f | ||
|
|
9257832acf | ||
|
|
7bde0d59fa | ||
|
|
1c737b0f02 | ||
|
|
5d0a2b9bfe | ||
|
|
720baaed3e | ||
|
|
cee9c764b1 | ||
|
|
7bdeeb85d5 | ||
|
|
19069cb9c4 | ||
|
|
5bb6143373 | ||
|
|
f4d4b73a24 | ||
|
|
d965698905 | ||
|
|
50b2f45590 | ||
|
|
1b88ade021 | ||
|
|
079a254fa4 | ||
|
|
42aa0ff1ef | ||
|
|
4000f094f6 | ||
|
|
151be81cee | ||
|
|
46a8326140 | ||
|
|
4b18723a21 | ||
|
|
4909927c03 | ||
|
|
22c5e85707 | ||
|
|
59b00a6837 | ||
|
|
44af9aea6d | ||
|
|
1779e1e7bd | ||
|
|
2597cdbc70 | ||
|
|
515ad44826 | ||
|
|
2a6848bc1d | ||
|
|
74f6a2dff1 | ||
|
|
58adac17db | ||
|
|
e67c17a0f8 | ||
|
|
94e3f99adb | ||
|
|
e2069bc999 | ||
|
|
2d51c82722 | ||
|
|
29056226bb | ||
|
|
d1d2074abc | ||
|
|
41c9b1547c | ||
|
|
8b0e6dbfd3 | ||
|
|
07a2d13f16 | ||
|
|
46031ed573 | ||
|
|
ecd31efcb0 | ||
|
|
c79c775fb8 | ||
|
|
4bee76253d | ||
|
|
5b1b4e22cb | ||
|
|
439acc8b12 | ||
|
|
95c855a091 | ||
|
|
5ad6581f6d | ||
|
|
2c04d79830 | ||
|
|
304b3b3289 | ||
|
|
96b0a7cfc8 | ||
|
|
290ee91a8b | ||
|
|
8f148d0918 | ||
|
|
e7680d4972 | ||
|
|
90bd4be300 | ||
|
|
6405639d36 | ||
|
|
2d1e989a1c | ||
|
|
7c89198dcf | ||
|
|
8a38e90e24 | ||
|
|
2c8cbbb77f | ||
|
|
b96d8e6c29 | ||
|
|
32dd42cc6b | ||
|
|
b94e9c411d | ||
|
|
bde80fedd6 | ||
|
|
39ddabf3a7 | ||
|
|
47d32dbc7d | ||
|
|
d9b593afa2 | ||
|
|
29356c3df6 | ||
|
|
cc5bc3fff7 | ||
|
|
f02fecf732 | ||
|
|
a12b3b4ffc | ||
|
|
038ae259f0 | ||
|
|
4041aeb01c | ||
|
|
90400e3fcf | ||
|
|
58a216fde3 | ||
|
|
38cc388894 | ||
|
|
418fa879ee | ||
|
|
bcc1c54ccc | ||
|
|
8173a443ff | ||
|
|
2da099797e | ||
|
|
d04a1f7e2a | ||
|
|
40d0a6982e | ||
|
|
ef9eebfd94 | ||
|
|
355392ca14 | ||
|
|
166f6e1b9e | ||
|
|
9b996c5752 | ||
|
|
c7dde92960 | ||
|
|
32ce02b59f | ||
|
|
7566f0ee82 | ||
|
|
ffe1f8a469 | ||
|
|
a5e7c359e3 | ||
|
|
3f4cccdf12 | ||
|
|
866fe88acd | ||
|
|
385cf03227 | ||
|
|
a824078f6d | ||
|
|
3e23796724 | ||
|
|
ae49da6e09 | ||
|
|
bcd91a8e03 | ||
|
|
2d6d08c9fe | ||
|
|
4472c2b890 | ||
|
|
2477063673 | ||
|
|
146b9af17c | ||
|
|
de70525889 | ||
|
|
f81e73f6a4 | ||
|
|
4fc68b5264 | ||
|
|
5b27933c63 | ||
|
|
d1937b3280 | ||
|
|
15755a84d9 | ||
|
|
7d20768d8e | ||
|
|
cd6ca756c1 | ||
|
|
da137cbb97 | ||
|
|
91995854fa | ||
|
|
e312f29138 | ||
|
|
a2eb965759 | ||
|
|
e1a9174de1 | ||
|
|
1e6b5ac7a8 | ||
|
|
f35ac0ddd3 | ||
|
|
b6b45404ee | ||
|
|
ca777dd2fd | ||
|
|
797c75baee | ||
|
|
44071cb0f4 | ||
|
|
b035278ad9 | ||
|
|
04ca38c93b | ||
|
|
09bd10cb56 | ||
|
|
3e3ffb3f51 | ||
|
|
93b59633c7 | ||
|
|
3808faf94d | ||
|
|
a94d6d918c | ||
|
|
eb208b0515 | ||
|
|
c7990566d9 | ||
|
|
60a4167a0e | ||
|
|
6ce0fd35a0 | ||
|
|
c8a674fe93 | ||
|
|
135fa65a2e | ||
|
|
5c774501f3 | ||
|
|
65b5e74a75 | ||
|
|
2e79933cae | ||
|
|
d2fd02e72e | ||
|
|
db3d38ae3c | ||
|
|
7f39f95c8e | ||
|
|
dafad1dd14 | ||
|
|
c38ceb49c1 | ||
|
|
577de3bad3 | ||
|
|
a9bb4602cd | ||
|
|
fb2ad66c91 | ||
|
|
d6d024fcea | ||
|
|
7dbf645457 | ||
|
|
b3ec17b4ff | ||
|
|
7759d6769f | ||
|
|
bc53ff52e5 | ||
|
|
6ecf7ca3e4 | ||
|
|
5bcf3fe875 | ||
|
|
9b0c484d06 | ||
|
|
9336ede323 | ||
|
|
d778cd6ba9 | ||
|
|
4807f533cd | ||
|
|
3477772e4e | ||
|
|
402d9c0538 | ||
|
|
696d520199 | ||
|
|
00922aadc4 | ||
|
|
c56186111e | ||
|
|
cc075e7770 | ||
|
|
48a0efeb81 | ||
|
|
ddc376a026 | ||
|
|
64b25c1610 | ||
|
|
6f99d14e78 | ||
|
|
b7e63a4a1f | ||
|
|
9fdb361d67 | ||
|
|
706c0768a7 | ||
|
|
e37d19da51 | ||
|
|
909c430988 | ||
|
|
88cb227444 | ||
|
|
93c75e354f | ||
|
|
2b605bdaa3 | ||
|
|
ec725b3781 | ||
|
|
c0e5ffb378 | ||
|
|
52570bd6aa | ||
|
|
5a1fc2285f | ||
|
|
fb58a6ee1c | ||
|
|
a91bef1cd1 | ||
|
|
05887026fb | ||
|
|
7d65603e14 | ||
|
|
915ab12c40 | ||
|
|
12ceeb81e6 | ||
|
|
12228a9392 | ||
|
|
2bc5d6f5e4 | ||
|
|
61776cb0d6 | ||
|
|
a21efd7325 | ||
|
|
609341a445 | ||
|
|
fc785b4f77 | ||
|
|
3969660906 | ||
|
|
72dd429825 | ||
|
|
010fb88b56 | ||
|
|
51505e1de6 | ||
|
|
6396c41bb5 | ||
|
|
acb7dfc624 | ||
|
|
167fa2f1e4 | ||
|
|
92c20eef73 | ||
|
|
7922a668a1 | ||
|
|
9b2d8b197d | ||
|
|
56f471978f | ||
|
|
17be074b35 | ||
|
|
ad4c0af4fe | ||
|
|
52f9dfb2e4 | ||
|
|
a63ce24d70 | ||
|
|
02bccccf99 | ||
|
|
91522bca51 | ||
|
|
78cf2a3e96 | ||
|
|
6d736e9158 | ||
|
|
5a99e0f9ff | ||
|
|
5944677420 | ||
|
|
6bccbb00e5 | ||
|
|
2f8ba0817a | ||
|
|
6b8802c699 | ||
|
|
12f8407fd6 | ||
|
|
d4447adf65 | ||
|
|
c66227e697 | ||
|
|
f97d74661b | ||
|
|
ae2c216321 | ||
|
|
d33a1745b4 | ||
|
|
20bb4cb21e | ||
|
|
14ab8fe97e | ||
|
|
ebaa7ae371 | ||
|
|
36b9a78d56 | ||
|
|
f449162699 | ||
|
|
55bf44de38 | ||
|
|
de52afbc55 | ||
|
|
282d17d616 | ||
|
|
f3949e901b | ||
|
|
b474a50b42 | ||
|
|
d84feb105c | ||
|
|
053480d753 | ||
|
|
f74c353698 | ||
|
|
5e2b2e00e5 | ||
|
|
899d322a8b | ||
|
|
daba2d4d57 | ||
|
|
1880bba9dd | ||
|
|
bc8f874579 | ||
|
|
54f7e90a61 | ||
|
|
793d35c5e5 | ||
|
|
ecc02fd2e7 | ||
|
|
c5afcea1fb | ||
|
|
e8ea4d1858 | ||
|
|
3717ab4fe8 | ||
|
|
6d19db73d5 | ||
|
|
b57c7480f4 | ||
|
|
bd4b176db2 | ||
|
|
3e1c567425 | ||
|
|
954dd7c06a | ||
|
|
1de49a63f5 | ||
|
|
b0795ab217 | ||
|
|
21ecaa084e | ||
|
|
2a7bebaf46 | ||
|
|
cfac2e3227 | ||
|
|
713ad8f64a | ||
|
|
7b55226651 | ||
|
|
2988bf3640 | ||
|
|
3aca3a6f5c | ||
|
|
e92c28be82 | ||
|
|
61cd98cbd6 | ||
|
|
80fe2493e7 | ||
|
|
8f01c614dd | ||
|
|
dbd44a2535 | ||
|
|
d65246e43a | ||
|
|
91cb0300d4 | ||
|
|
bc7bf8140d | ||
|
|
6cd68605ab | ||
|
|
1600978cc6 | ||
|
|
ad606fe0d9 | ||
|
|
a3cbcb16df | ||
|
|
47a70b43de | ||
|
|
338649319a | ||
|
|
3060411b7b | ||
|
|
6bdc1d170d | ||
|
|
1cba45e7b7 | ||
|
|
13faa47383 | ||
|
|
afcf4d9e00 | ||
|
|
3cf222fb36 | ||
|
|
96797ed101 | ||
|
|
032e1e57c9 | ||
|
|
b790da199e | ||
|
|
19555cea78 | ||
|
|
f9fb2f8a02 | ||
|
|
e02ba395f9 | ||
|
|
5eb6968c41 | ||
|
|
04bb55fdd1 | ||
|
|
1aaf9de2ba | ||
|
|
00096752b5 | ||
|
|
618b35b460 | ||
|
|
e4aee822ff | ||
|
|
534e890a41 | ||
|
|
e4d39e2ec1 | ||
|
|
1939aa1e89 | ||
|
|
6108e94d0f | ||
|
|
1f5dcba976 | ||
|
|
19c4175631 | ||
|
|
64e43f5d8c | ||
|
|
45c086c1e8 | ||
|
|
dfd309a1bc | ||
|
|
d7bb80e04e | ||
|
|
37bfc6c62e | ||
|
|
5d082deca3 | ||
|
|
99ec199335 | ||
|
|
111c38a455 | ||
|
|
1322638681 | ||
|
|
02368e79d1 | ||
|
|
8c9c5d0d9a | ||
|
|
31efbf9f0c | ||
|
|
1ea3128ed8 | ||
|
|
796112c3d6 | ||
|
|
285a686291 | ||
|
|
614b47de4a | ||
|
|
46674fb952 | ||
|
|
11154bde75 | ||
|
|
e3efb5a376 | ||
|
|
cb8aa6c60e | ||
|
|
f27858f9a7 | ||
|
|
b171c0a188 | ||
|
|
1615f2ab42 | ||
|
|
8138081ca1 | ||
|
|
52f2ebeffd | ||
|
|
c675c18c65 | ||
|
|
a8db192675 | ||
|
|
88c9665dda | ||
|
|
4b03bc6620 | ||
|
|
b83f50b8f6 | ||
|
|
fd53ee1f89 | ||
|
|
d9ac4b24c5 | ||
|
|
9bcf54c5c1 | ||
|
|
af454327e4 | ||
|
|
ff0e71efbd | ||
|
|
6c3731c5e2 | ||
|
|
16eaa90932 | ||
|
|
e9df04c72e | ||
|
|
81a6d20fe8 | ||
|
|
aa1faf5003 | ||
|
|
0b38310ae0 | ||
|
|
741d3ac40c | ||
|
|
221d2a0ee8 | ||
|
|
968ccf80ad | ||
|
|
bed1a31b74 | ||
|
|
3274c55131 | ||
|
|
d8e9813934 | ||
|
|
e5539e0801 | ||
|
|
d15d3902d4 | ||
|
|
491d705771 | ||
|
|
82ed0661ce | ||
|
|
bd64a87c7c | ||
|
|
669932adfd | ||
|
|
38471f6b6a | ||
|
|
f5c0765457 | ||
|
|
3955d6ee62 | ||
|
|
a89d511100 | ||
|
|
1f5d9ec55c | ||
|
|
424384457d | ||
|
|
1204697873 | ||
|
|
e133e35527 | ||
|
|
2e1fc2e8f9 | ||
|
|
5fb6496217 | ||
|
|
d775cadc17 | ||
|
|
a169f74d11 | ||
|
|
5e4187a294 | ||
|
|
44951cc5a6 | ||
|
|
a5e82f992c | ||
|
|
2dfb730571 | ||
|
|
8843883b09 | ||
|
|
dbf92bdea1 | ||
|
|
1feadebaff | ||
|
|
eae3e91d15 | ||
|
|
a8f1545b04 | ||
|
|
908a82e07e | ||
|
|
be83e728ea | ||
|
|
c6e0572630 | ||
|
|
0192033e81 | ||
|
|
f35ed67617 | ||
|
|
433f4e1d88 | ||
|
|
3b393f0639 | ||
|
|
a4ffe89a99 | ||
|
|
c7a72b5164 | ||
|
|
aa29a29570 | ||
|
|
2c8c6f6120 | ||
|
|
a5e7677af0 | ||
|
|
509451ac2f | ||
|
|
e3d25892a9 | ||
|
|
613bca5222 | ||
|
|
ba52e92517 | ||
|
|
f585fc13fc | ||
|
|
3b362fa770 | ||
|
|
bd1c851a09 | ||
|
|
cb4368ecad | ||
|
|
448882a251 | ||
|
|
478a35e4ef | ||
|
|
79b0adb69c | ||
|
|
d6b02703df | ||
|
|
27c9a9748e | ||
|
|
e532876194 | ||
|
|
be4ab73d61 | ||
|
|
f4f92053f7 | ||
|
|
53135bd960 | ||
|
|
9508e2334b | ||
|
|
426cd9e344 | ||
|
|
5fe94f74ac | ||
|
|
98dd4cfa9a | ||
|
|
2539f13c65 | ||
|
|
b2a6dc5478 | ||
|
|
55eb204dea | ||
|
|
5a612c8536 | ||
|
|
8ade3d0a6d | ||
|
|
2e5f9e5ede | ||
|
|
a31056f9f1 | ||
|
|
f9933ccedc | ||
|
|
3fa732c23e | ||
|
|
89585ee357 | ||
|
|
23abfdf6f4 | ||
|
|
5de08db949 | ||
|
|
e35cb6cd16 | ||
|
|
2b17059168 | ||
|
|
b5a4c3804b | ||
|
|
be7912b4e9 | ||
|
|
9f3562eb85 | ||
|
|
5fd99b54f6 | ||
|
|
d242adde26 | ||
|
|
9385f8b2f2 | ||
|
|
71b2b5ea94 | ||
|
|
6d1ab5cb05 | ||
|
|
04700a99a4 | ||
|
|
d7be7520b8 | ||
|
|
a6b3a46dc4 | ||
|
|
e7ab1b6b6d | ||
|
|
5349966ec9 | ||
|
|
33452715ba | ||
|
|
ccd5ab146e | ||
|
|
4e68bba5ba | ||
|
|
862cd944b5 | ||
|
|
f0d3a7822f | ||
|
|
f8221e95a4 | ||
|
|
2d92c9bd1a | ||
|
|
b36d74638c | ||
|
|
7788695230 | ||
|
|
02e4f12447 | ||
|
|
163e27ac12 | ||
|
|
2454bb8c87 | ||
|
|
a6e2845778 | ||
|
|
09b71c02ce | ||
|
|
5da4a82c27 | ||
|
|
9119f7d684 | ||
|
|
15d41d9d2e | ||
|
|
882c227ee0 | ||
|
|
4cb6282a8d | ||
|
|
4227c77f18 | ||
|
|
6e47345647 | ||
|
|
a6171ebbcf | ||
|
|
a7d2f8cb7b | ||
|
|
f28d1dea66 | ||
|
|
7f546bc507 | ||
|
|
acca31cb54 | ||
|
|
fed0067d9f | ||
|
|
24971a144a | ||
|
|
ddbae62d7e | ||
|
|
a5ac1ed054 | ||
|
|
303d593bb9 | ||
|
|
43dae82293 | ||
|
|
cdf4e8534e | ||
|
|
561466c51a | ||
|
|
24b46f664b | ||
|
|
e85fecffcb | ||
|
|
c577db48d2 | ||
|
|
4f71d917f0 | ||
|
|
b262962c08 | ||
|
|
da6621ba58 | ||
|
|
8639f2b20a | ||
|
|
b4d0a53f8f | ||
|
|
36fe8790b0 | ||
|
|
06dd421776 | ||
|
|
db54661ee9 | ||
|
|
3535a6c2de | ||
|
|
818b2ef645 | ||
|
|
89a53eec5e | ||
|
|
5a74215af1 | ||
|
|
3e3e676fc4 | ||
|
|
206ff61a38 | ||
|
|
64bb615227 | ||
|
|
a184fc87b5 | ||
|
|
e2a116c7dc | ||
|
|
8549015d7f | ||
|
|
970321e593 | ||
|
|
aa8fdad4de | ||
|
|
c51c6f7c31 | ||
|
|
5ee86d74b5 | ||
|
|
63342e708b | ||
|
|
6fd90ec235 | ||
|
|
ecee03cb55 | ||
|
|
b459f4c952 | ||
|
|
fbcfcd1844 | ||
|
|
ec91d69b1d | ||
|
|
69e159f886 | ||
|
|
4a129e403b | ||
|
|
e9446b6aa7 | ||
|
|
17432c30d4 | ||
|
|
9cc2b02fb7 | ||
|
|
1ab26c4175 | ||
|
|
d2cb8b93aa | ||
|
|
ed76fe4cb5 | ||
|
|
8354ad5ab5 | ||
|
|
aeb1fb37e7 | ||
|
|
a8ace83a9c | ||
|
|
5cee158876 | ||
|
|
dd67a02267 | ||
|
|
ee29881669 | ||
|
|
a55cd49cb5 | ||
|
|
51c6ef8163 | ||
|
|
101a04a097 | ||
|
|
814c82d1b8 | ||
|
|
866a495897 | ||
|
|
9a917397e6 | ||
|
|
7527f50afd | ||
|
|
69ba8fe782 | ||
|
|
edfdaaeaf5 | ||
|
|
074dba6c20 | ||
|
|
cfbb99faa0 | ||
|
|
eaa11a940c | ||
|
|
36656f4c1d | ||
|
|
a0df1ae0bb | ||
|
|
b9efc3781f | ||
|
|
1fdc0c1b9e | ||
|
|
410184b0d7 | ||
|
|
0303801f7b | ||
|
|
49f603a3a6 | ||
|
|
205cef3ceb | ||
|
|
fefee6af82 | ||
|
|
9a33fdabaa | ||
|
|
38e2bd7e50 | ||
|
|
8a60947967 | ||
|
|
7fd8616203 | ||
|
|
892a1304e8 | ||
|
|
d1da6e0b6e | ||
|
|
a2073d8c76 | ||
|
|
f3aacd1c82 | ||
|
|
37360b0ff9 | ||
|
|
bc7355a5a9 | ||
|
|
6c68f6c9dd | ||
|
|
8657146fb6 | ||
|
|
59be124b16 | ||
|
|
e71a3c1a9e | ||
|
|
f8ea2943e5 | ||
|
|
0d3ed6a841 | ||
|
|
bc9f4b649c | ||
|
|
e562b0f39c | ||
|
|
a7eb2e865e | ||
|
|
e83af388f2 | ||
|
|
f0f15a5328 | ||
|
|
ad4e391b9c | ||
|
|
c98e1dd708 | ||
|
|
c09a44418c | ||
|
|
f308e7e542 | ||
|
|
8499346d69 | ||
|
|
45bab813ac | ||
|
|
d2963d3496 | ||
|
|
3588585f20 | ||
|
|
571601651b | ||
|
|
fd3cdace91 | ||
|
|
a4bae1f0c7 | ||
|
|
be8b7b6e91 | ||
|
|
4a785b6e77 | ||
|
|
1180ba9458 | ||
|
|
78f0834124 | ||
|
|
63c89c1712 | ||
|
|
820ebec027 | ||
|
|
bf86fc2496 | ||
|
|
fa1c5040e9 | ||
|
|
308f29e1d2 | ||
|
|
ddd50004a1 | ||
|
|
57ee2d8cf5 | ||
|
|
9194d3360c | ||
|
|
132ca01151 | ||
|
|
a2b08b16e5 | ||
|
|
b859700440 | ||
|
|
6f30dc748e | ||
|
|
2946fc08d6 | ||
|
|
216c06f07c | ||
|
|
04bb24e6c8 | ||
|
|
5bd63e89c0 | ||
|
|
f472b2f13a | ||
|
|
99289cdf6c | ||
|
|
826c6f6946 | ||
|
|
a497ac4f0d | ||
|
|
f093a60001 | ||
|
|
eacdfaf579 | ||
|
|
4a8fd5f12a | ||
|
|
8dd389b214 | ||
|
|
f63af69883 | ||
|
|
81184a5498 | ||
|
|
c26dd2b96e | ||
|
|
1f55966c8a | ||
|
|
8d28ca0e01 | ||
|
|
39ceee79b7 | ||
|
|
ce3e8b2ccc | ||
|
|
85ab5e9d3d | ||
|
|
aba5745709 | ||
|
|
b3d4d668b4 | ||
|
|
296022278d | ||
|
|
5cfd0a7511 | ||
|
|
1453058e99 | ||
|
|
f977257e3e | ||
|
|
0bd6458259 | ||
|
|
5b04e0b26e | ||
|
|
bf975b438a | ||
|
|
be01c1d1a9 | ||
|
|
ef9362f84c | ||
|
|
4e36a331b6 | ||
|
|
9f87d817ff | ||
|
|
c688660f48 | ||
|
|
9bb0686865 | ||
|
|
3fd7a715b3 | ||
|
|
5bd45f0658 | ||
|
|
5c8a58680a | ||
|
|
8d2c70689a | ||
|
|
f0f20ce0fb | ||
|
|
d9a6bb173f | ||
|
|
9ea236dbb4 | ||
|
|
e3e3965b42 | ||
|
|
5025e4c207 | ||
|
|
4d77a02e9e | ||
|
|
07745799db | ||
|
|
05a3b5ab6b | ||
|
|
6e3bc75d5f | ||
|
|
64cd2b9dd9 | ||
|
|
01e91defc3 | ||
|
|
dbfe70a0cf | ||
|
|
b55217dd63 | ||
|
|
33c575cac9 | ||
|
|
9eeec4adfc | ||
|
|
29559669f4 | ||
|
|
230929587b | ||
|
|
e7a302f919 | ||
|
|
58a6114511 | ||
|
|
76685f56e6 | ||
|
|
50f64a715b | ||
|
|
9478abfdd4 | ||
|
|
472147db25 | ||
|
|
3a04fb7ec3 | ||
|
|
0d62e4fdc2 | ||
|
|
fe0d76ba0b | ||
|
|
3f7cbacd3b | ||
|
|
850560cdfb | ||
|
|
3cb1ca38d1 | ||
|
|
5020a1997d | ||
|
|
27f565e3fc | ||
|
|
52c07890d0 | ||
|
|
35e161695d | ||
|
|
51f07195b6 | ||
|
|
6f55b0f61f | ||
|
|
ca5ca1ba4e | ||
|
|
e346ba3999 | ||
|
|
9e989d6a03 | ||
|
|
61c599ca75 | ||
|
|
c5c41007a6 | ||
|
|
5d205e9ee1 | ||
|
|
d469208d66 | ||
|
|
8ac9a4488f | ||
|
|
57e5d87930 | ||
|
|
03d0455b47 | ||
|
|
5ea064b99b | ||
|
|
3a9391b2e3 | ||
|
|
e4830f485a | ||
|
|
ee9770d562 | ||
|
|
12cdd82b3c | ||
|
|
53cf184f94 | ||
|
|
8fed516b0b | ||
|
|
e4488eb54e | ||
|
|
552558e2fd | ||
|
|
401b8e39b3 | ||
|
|
752f4319b6 | ||
|
|
1fffe4ff4a | ||
|
|
7cfe55a360 | ||
|
|
dc2535436e | ||
|
|
2c2776e7a9 | ||
|
|
c5f29c67f6 | ||
|
|
481161e7d9 | ||
|
|
3546a125cb | ||
|
|
932ed0c340 | ||
|
|
cef3d2e981 | ||
|
|
a7276c5181 | ||
|
|
4b9433774b | ||
|
|
f5ef929a0b | ||
|
|
a1155114fa | ||
|
|
9798fb70bc | ||
|
|
b421249173 | ||
|
|
2dba9cdbf6 | ||
|
|
1694df6a27 | ||
|
|
4ef0a99b0d | ||
|
|
eb7bb929d2 | ||
|
|
27f8598e92 | ||
|
|
ce78a4a8d3 | ||
|
|
41da5e253f | ||
|
|
64022a5191 | ||
|
|
bca394c83b | ||
|
|
3d7afaa0ae | ||
|
|
5b1c98ca81 | ||
|
|
149c325a58 | ||
|
|
227dcaf8f7 | ||
|
|
c803baf50b | ||
|
|
9b1887fe3b | ||
|
|
649fc8b230 | ||
|
|
1b5eb2e83b | ||
|
|
a2a0652907 | ||
|
|
4f0ff4ff49 | ||
|
|
d8b45f04bf | ||
|
|
997aeb0374 | ||
|
|
2318be07eb | ||
|
|
5c71725df0 | ||
|
|
03d703c1c8 | ||
|
|
0bf921fd8b | ||
|
|
3525dc9026 | ||
|
|
3dc0257ac2 | ||
|
|
eb15382825 | ||
|
|
d638fdca3d | ||
|
|
9643c09111 | ||
|
|
3b9550390a | ||
|
|
95f91c9f19 | ||
|
|
091433ed34 | ||
|
|
3a870d4d8e | ||
|
|
974be9bca6 | ||
|
|
9854870291 | ||
|
|
5c4916c9f5 | ||
|
|
940bdebaaf | ||
|
|
0246d4b2e8 | ||
|
|
f2261b81c2 | ||
|
|
ebecc7626c | ||
|
|
24abdfa790 | ||
|
|
e6ffca546f | ||
|
|
f1a6be0dd8 | ||
|
|
e1f46f25ba | ||
|
|
1304dc2554 | ||
|
|
f843bf1c23 | ||
|
|
bae940b01c | ||
|
|
8295deecc0 | ||
|
|
ece6f52561 | ||
|
|
18632cb25c | ||
|
|
3bdfa58257 | ||
|
|
26368f965f | ||
|
|
c9670c0417 | ||
|
|
b888920d31 | ||
|
|
9e1aed99f2 | ||
|
|
3b838d0f94 | ||
|
|
24102a74a4 | ||
|
|
1539384603 | ||
|
|
2c833e4dd2 | ||
|
|
8385736e30 | ||
|
|
98b41f1b22 | ||
|
|
151eeef8de | ||
|
|
25ece05404 | ||
|
|
7c20f4da90 | ||
|
|
1e962aa321 | ||
|
|
4a018e2c27 | ||
|
|
a6f4afca5c | ||
|
|
734872e4d0 | ||
|
|
004ba9f57b | ||
|
|
ee6fe09dcb | ||
|
|
8b8c81eb74 | ||
|
|
1f3841d5d6 | ||
|
|
9aa15c2e7f | ||
|
|
d49fb36e43 | ||
|
|
2ac655b69e | ||
|
|
ee887cbd09 | ||
|
|
d4a917fb26 | ||
|
|
9c6bccd46e | ||
|
|
2cc90cba24 | ||
|
|
91702a21b4 | ||
|
|
c4f3e93778 | ||
|
|
3ee809080f | ||
|
|
91d3f420d4 | ||
|
|
f925f52657 | ||
|
|
0c02da8cf6 | ||
|
|
90512e58df | ||
|
|
3c99963eed | ||
|
|
366ba97e31 | ||
|
|
afddda015a | ||
|
|
727df53fb5 | ||
|
|
d1a1fd7e31 | ||
|
|
297f212c80 | ||
|
|
c61d1df504 | ||
|
|
f6cb6f906e | ||
|
|
dc75515a62 | ||
|
|
fcf6cc5dc2 | ||
|
|
7dbf458989 | ||
|
|
19dc298b1d | ||
|
|
25b11b3188 | ||
|
|
dd090ad677 | ||
|
|
980c10a411 | ||
|
|
79944037bb | ||
|
|
94a81430ec | ||
|
|
e1e0aa264b | ||
|
|
31ad862bd0 | ||
|
|
76ed7cf887 | ||
|
|
c64c4851f4 | ||
|
|
940a1588fc | ||
|
|
0f24b5d24a | ||
|
|
bdae439f2a | ||
|
|
bd311ba085 | ||
|
|
192bf2b0a1 | ||
|
|
2294381369 | ||
|
|
d97d547d5b | ||
|
|
018603fb64 | ||
|
|
f46a1ba00c | ||
|
|
20e536166e | ||
|
|
1e672a9dd9 | ||
|
|
1e964531a5 | ||
|
|
c0a2ffe8f4 | ||
|
|
3b2b89b98a | ||
|
|
7b984409a8 | ||
|
|
86ec6eac28 | ||
|
|
a8a4f2ca5e | ||
|
|
0d52a42a4d | ||
|
|
485b36cf89 | ||
|
|
05fb616c87 | ||
|
|
38138e2012 | ||
|
|
8f4e281d44 | ||
|
|
255a2127c0 | ||
|
|
23a5990ea5 | ||
|
|
e702977911 | ||
|
|
0307e932a2 | ||
|
|
d1561df83c | ||
|
|
48ce63e1a8 | ||
|
|
3a370ce27d | ||
|
|
f66fdae2c1 | ||
|
|
f58de7f48c | ||
|
|
ad16a77484 | ||
|
|
8f6222de09 | ||
|
|
2869c3ade1 | ||
|
|
c26a529c8a | ||
|
|
951e1b0cc1 | ||
|
|
edaa5edceb | ||
|
|
384a5e35ef | ||
|
|
8f8d0bc69a | ||
|
|
81d19cde05 | ||
|
|
618cc28f42 | ||
|
|
c4dac9380b | ||
|
|
403c29671f | ||
|
|
ee5de61967 | ||
|
|
a6b289acf0 | ||
|
|
47b9c1894d | ||
|
|
032d45afeb | ||
|
|
eba64bd4ac | ||
|
|
af4d7a8944 | ||
|
|
a35cbfbcee | ||
|
|
888d4bbf50 | ||
|
|
2efb05f06b | ||
|
|
cc2076c6ac | ||
|
|
2ed25ac298 | ||
|
|
27124baccb | ||
|
|
90068f915f | ||
|
|
3017f7e5aa | ||
|
|
39ce685443 | ||
|
|
fd825e396a | ||
|
|
473a7b8ebd | ||
|
|
3556970eef | ||
|
|
56686940b3 | ||
|
|
3862c6486a | ||
|
|
f08513c109 | ||
|
|
10b948b061 | ||
|
|
a9ce417758 | ||
|
|
af392c514e | ||
|
|
ba3540c75f | ||
|
|
82c8faa9cf | ||
|
|
1044888d9a | ||
|
|
b7549c1b2c | ||
|
|
82a5a9319d | ||
|
|
c20d0fc6fd | ||
|
|
4eeb441e06 | ||
|
|
1ac17f5ac4 | ||
|
|
168e6cca01 | ||
|
|
025780faea | ||
|
|
7267082991 | ||
|
|
f5cba0c3eb | ||
|
|
176fb9e8c7 | ||
|
|
4958f13f1d | ||
|
|
6bbe52b8ab | ||
|
|
22fe4db2eb | ||
|
|
999bde30df | ||
|
|
f0d0903106 | ||
|
|
ee14a0841c | ||
|
|
5cb9986a29 | ||
|
|
803ea51dbf | ||
|
|
742c349f86 | ||
|
|
0b9f9081b3 | ||
|
|
1af6e66723 | ||
|
|
ab362d828d | ||
|
|
1732006039 | ||
|
|
fe65169879 | ||
|
|
4e9b60e5e4 | ||
|
|
af24a9bcfe | ||
|
|
8fc6f394ec | ||
|
|
e2e73edf93 | ||
|
|
55a3b52384 | ||
|
|
97eef79d57 | ||
|
|
c642dba907 | ||
|
|
01fd543d0d | ||
|
|
a34def2a34 | ||
|
|
69f856056c | ||
|
|
7562e2d3ea | ||
|
|
4fe2d2637c | ||
|
|
e93194ac02 | ||
|
|
3d5696be3e | ||
|
|
038056161e | ||
|
|
0fc9741a5d | ||
|
|
687d4d058c | ||
|
|
d9754da12f | ||
|
|
d88582c0fc | ||
|
|
c4314d0119 | ||
|
|
f1205be810 | ||
|
|
2b9f494cf0 | ||
|
|
e973966bff | ||
|
|
b8a552796a | ||
|
|
369575fc83 | ||
|
|
50053497e8 | ||
|
|
8cbfbf7769 | ||
|
|
47cd94d26d | ||
|
|
a71cebd92b | ||
|
|
44425b4d19 | ||
|
|
eb27b258d7 | ||
|
|
a6f4f36244 | ||
|
|
5d04119d70 | ||
|
|
eb8eab4f59 | ||
|
|
1b2288b5cf | ||
|
|
63cbbeaa86 | ||
|
|
2a3c8adfbc | ||
|
|
d348cb40c3 | ||
|
|
9c1eb34114 | ||
|
|
09b4ee710b | ||
|
|
eca4f1e8e7 | ||
|
|
53129328de | ||
|
|
82466bd019 | ||
|
|
fb86d6611a | ||
|
|
31068b89a1 | ||
|
|
7c819cc90a | ||
|
|
90e64e06c6 | ||
|
|
d4b9b8332e | ||
|
|
e897f9c5c0 | ||
|
|
7ab0b04c33 | ||
|
|
41986aa582 | ||
|
|
009f08909c | ||
|
|
4eefd87317 | ||
|
|
2581af1202 | ||
|
|
df1229e55f | ||
|
|
8c6de1f6c9 | ||
|
|
c1b8a678e8 | ||
|
|
cdcb0f0561 | ||
|
|
72fd6c326b | ||
|
|
c9d1c683a6 | ||
|
|
f22b16d48e | ||
|
|
677eba9c92 | ||
|
|
d320ba5007 | ||
|
|
6c08d9a2f1 | ||
|
|
d443b84214 | ||
|
|
e34433e9f4 | ||
|
|
a5e22aad31 | ||
|
|
d01bc766a9 | ||
|
|
9f1c79009d | ||
|
|
91d33031fd | ||
|
|
84b64337d8 | ||
|
|
7cefc12472 | ||
|
|
2071aa6041 | ||
|
|
92a5079064 | ||
|
|
884303e708 | ||
|
|
21b03f45ae | ||
|
|
7bb3a94742 | ||
|
|
0d1f70f833 | ||
|
|
f888098d20 | ||
|
|
fb3f92f647 | ||
|
|
9641729980 | ||
|
|
4fdfcfa442 | ||
|
|
b3be656e3a | ||
|
|
5aa1d15899 | ||
|
|
94540e3705 | ||
|
|
9415ee61ce | ||
|
|
a9e3b9d4f9 | ||
|
|
222d3fc187 | ||
|
|
5a6754b218 | ||
|
|
e638b1d315 | ||
|
|
fbfea78318 | ||
|
|
c8ed2f7692 | ||
|
|
ec620ef9f7 | ||
|
|
767fba15c9 | ||
|
|
b55ca719d6 | ||
|
|
48b2e16855 | ||
|
|
10ee71b045 | ||
|
|
2a871ad105 | ||
|
|
288062d000 | ||
|
|
2b1e977ec6 | ||
|
|
651a1977ba | ||
|
|
ee14c90cf9 | ||
|
|
b39a228bc1 | ||
|
|
b36ae7d539 | ||
|
|
5297dd8768 | ||
|
|
99d747f2b8 | ||
|
|
03cddbe424 | ||
|
|
6f11db8422 | ||
|
|
320de09753 | ||
|
|
14d5c91dee | ||
|
|
b42ccc6e8d | ||
|
|
89e89cb87c | ||
|
|
304ba9e7d4 | ||
|
|
c1d792ef6c | ||
|
|
4b9da81bb3 | ||
|
|
b49dc442f1 | ||
|
|
cfdd166090 | ||
|
|
2f395dd3a9 | ||
|
|
f100476772 | ||
|
|
99b8bd04f5 | ||
|
|
44e4519d4c | ||
|
|
875ff6a900 | ||
|
|
44ea8400f7 | ||
|
|
bdc8386b64 | ||
|
|
a04c830b34 | ||
|
|
c33ae43f43 | ||
|
|
3f6160df24 | ||
|
|
027ba05941 | ||
|
|
637890eded | ||
|
|
b2d29c77bd | ||
|
|
4226599ead | ||
|
|
9a3b9539df | ||
|
|
756e8bc267 | ||
|
|
9a0c7b44d5 | ||
|
|
3f9c42029e | ||
|
|
b3e2f679f8 | ||
|
|
d0eab4c1d9 | ||
|
|
6a1f9fb926 | ||
|
|
b1e8ac0475 | ||
|
|
1cdca0bae3 | ||
|
|
6d77ca36af | ||
|
|
eedb0c07d0 | ||
|
|
63266b9d99 | ||
|
|
b950015f34 | ||
|
|
4618611265 | ||
|
|
dc5272396e | ||
|
|
4ebf0ca84d | ||
|
|
f40644b850 | ||
|
|
0d71b99224 | ||
|
|
960d3bf682 | ||
|
|
51ea8cc193 | ||
|
|
ee45ea8761 | ||
|
|
ffb1dfdf2a | ||
|
|
3f51d50081 | ||
|
|
df47acf2fd | ||
|
|
2cd58c171a | ||
|
|
a284773715 | ||
|
|
2dc376ce40 | ||
|
|
72c3aac9c6 | ||
|
|
0d1f4168dc | ||
|
|
ed815b939a | ||
|
|
d3c5dfa588 | ||
|
|
c535f1a5b8 | ||
|
|
5bc30d82d2 | ||
|
|
c385925bab | ||
|
|
1bf68de059 | ||
|
|
2901e73547 | ||
|
|
da4326e968 | ||
|
|
8f58d279bb | ||
|
|
699e96067c | ||
|
|
c72d48cbfe | ||
|
|
5795e1edf8 | ||
|
|
e1ee1ded14 | ||
|
|
474476186a | ||
|
|
f4d3950c86 | ||
|
|
7689dc6e3c | ||
|
|
0d11648bd4 | ||
|
|
6c98d7169c | ||
|
|
daf074def0 | ||
|
|
9436fef0a8 | ||
|
|
883415c9d4 | ||
|
|
c7643e920d | ||
|
|
87c0dea49a | ||
|
|
b79b8ea69b | ||
|
|
fcffce0e02 | ||
|
|
e8b5b15b0d | ||
|
|
575b8fb24a | ||
|
|
d4b2f2add4 | ||
|
|
f31a22d64b | ||
|
|
e08c3676f6 | ||
|
|
1523335d19 | ||
|
|
3d6115851a | ||
|
|
820154218c | ||
|
|
a11e0ed7ff | ||
|
|
25055d1195 | ||
|
|
24e9cfd8f2 | ||
|
|
545d1a2de5 | ||
|
|
bc9b3ea6da | ||
|
|
9118f88eed | ||
|
|
255d535f34 | ||
|
|
62fef26ef8 | ||
|
|
16101738c4 | ||
|
|
a2e7614e8b | ||
|
|
5fd4464826 | ||
|
|
4a19abe785 | ||
|
|
6fe4b79bd4 | ||
|
|
31a1ea62d1 | ||
|
|
e710c39ce0 | ||
|
|
a61b37148b | ||
|
|
9cf99b92f1 | ||
|
|
0765f9bcae | ||
|
|
65252b00b4 | ||
|
|
add3f78af1 | ||
|
|
f82a190a6a | ||
|
|
cc92e647e8 | ||
|
|
3925482768 | ||
|
|
e0628e3506 | ||
|
|
10efeb52dc | ||
|
|
ccfebf0297 | ||
|
|
05ca99bb62 | ||
|
|
185e95a642 | ||
|
|
022aab3c39 | ||
|
|
05c4c9267f | ||
|
|
7a9b852c10 | ||
|
|
0274d82ada | ||
|
|
779c958d3b | ||
|
|
e0266b7566 | ||
|
|
8122dbbcf9 | ||
|
|
5f9c05c6a0 | ||
|
|
56a5cf5fa5 | ||
|
|
2c1be3651c | ||
|
|
878939aa5d | ||
|
|
b35c8d0a26 | ||
|
|
b76912e8e9 | ||
|
|
4870ef1b57 | ||
|
|
e32e0b8e49 | ||
|
|
3407edc245 | ||
|
|
a8f6d823de | ||
|
|
c82909ab6c | ||
|
|
af2f023088 | ||
|
|
588846fbde | ||
|
|
4b5e8ec9eb | ||
|
|
fffb0d077f | ||
|
|
69440b0d68 | ||
|
|
5132159dd0 | ||
|
|
4193d15ea9 | ||
|
|
0699605002 | ||
|
|
ebaafcc0f0 | ||
|
|
ae8b1a82e1 | ||
|
|
54a1eec83c | ||
|
|
1836a59a98 | ||
|
|
6ce5fc0477 | ||
|
|
6f87bef897 | ||
|
|
6812f5ed63 | ||
|
|
ce6eb3400b | ||
|
|
03a8564cf9 | ||
|
|
eceea29e8c | ||
|
|
040ee30984 | ||
|
|
aaf8f3e90f | ||
|
|
e190a7f358 | ||
|
|
329a8b27ba | ||
|
|
a580085324 | ||
|
|
fa42090e31 | ||
|
|
a4f1fb14af | ||
|
|
3d74f1d0d5 | ||
|
|
d8c7b96d4a | ||
|
|
1708d68cd3 | ||
|
|
dfe53bccdd | ||
|
|
540573d9da | ||
|
|
85eb2bd8c4 | ||
|
|
d0d7bdbb9d | ||
|
|
c1ad54d4dc | ||
|
|
eed4f1b65c | ||
|
|
1b0a277afd | ||
|
|
b98b3440de | ||
|
|
041f14755a | ||
|
|
18e000d8ef | ||
|
|
0787d7b2c5 | ||
|
|
a23f8d6156 | ||
|
|
e94279da3f | ||
|
|
40a364f0e5 | ||
|
|
cee71da999 | ||
|
|
94a1b9cc66 | ||
|
|
9af3cf9dd7 | ||
|
|
601450bf45 | ||
|
|
6927968a13 | ||
|
|
d944155fa3 | ||
|
|
b67ccdf1fa | ||
|
|
00002d9752 | ||
|
|
913fb3f483 | ||
|
|
215241f977 | ||
|
|
13b448a38e | ||
|
|
d1dc974b03 | ||
|
|
a92052b1ca | ||
|
|
de79845d35 | ||
|
|
5b7ad42d1d | ||
|
|
e43d5b9dec | ||
|
|
efa7fa6adc | ||
|
|
51ebccc06b | ||
|
|
c199f37ec9 | ||
|
|
85e99caee2 | ||
|
|
e04417f12a | ||
|
|
b97a6e156f | ||
|
|
036b0646b7 | ||
|
|
51e304cc56 | ||
|
|
5954b980d0 | ||
|
|
c06c3203aa | ||
|
|
efcee368ed | ||
|
|
c4fc5a6800 | ||
|
|
2f829634ea | ||
|
|
a9107d415f | ||
|
|
20501e0531 | ||
|
|
f39760b375 | ||
|
|
639f4474e2 | ||
|
|
81596dbbbe | ||
|
|
0af3d161c0 | ||
|
|
7a77ccd381 | ||
|
|
79f44308d7 | ||
|
|
04a161fbd4 | ||
|
|
33c35b4493 | ||
|
|
94e6b33a1c | ||
|
|
d8c8683af8 | ||
|
|
009c94c2b1 | ||
|
|
4b155d3105 | ||
|
|
396cee001e | ||
|
|
2956e51ddb | ||
|
|
fb51b995ef | ||
|
|
7f6fdd754b | ||
|
|
a458b962f7 | ||
|
|
a1e4d2bad0 | ||
|
|
6f92c78f16 | ||
|
|
88d760984a | ||
|
|
10eea222cf | ||
|
|
9638cca642 | ||
|
|
031885590e | ||
|
|
6174bf82b6 | ||
|
|
c2d6b60d7c | ||
|
|
c90f891b0b | ||
|
|
24a81ac5ed | ||
|
|
36bb0247fa | ||
|
|
018b48ff04 | ||
|
|
e3c4f9bfab | ||
|
|
e21a05ac9e | ||
|
|
2b3cb86a93 | ||
|
|
007aa91aa4 | ||
|
|
1916501a96 | ||
|
|
a12366ff99 | ||
|
|
d23f20954d | ||
|
|
0da0cb4583 | ||
|
|
c2ac5cd3de | ||
|
|
d0fb41a81c | ||
|
|
fcb6776cfc | ||
|
|
ff516e94e9 | ||
|
|
7dca217cf6 | ||
|
|
8b4fdd3b7e | ||
|
|
55d3c7a26a | ||
|
|
d16bbd51b0 | ||
|
|
4a208723b3 | ||
|
|
bac3a71d23 | ||
|
|
561381f5f8 | ||
|
|
6ae492849e | ||
|
|
00eb157cd3 | ||
|
|
683d14166d | ||
|
|
dfc7aec341 | ||
|
|
3e60bafbd1 | ||
|
|
db93738bc0 | ||
|
|
f327a41281 | ||
|
|
4222471862 | ||
|
|
d5ee9b3ea4 | ||
|
|
f3362efe4e | ||
|
|
7d61485c96 | ||
|
|
fab7ccfa92 | ||
|
|
7e5263e064 | ||
|
|
c3c61ad162 | ||
|
|
a7eb179fdd | ||
|
|
5f82930c4e | ||
|
|
a1719dc3f3 | ||
|
|
b879153978 | ||
|
|
d7707985f7 | ||
|
|
7e091188f6 | ||
|
|
384ea76dc7 | ||
|
|
3d0b714f15 | ||
|
|
0f942f619f | ||
|
|
bb8e85116f | ||
|
|
25259dc307 | ||
|
|
09de761eca | ||
|
|
7e8ce4dd96 | ||
|
|
4f0fa2d200 | ||
|
|
beae55c98e | ||
|
|
b3fe55c165 | ||
|
|
c9c2c2bc63 | ||
|
|
57bf7bc808 | ||
|
|
1d93ff9e49 | ||
|
|
787eda13e9 | ||
|
|
d65a06b173 | ||
|
|
61958cf412 | ||
|
|
ab58e17366 | ||
|
|
4032751cc7 | ||
|
|
dea459b9c9 | ||
|
|
b8f137ba32 | ||
|
|
b4a6de2a50 | ||
|
|
85c2e72a4c | ||
|
|
33a73a325b | ||
|
|
f843f62bab | ||
|
|
b3ae2223a5 | ||
|
|
830f372575 | ||
|
|
82058568e2 | ||
|
|
9bda00613d | ||
|
|
3bf5142861 | ||
|
|
de6b2bb66d | ||
|
|
0ae656d8e4 | ||
|
|
3cdbda157b | ||
|
|
a0b0f89ead | ||
|
|
a39484a92c | ||
|
|
f00275a880 | ||
|
|
684c977365 | ||
|
|
8f7ae168ab | ||
|
|
3aba00b4d8 | ||
|
|
4712232d0a | ||
|
|
95bf9a08e7 | ||
|
|
15323e74d6 | ||
|
|
3902192a41 | ||
|
|
0b984ffac6 | ||
|
|
ecee96e3e3 |
13
.auctor.json
Normal file
13
.auctor.json
Normal file
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"authors": [
|
||||
"shivammittal274",
|
||||
"Nikhil Sonti",
|
||||
"Dani Akash",
|
||||
"Nikhil",
|
||||
"Felarof",
|
||||
"Neel Gupta"
|
||||
],
|
||||
"server_url": "http://localhost:3001",
|
||||
"convex_url": "https://cheery-barracuda-158.convex.cloud",
|
||||
"repo_url": "/Users/felarof01/Workspaces/build/browseros-main"
|
||||
}
|
||||
164
.claude/skills/brainstorming/SKILL.md
Normal file
164
.claude/skills/brainstorming/SKILL.md
Normal file
@@ -0,0 +1,164 @@
|
||||
---
|
||||
name: sup-brainstorming
|
||||
description: "You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation."
|
||||
---
|
||||
|
||||
# Brainstorming Ideas Into Designs
|
||||
|
||||
Help turn ideas into fully formed designs and specs through natural collaborative dialogue.
|
||||
|
||||
Start by understanding the current project context, then ask questions one at a time to refine the idea. Once you understand what you're building, present the design and get user approval.
|
||||
|
||||
<HARD-GATE>
|
||||
Do NOT invoke any implementation skill, write any code, scaffold any project, or take any implementation action until you have presented a design and the user has approved it. This applies to EVERY project regardless of perceived simplicity.
|
||||
</HARD-GATE>
|
||||
|
||||
## Anti-Pattern: "This Is Too Simple To Need A Design"
|
||||
|
||||
Every project goes through this process. A todo list, a single-function utility, a config change — all of them. "Simple" projects are where unexamined assumptions cause the most wasted work. The design can be short (a few sentences for truly simple projects), but you MUST present it and get approval.
|
||||
|
||||
## Checklist
|
||||
|
||||
You MUST create a task for each of these items and complete them in order:
|
||||
|
||||
1. **Explore project context** — check files, docs, recent commits
|
||||
2. **Offer visual companion** (if topic will involve visual questions) — this is its own message, not combined with a clarifying question. See the Visual Companion section below.
|
||||
3. **Ask clarifying questions** — one at a time, understand purpose/constraints/success criteria
|
||||
4. **Propose 2-3 approaches** — with trade-offs and your recommendation
|
||||
5. **Present design** — in sections scaled to their complexity, get user approval after each section
|
||||
6. **Write design doc** — save to `.llm/specs/YYYY-MM-DD-<topic>-design.md` and commit
|
||||
7. **Spec self-review** — quick inline check for placeholders, contradictions, ambiguity, scope (see below)
|
||||
8. **User reviews written spec** — ask user to review the spec file before proceeding
|
||||
9. **Transition to implementation** — invoke writing-plans skill to create implementation plan
|
||||
|
||||
## Process Flow
|
||||
|
||||
```dot
|
||||
digraph brainstorming {
|
||||
"Explore project context" [shape=box];
|
||||
"Visual questions ahead?" [shape=diamond];
|
||||
"Offer Visual Companion\n(own message, no other content)" [shape=box];
|
||||
"Ask clarifying questions" [shape=box];
|
||||
"Propose 2-3 approaches" [shape=box];
|
||||
"Present design sections" [shape=box];
|
||||
"User approves design?" [shape=diamond];
|
||||
"Write design doc" [shape=box];
|
||||
"Spec self-review\n(fix inline)" [shape=box];
|
||||
"User reviews spec?" [shape=diamond];
|
||||
"Invoke writing-plans skill" [shape=doublecircle];
|
||||
|
||||
"Explore project context" -> "Visual questions ahead?";
|
||||
"Visual questions ahead?" -> "Offer Visual Companion\n(own message, no other content)" [label="yes"];
|
||||
"Visual questions ahead?" -> "Ask clarifying questions" [label="no"];
|
||||
"Offer Visual Companion\n(own message, no other content)" -> "Ask clarifying questions";
|
||||
"Ask clarifying questions" -> "Propose 2-3 approaches";
|
||||
"Propose 2-3 approaches" -> "Present design sections";
|
||||
"Present design sections" -> "User approves design?";
|
||||
"User approves design?" -> "Present design sections" [label="no, revise"];
|
||||
"User approves design?" -> "Write design doc" [label="yes"];
|
||||
"Write design doc" -> "Spec self-review\n(fix inline)";
|
||||
"Spec self-review\n(fix inline)" -> "User reviews spec?";
|
||||
"User reviews spec?" -> "Write design doc" [label="changes requested"];
|
||||
"User reviews spec?" -> "Invoke writing-plans skill" [label="approved"];
|
||||
}
|
||||
```
|
||||
|
||||
**The terminal state is invoking writing-plans.** Do NOT invoke frontend-design, mcp-builder, or any other implementation skill. The ONLY skill you invoke after brainstorming is writing-plans.
|
||||
|
||||
## The Process
|
||||
|
||||
**Understanding the idea:**
|
||||
|
||||
- Check out the current project state first (files, docs, recent commits)
|
||||
- Before asking detailed questions, assess scope: if the request describes multiple independent subsystems (e.g., "build a platform with chat, file storage, billing, and analytics"), flag this immediately. Don't spend questions refining details of a project that needs to be decomposed first.
|
||||
- If the project is too large for a single spec, help the user decompose into sub-projects: what are the independent pieces, how do they relate, what order should they be built? Then brainstorm the first sub-project through the normal design flow. Each sub-project gets its own spec → plan → implementation cycle.
|
||||
- For appropriately-scoped projects, ask questions one at a time to refine the idea
|
||||
- Prefer multiple choice questions when possible, but open-ended is fine too
|
||||
- Only one question per message - if a topic needs more exploration, break it into multiple questions
|
||||
- Focus on understanding: purpose, constraints, success criteria
|
||||
|
||||
**Exploring approaches:**
|
||||
|
||||
- Propose 2-3 different approaches with trade-offs
|
||||
- Present options conversationally with your recommendation and reasoning
|
||||
- Lead with your recommended option and explain why
|
||||
|
||||
**Presenting the design:**
|
||||
|
||||
- Once you believe you understand what you're building, present the design
|
||||
- Scale each section to its complexity: a few sentences if straightforward, up to 200-300 words if nuanced
|
||||
- Ask after each section whether it looks right so far
|
||||
- Cover: architecture, components, data flow, error handling, testing
|
||||
- Be ready to go back and clarify if something doesn't make sense
|
||||
|
||||
**Design for isolation and clarity:**
|
||||
|
||||
- Break the system into smaller units that each have one clear purpose, communicate through well-defined interfaces, and can be understood and tested independently
|
||||
- For each unit, you should be able to answer: what does it do, how do you use it, and what does it depend on?
|
||||
- Can someone understand what a unit does without reading its internals? Can you change the internals without breaking consumers? If not, the boundaries need work.
|
||||
- Smaller, well-bounded units are also easier for you to work with - you reason better about code you can hold in context at once, and your edits are more reliable when files are focused. When a file grows large, that's often a signal that it's doing too much.
|
||||
|
||||
**Working in existing codebases:**
|
||||
|
||||
- Explore the current structure before proposing changes. Follow existing patterns.
|
||||
- Where existing code has problems that affect the work (e.g., a file that's grown too large, unclear boundaries, tangled responsibilities), include targeted improvements as part of the design - the way a good developer improves code they're working in.
|
||||
- Don't propose unrelated refactoring. Stay focused on what serves the current goal.
|
||||
|
||||
## After the Design
|
||||
|
||||
**Documentation:**
|
||||
|
||||
- Write the validated design (spec) to `.llm/specs/YYYY-MM-DD-<topic>-design.md`
|
||||
- (User preferences for spec location override this default)
|
||||
- Use elements-of-style:writing-clearly-and-concisely skill if available
|
||||
- Commit the design document to git
|
||||
|
||||
**Spec Self-Review:**
|
||||
After writing the spec document, look at it with fresh eyes:
|
||||
|
||||
1. **Placeholder scan:** Any "TBD", "TODO", incomplete sections, or vague requirements? Fix them.
|
||||
2. **Internal consistency:** Do any sections contradict each other? Does the architecture match the feature descriptions?
|
||||
3. **Scope check:** Is this focused enough for a single implementation plan, or does it need decomposition?
|
||||
4. **Ambiguity check:** Could any requirement be interpreted two different ways? If so, pick one and make it explicit.
|
||||
|
||||
Fix any issues inline. No need to re-review — just fix and move on.
|
||||
|
||||
**User Review Gate:**
|
||||
After the spec review loop passes, ask the user to review the written spec before proceeding:
|
||||
|
||||
> "Spec written and committed to `<path>`. Please review it and let me know if you want to make any changes before we start writing out the implementation plan."
|
||||
|
||||
Wait for the user's response. If they request changes, make them and re-run the spec review loop. Only proceed once the user approves.
|
||||
|
||||
**Implementation:**
|
||||
|
||||
- Invoke the writing-plans skill to create a detailed implementation plan
|
||||
- Do NOT invoke any other skill. writing-plans is the next step.
|
||||
|
||||
## Key Principles
|
||||
|
||||
- **One question at a time** - Don't overwhelm with multiple questions
|
||||
- **Multiple choice preferred** - Easier to answer than open-ended when possible
|
||||
- **YAGNI ruthlessly** - Remove unnecessary features from all designs
|
||||
- **Explore alternatives** - Always propose 2-3 approaches before settling
|
||||
- **Incremental validation** - Present design, get approval before moving on
|
||||
- **Be flexible** - Go back and clarify when something doesn't make sense
|
||||
|
||||
## Visual Companion
|
||||
|
||||
A browser-based companion for showing mockups, diagrams, and visual options during brainstorming. Available as a tool — not a mode. Accepting the companion means it's available for questions that benefit from visual treatment; it does NOT mean every question goes through the browser.
|
||||
|
||||
**Offering the companion:** When you anticipate that upcoming questions will involve visual content (mockups, layouts, diagrams), offer it once for consent:
|
||||
> "Some of what we're working on might be easier to explain if I can show it to you in a web browser. I can put together mockups, diagrams, comparisons, and other visuals as we go. This feature is still new and can be token-intensive. Want to try it? (Requires opening a local URL)"
|
||||
|
||||
**This offer MUST be its own message.** Do not combine it with clarifying questions, context summaries, or any other content. The message should contain ONLY the offer above and nothing else. Wait for the user's response before continuing. If they decline, proceed with text-only brainstorming.
|
||||
|
||||
**Per-question decision:** Even after the user accepts, decide FOR EACH QUESTION whether to use the browser or the terminal. The test: **would the user understand this better by seeing it than reading it?**
|
||||
|
||||
- **Use the browser** for content that IS visual — mockups, wireframes, layout comparisons, architecture diagrams, side-by-side visual designs
|
||||
- **Use the terminal** for content that is text — requirements questions, conceptual choices, tradeoff lists, A/B/C/D text options, scope decisions
|
||||
|
||||
A question about a UI topic is not automatically a visual question. "What does personality mean in this context?" is a conceptual question — use the terminal. "Which wizard layout works better?" is a visual question — use the browser.
|
||||
|
||||
If they agree to the companion, read the detailed guide before proceeding:
|
||||
`skills/brainstorming/visual-companion.md`
|
||||
214
.claude/skills/brainstorming/scripts/frame-template.html
Normal file
214
.claude/skills/brainstorming/scripts/frame-template.html
Normal file
@@ -0,0 +1,214 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Superpowers Brainstorming</title>
|
||||
<style>
|
||||
/*
|
||||
* BRAINSTORM COMPANION FRAME TEMPLATE
|
||||
*
|
||||
* This template provides a consistent frame with:
|
||||
* - OS-aware light/dark theming
|
||||
* - Fixed header and selection indicator bar
|
||||
* - Scrollable main content area
|
||||
* - CSS helpers for common UI patterns
|
||||
*
|
||||
* Content is injected via placeholder comment in #claude-content.
|
||||
*/
|
||||
|
||||
* { box-sizing: border-box; margin: 0; padding: 0; }
|
||||
html, body { height: 100%; overflow: hidden; }
|
||||
|
||||
/* ===== THEME VARIABLES ===== */
|
||||
:root {
|
||||
--bg-primary: #f5f5f7;
|
||||
--bg-secondary: #ffffff;
|
||||
--bg-tertiary: #e5e5e7;
|
||||
--border: #d1d1d6;
|
||||
--text-primary: #1d1d1f;
|
||||
--text-secondary: #86868b;
|
||||
--text-tertiary: #aeaeb2;
|
||||
--accent: #0071e3;
|
||||
--accent-hover: #0077ed;
|
||||
--success: #34c759;
|
||||
--warning: #ff9f0a;
|
||||
--error: #ff3b30;
|
||||
--selected-bg: #e8f4fd;
|
||||
--selected-border: #0071e3;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
--bg-primary: #1d1d1f;
|
||||
--bg-secondary: #2d2d2f;
|
||||
--bg-tertiary: #3d3d3f;
|
||||
--border: #424245;
|
||||
--text-primary: #f5f5f7;
|
||||
--text-secondary: #86868b;
|
||||
--text-tertiary: #636366;
|
||||
--accent: #0a84ff;
|
||||
--accent-hover: #409cff;
|
||||
--selected-bg: rgba(10, 132, 255, 0.15);
|
||||
--selected-border: #0a84ff;
|
||||
}
|
||||
}
|
||||
|
||||
body {
|
||||
font-family: system-ui, -apple-system, BlinkMacSystemFont, sans-serif;
|
||||
background: var(--bg-primary);
|
||||
color: var(--text-primary);
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
/* ===== FRAME STRUCTURE ===== */
|
||||
.header {
|
||||
background: var(--bg-secondary);
|
||||
padding: 0.5rem 1.5rem;
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
border-bottom: 1px solid var(--border);
|
||||
flex-shrink: 0;
|
||||
}
|
||||
.header h1 { font-size: 0.85rem; font-weight: 500; color: var(--text-secondary); }
|
||||
.header .status { font-size: 0.7rem; color: var(--success); display: flex; align-items: center; gap: 0.4rem; }
|
||||
.header .status::before { content: ''; width: 6px; height: 6px; background: var(--success); border-radius: 50%; }
|
||||
|
||||
.main { flex: 1; overflow-y: auto; }
|
||||
#claude-content { padding: 2rem; min-height: 100%; }
|
||||
|
||||
.indicator-bar {
|
||||
background: var(--bg-secondary);
|
||||
border-top: 1px solid var(--border);
|
||||
padding: 0.5rem 1.5rem;
|
||||
flex-shrink: 0;
|
||||
text-align: center;
|
||||
}
|
||||
.indicator-bar span {
|
||||
font-size: 0.75rem;
|
||||
color: var(--text-secondary);
|
||||
}
|
||||
.indicator-bar .selected-text {
|
||||
color: var(--accent);
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
/* ===== TYPOGRAPHY ===== */
|
||||
h2 { font-size: 1.5rem; font-weight: 600; margin-bottom: 0.5rem; }
|
||||
h3 { font-size: 1.1rem; font-weight: 600; margin-bottom: 0.25rem; }
|
||||
.subtitle { color: var(--text-secondary); margin-bottom: 1.5rem; }
|
||||
.section { margin-bottom: 2rem; }
|
||||
.label { font-size: 0.7rem; color: var(--text-secondary); text-transform: uppercase; letter-spacing: 0.05em; margin-bottom: 0.5rem; }
|
||||
|
||||
/* ===== OPTIONS (for A/B/C choices) ===== */
|
||||
.options { display: flex; flex-direction: column; gap: 0.75rem; }
|
||||
.option {
|
||||
background: var(--bg-secondary);
|
||||
border: 2px solid var(--border);
|
||||
border-radius: 12px;
|
||||
padding: 1rem 1.25rem;
|
||||
cursor: pointer;
|
||||
transition: all 0.15s ease;
|
||||
display: flex;
|
||||
align-items: flex-start;
|
||||
gap: 1rem;
|
||||
}
|
||||
.option:hover { border-color: var(--accent); }
|
||||
.option.selected { background: var(--selected-bg); border-color: var(--selected-border); }
|
||||
.option .letter {
|
||||
background: var(--bg-tertiary);
|
||||
color: var(--text-secondary);
|
||||
width: 1.75rem; height: 1.75rem;
|
||||
border-radius: 6px;
|
||||
display: flex; align-items: center; justify-content: center;
|
||||
font-weight: 600; font-size: 0.85rem; flex-shrink: 0;
|
||||
}
|
||||
.option.selected .letter { background: var(--accent); color: white; }
|
||||
.option .content { flex: 1; }
|
||||
.option .content h3 { font-size: 0.95rem; margin-bottom: 0.15rem; }
|
||||
.option .content p { color: var(--text-secondary); font-size: 0.85rem; margin: 0; }
|
||||
|
||||
/* ===== CARDS (for showing designs/mockups) ===== */
|
||||
.cards { display: grid; grid-template-columns: repeat(auto-fit, minmax(280px, 1fr)); gap: 1rem; }
|
||||
.card {
|
||||
background: var(--bg-secondary);
|
||||
border: 1px solid var(--border);
|
||||
border-radius: 12px;
|
||||
overflow: hidden;
|
||||
cursor: pointer;
|
||||
transition: all 0.15s ease;
|
||||
}
|
||||
.card:hover { border-color: var(--accent); transform: translateY(-2px); box-shadow: 0 4px 12px rgba(0,0,0,0.1); }
|
||||
.card.selected { border-color: var(--selected-border); border-width: 2px; }
|
||||
.card-image { background: var(--bg-tertiary); aspect-ratio: 16/10; display: flex; align-items: center; justify-content: center; }
|
||||
.card-body { padding: 1rem; }
|
||||
.card-body h3 { margin-bottom: 0.25rem; }
|
||||
.card-body p { color: var(--text-secondary); font-size: 0.85rem; }
|
||||
|
||||
/* ===== MOCKUP CONTAINER ===== */
|
||||
.mockup {
|
||||
background: var(--bg-secondary);
|
||||
border: 1px solid var(--border);
|
||||
border-radius: 12px;
|
||||
overflow: hidden;
|
||||
margin-bottom: 1.5rem;
|
||||
}
|
||||
.mockup-header {
|
||||
background: var(--bg-tertiary);
|
||||
padding: 0.5rem 1rem;
|
||||
font-size: 0.75rem;
|
||||
color: var(--text-secondary);
|
||||
border-bottom: 1px solid var(--border);
|
||||
}
|
||||
.mockup-body { padding: 1.5rem; }
|
||||
|
||||
/* ===== SPLIT VIEW (side-by-side comparison) ===== */
|
||||
.split { display: grid; grid-template-columns: 1fr 1fr; gap: 1.5rem; }
|
||||
@media (max-width: 700px) { .split { grid-template-columns: 1fr; } }
|
||||
|
||||
/* ===== PROS/CONS ===== */
|
||||
.pros-cons { display: grid; grid-template-columns: 1fr 1fr; gap: 1rem; margin: 1rem 0; }
|
||||
.pros, .cons { background: var(--bg-secondary); border-radius: 8px; padding: 1rem; }
|
||||
.pros h4 { color: var(--success); font-size: 0.85rem; margin-bottom: 0.5rem; }
|
||||
.cons h4 { color: var(--error); font-size: 0.85rem; margin-bottom: 0.5rem; }
|
||||
.pros ul, .cons ul { margin-left: 1.25rem; font-size: 0.85rem; color: var(--text-secondary); }
|
||||
.pros li, .cons li { margin-bottom: 0.25rem; }
|
||||
|
||||
/* ===== PLACEHOLDER (for mockup areas) ===== */
|
||||
.placeholder {
|
||||
background: var(--bg-tertiary);
|
||||
border: 2px dashed var(--border);
|
||||
border-radius: 8px;
|
||||
padding: 2rem;
|
||||
text-align: center;
|
||||
color: var(--text-tertiary);
|
||||
}
|
||||
|
||||
/* ===== INLINE MOCKUP ELEMENTS ===== */
|
||||
.mock-nav { background: var(--accent); color: white; padding: 0.75rem 1rem; display: flex; gap: 1.5rem; font-size: 0.9rem; }
|
||||
.mock-sidebar { background: var(--bg-tertiary); padding: 1rem; min-width: 180px; }
|
||||
.mock-content { padding: 1.5rem; flex: 1; }
|
||||
.mock-button { background: var(--accent); color: white; border: none; padding: 0.5rem 1rem; border-radius: 6px; font-size: 0.85rem; }
|
||||
.mock-input { background: var(--bg-primary); border: 1px solid var(--border); border-radius: 6px; padding: 0.5rem; width: 100%; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
<h1><a href="https://github.com/obra/superpowers" style="color: inherit; text-decoration: none;">Superpowers Brainstorming</a></h1>
|
||||
<div class="status">Connected</div>
|
||||
</div>
|
||||
|
||||
<div class="main">
|
||||
<div id="claude-content">
|
||||
<!-- CONTENT -->
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="indicator-bar">
|
||||
<span id="indicator-text">Click an option above, then return to the terminal</span>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
88
.claude/skills/brainstorming/scripts/helper.js
Normal file
88
.claude/skills/brainstorming/scripts/helper.js
Normal file
@@ -0,0 +1,88 @@
|
||||
(function() {
|
||||
const WS_URL = 'ws://' + window.location.host;
|
||||
let ws = null;
|
||||
let eventQueue = [];
|
||||
|
||||
function connect() {
|
||||
ws = new WebSocket(WS_URL);
|
||||
|
||||
ws.onopen = () => {
|
||||
eventQueue.forEach(e => ws.send(JSON.stringify(e)));
|
||||
eventQueue = [];
|
||||
};
|
||||
|
||||
ws.onmessage = (msg) => {
|
||||
const data = JSON.parse(msg.data);
|
||||
if (data.type === 'reload') {
|
||||
window.location.reload();
|
||||
}
|
||||
};
|
||||
|
||||
ws.onclose = () => {
|
||||
setTimeout(connect, 1000);
|
||||
};
|
||||
}
|
||||
|
||||
function sendEvent(event) {
|
||||
event.timestamp = Date.now();
|
||||
if (ws && ws.readyState === WebSocket.OPEN) {
|
||||
ws.send(JSON.stringify(event));
|
||||
} else {
|
||||
eventQueue.push(event);
|
||||
}
|
||||
}
|
||||
|
||||
// Capture clicks on choice elements
|
||||
document.addEventListener('click', (e) => {
|
||||
const target = e.target.closest('[data-choice]');
|
||||
if (!target) return;
|
||||
|
||||
sendEvent({
|
||||
type: 'click',
|
||||
text: target.textContent.trim(),
|
||||
choice: target.dataset.choice,
|
||||
id: target.id || null
|
||||
});
|
||||
|
||||
// Update indicator bar (defer so toggleSelect runs first)
|
||||
setTimeout(() => {
|
||||
const indicator = document.getElementById('indicator-text');
|
||||
if (!indicator) return;
|
||||
const container = target.closest('.options') || target.closest('.cards');
|
||||
const selected = container ? container.querySelectorAll('.selected') : [];
|
||||
if (selected.length === 0) {
|
||||
indicator.textContent = 'Click an option above, then return to the terminal';
|
||||
} else if (selected.length === 1) {
|
||||
const label = selected[0].querySelector('h3, .content h3, .card-body h3')?.textContent?.trim() || selected[0].dataset.choice;
|
||||
indicator.innerHTML = '<span class="selected-text">' + label + ' selected</span> — return to terminal to continue';
|
||||
} else {
|
||||
indicator.innerHTML = '<span class="selected-text">' + selected.length + ' selected</span> — return to terminal to continue';
|
||||
}
|
||||
}, 0);
|
||||
});
|
||||
|
||||
// Frame UI: selection tracking
|
||||
window.selectedChoice = null;
|
||||
|
||||
window.toggleSelect = function(el) {
|
||||
const container = el.closest('.options') || el.closest('.cards');
|
||||
const multi = container && container.dataset.multiselect !== undefined;
|
||||
if (container && !multi) {
|
||||
container.querySelectorAll('.option, .card').forEach(o => o.classList.remove('selected'));
|
||||
}
|
||||
if (multi) {
|
||||
el.classList.toggle('selected');
|
||||
} else {
|
||||
el.classList.add('selected');
|
||||
}
|
||||
window.selectedChoice = el.dataset.choice;
|
||||
};
|
||||
|
||||
// Expose API for explicit use
|
||||
window.brainstorm = {
|
||||
send: sendEvent,
|
||||
choice: (value, metadata = {}) => sendEvent({ type: 'choice', value, ...metadata })
|
||||
};
|
||||
|
||||
connect();
|
||||
})();
|
||||
354
.claude/skills/brainstorming/scripts/server.cjs
Normal file
354
.claude/skills/brainstorming/scripts/server.cjs
Normal file
@@ -0,0 +1,354 @@
|
||||
const crypto = require('crypto');
|
||||
const http = require('http');
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
|
||||
// ========== WebSocket Protocol (RFC 6455) ==========
|
||||
|
||||
const OPCODES = { TEXT: 0x01, CLOSE: 0x08, PING: 0x09, PONG: 0x0A };
|
||||
const WS_MAGIC = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11';
|
||||
|
||||
function computeAcceptKey(clientKey) {
|
||||
return crypto.createHash('sha1').update(clientKey + WS_MAGIC).digest('base64');
|
||||
}
|
||||
|
||||
function encodeFrame(opcode, payload) {
|
||||
const fin = 0x80;
|
||||
const len = payload.length;
|
||||
let header;
|
||||
|
||||
if (len < 126) {
|
||||
header = Buffer.alloc(2);
|
||||
header[0] = fin | opcode;
|
||||
header[1] = len;
|
||||
} else if (len < 65536) {
|
||||
header = Buffer.alloc(4);
|
||||
header[0] = fin | opcode;
|
||||
header[1] = 126;
|
||||
header.writeUInt16BE(len, 2);
|
||||
} else {
|
||||
header = Buffer.alloc(10);
|
||||
header[0] = fin | opcode;
|
||||
header[1] = 127;
|
||||
header.writeBigUInt64BE(BigInt(len), 2);
|
||||
}
|
||||
|
||||
return Buffer.concat([header, payload]);
|
||||
}
|
||||
|
||||
function decodeFrame(buffer) {
|
||||
if (buffer.length < 2) return null;
|
||||
|
||||
const secondByte = buffer[1];
|
||||
const opcode = buffer[0] & 0x0F;
|
||||
const masked = (secondByte & 0x80) !== 0;
|
||||
let payloadLen = secondByte & 0x7F;
|
||||
let offset = 2;
|
||||
|
||||
if (!masked) throw new Error('Client frames must be masked');
|
||||
|
||||
if (payloadLen === 126) {
|
||||
if (buffer.length < 4) return null;
|
||||
payloadLen = buffer.readUInt16BE(2);
|
||||
offset = 4;
|
||||
} else if (payloadLen === 127) {
|
||||
if (buffer.length < 10) return null;
|
||||
payloadLen = Number(buffer.readBigUInt64BE(2));
|
||||
offset = 10;
|
||||
}
|
||||
|
||||
const maskOffset = offset;
|
||||
const dataOffset = offset + 4;
|
||||
const totalLen = dataOffset + payloadLen;
|
||||
if (buffer.length < totalLen) return null;
|
||||
|
||||
const mask = buffer.slice(maskOffset, dataOffset);
|
||||
const data = Buffer.alloc(payloadLen);
|
||||
for (let i = 0; i < payloadLen; i++) {
|
||||
data[i] = buffer[dataOffset + i] ^ mask[i % 4];
|
||||
}
|
||||
|
||||
return { opcode, payload: data, bytesConsumed: totalLen };
|
||||
}
|
||||
|
||||
// ========== Configuration ==========
|
||||
|
||||
const PORT = process.env.BRAINSTORM_PORT || (49152 + Math.floor(Math.random() * 16383));
|
||||
const HOST = process.env.BRAINSTORM_HOST || '127.0.0.1';
|
||||
const URL_HOST = process.env.BRAINSTORM_URL_HOST || (HOST === '127.0.0.1' ? 'localhost' : HOST);
|
||||
const SESSION_DIR = process.env.BRAINSTORM_DIR || '/tmp/brainstorm';
|
||||
const CONTENT_DIR = path.join(SESSION_DIR, 'content');
|
||||
const STATE_DIR = path.join(SESSION_DIR, 'state');
|
||||
let ownerPid = process.env.BRAINSTORM_OWNER_PID ? Number(process.env.BRAINSTORM_OWNER_PID) : null;
|
||||
|
||||
const MIME_TYPES = {
|
||||
'.html': 'text/html', '.css': 'text/css', '.js': 'application/javascript',
|
||||
'.json': 'application/json', '.png': 'image/png', '.jpg': 'image/jpeg',
|
||||
'.jpeg': 'image/jpeg', '.gif': 'image/gif', '.svg': 'image/svg+xml'
|
||||
};
|
||||
|
||||
// ========== Templates and Constants ==========
|
||||
|
||||
const WAITING_PAGE = `<!DOCTYPE html>
|
||||
<html>
|
||||
<head><meta charset="utf-8"><title>Brainstorm Companion</title>
|
||||
<style>body { font-family: system-ui, sans-serif; padding: 2rem; max-width: 800px; margin: 0 auto; }
|
||||
h1 { color: #333; } p { color: #666; }</style>
|
||||
</head>
|
||||
<body><h1>Brainstorm Companion</h1>
|
||||
<p>Waiting for the agent to push a screen...</p></body></html>`;
|
||||
|
||||
const frameTemplate = fs.readFileSync(path.join(__dirname, 'frame-template.html'), 'utf-8');
|
||||
const helperScript = fs.readFileSync(path.join(__dirname, 'helper.js'), 'utf-8');
|
||||
const helperInjection = '<script>\n' + helperScript + '\n</script>';
|
||||
|
||||
// ========== Helper Functions ==========
|
||||
|
||||
function isFullDocument(html) {
|
||||
const trimmed = html.trimStart().toLowerCase();
|
||||
return trimmed.startsWith('<!doctype') || trimmed.startsWith('<html');
|
||||
}
|
||||
|
||||
function wrapInFrame(content) {
|
||||
return frameTemplate.replace('<!-- CONTENT -->', content);
|
||||
}
|
||||
|
||||
function getNewestScreen() {
|
||||
const files = fs.readdirSync(CONTENT_DIR)
|
||||
.filter(f => f.endsWith('.html'))
|
||||
.map(f => {
|
||||
const fp = path.join(CONTENT_DIR, f);
|
||||
return { path: fp, mtime: fs.statSync(fp).mtime.getTime() };
|
||||
})
|
||||
.sort((a, b) => b.mtime - a.mtime);
|
||||
return files.length > 0 ? files[0].path : null;
|
||||
}
|
||||
|
||||
// ========== HTTP Request Handler ==========
|
||||
|
||||
function handleRequest(req, res) {
|
||||
touchActivity();
|
||||
if (req.method === 'GET' && req.url === '/') {
|
||||
const screenFile = getNewestScreen();
|
||||
let html = screenFile
|
||||
? (raw => isFullDocument(raw) ? raw : wrapInFrame(raw))(fs.readFileSync(screenFile, 'utf-8'))
|
||||
: WAITING_PAGE;
|
||||
|
||||
if (html.includes('</body>')) {
|
||||
html = html.replace('</body>', helperInjection + '\n</body>');
|
||||
} else {
|
||||
html += helperInjection;
|
||||
}
|
||||
|
||||
res.writeHead(200, { 'Content-Type': 'text/html; charset=utf-8' });
|
||||
res.end(html);
|
||||
} else if (req.method === 'GET' && req.url.startsWith('/files/')) {
|
||||
const fileName = req.url.slice(7);
|
||||
const filePath = path.join(CONTENT_DIR, path.basename(fileName));
|
||||
if (!fs.existsSync(filePath)) {
|
||||
res.writeHead(404);
|
||||
res.end('Not found');
|
||||
return;
|
||||
}
|
||||
const ext = path.extname(filePath).toLowerCase();
|
||||
const contentType = MIME_TYPES[ext] || 'application/octet-stream';
|
||||
res.writeHead(200, { 'Content-Type': contentType });
|
||||
res.end(fs.readFileSync(filePath));
|
||||
} else {
|
||||
res.writeHead(404);
|
||||
res.end('Not found');
|
||||
}
|
||||
}
|
||||
|
||||
// ========== WebSocket Connection Handling ==========
|
||||
|
||||
const clients = new Set();
|
||||
|
||||
function handleUpgrade(req, socket) {
|
||||
const key = req.headers['sec-websocket-key'];
|
||||
if (!key) { socket.destroy(); return; }
|
||||
|
||||
const accept = computeAcceptKey(key);
|
||||
socket.write(
|
||||
'HTTP/1.1 101 Switching Protocols\r\n' +
|
||||
'Upgrade: websocket\r\n' +
|
||||
'Connection: Upgrade\r\n' +
|
||||
'Sec-WebSocket-Accept: ' + accept + '\r\n\r\n'
|
||||
);
|
||||
|
||||
let buffer = Buffer.alloc(0);
|
||||
clients.add(socket);
|
||||
|
||||
socket.on('data', (chunk) => {
|
||||
buffer = Buffer.concat([buffer, chunk]);
|
||||
while (buffer.length > 0) {
|
||||
let result;
|
||||
try {
|
||||
result = decodeFrame(buffer);
|
||||
} catch (e) {
|
||||
socket.end(encodeFrame(OPCODES.CLOSE, Buffer.alloc(0)));
|
||||
clients.delete(socket);
|
||||
return;
|
||||
}
|
||||
if (!result) break;
|
||||
buffer = buffer.slice(result.bytesConsumed);
|
||||
|
||||
switch (result.opcode) {
|
||||
case OPCODES.TEXT:
|
||||
handleMessage(result.payload.toString());
|
||||
break;
|
||||
case OPCODES.CLOSE:
|
||||
socket.end(encodeFrame(OPCODES.CLOSE, Buffer.alloc(0)));
|
||||
clients.delete(socket);
|
||||
return;
|
||||
case OPCODES.PING:
|
||||
socket.write(encodeFrame(OPCODES.PONG, result.payload));
|
||||
break;
|
||||
case OPCODES.PONG:
|
||||
break;
|
||||
default: {
|
||||
const closeBuf = Buffer.alloc(2);
|
||||
closeBuf.writeUInt16BE(1003);
|
||||
socket.end(encodeFrame(OPCODES.CLOSE, closeBuf));
|
||||
clients.delete(socket);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
socket.on('close', () => clients.delete(socket));
|
||||
socket.on('error', () => clients.delete(socket));
|
||||
}
|
||||
|
||||
function handleMessage(text) {
|
||||
let event;
|
||||
try {
|
||||
event = JSON.parse(text);
|
||||
} catch (e) {
|
||||
console.error('Failed to parse WebSocket message:', e.message);
|
||||
return;
|
||||
}
|
||||
touchActivity();
|
||||
console.log(JSON.stringify({ source: 'user-event', ...event }));
|
||||
if (event.choice) {
|
||||
const eventsFile = path.join(STATE_DIR, 'events');
|
||||
fs.appendFileSync(eventsFile, JSON.stringify(event) + '\n');
|
||||
}
|
||||
}
|
||||
|
||||
function broadcast(msg) {
|
||||
const frame = encodeFrame(OPCODES.TEXT, Buffer.from(JSON.stringify(msg)));
|
||||
for (const socket of clients) {
|
||||
try { socket.write(frame); } catch (e) { clients.delete(socket); }
|
||||
}
|
||||
}
|
||||
|
||||
// ========== Activity Tracking ==========
|
||||
|
||||
const IDLE_TIMEOUT_MS = 30 * 60 * 1000; // 30 minutes
|
||||
let lastActivity = Date.now();
|
||||
|
||||
function touchActivity() {
|
||||
lastActivity = Date.now();
|
||||
}
|
||||
|
||||
// ========== File Watching ==========
|
||||
|
||||
const debounceTimers = new Map();
|
||||
|
||||
// ========== Server Startup ==========
|
||||
|
||||
function startServer() {
|
||||
if (!fs.existsSync(CONTENT_DIR)) fs.mkdirSync(CONTENT_DIR, { recursive: true });
|
||||
if (!fs.existsSync(STATE_DIR)) fs.mkdirSync(STATE_DIR, { recursive: true });
|
||||
|
||||
// Track known files to distinguish new screens from updates.
|
||||
// macOS fs.watch reports 'rename' for both new files and overwrites,
|
||||
// so we can't rely on eventType alone.
|
||||
const knownFiles = new Set(
|
||||
fs.readdirSync(CONTENT_DIR).filter(f => f.endsWith('.html'))
|
||||
);
|
||||
|
||||
const server = http.createServer(handleRequest);
|
||||
server.on('upgrade', handleUpgrade);
|
||||
|
||||
const watcher = fs.watch(CONTENT_DIR, (eventType, filename) => {
|
||||
if (!filename || !filename.endsWith('.html')) return;
|
||||
|
||||
if (debounceTimers.has(filename)) clearTimeout(debounceTimers.get(filename));
|
||||
debounceTimers.set(filename, setTimeout(() => {
|
||||
debounceTimers.delete(filename);
|
||||
const filePath = path.join(CONTENT_DIR, filename);
|
||||
|
||||
if (!fs.existsSync(filePath)) return; // file was deleted
|
||||
touchActivity();
|
||||
|
||||
if (!knownFiles.has(filename)) {
|
||||
knownFiles.add(filename);
|
||||
const eventsFile = path.join(STATE_DIR, 'events');
|
||||
if (fs.existsSync(eventsFile)) fs.unlinkSync(eventsFile);
|
||||
console.log(JSON.stringify({ type: 'screen-added', file: filePath }));
|
||||
} else {
|
||||
console.log(JSON.stringify({ type: 'screen-updated', file: filePath }));
|
||||
}
|
||||
|
||||
broadcast({ type: 'reload' });
|
||||
}, 100));
|
||||
});
|
||||
watcher.on('error', (err) => console.error('fs.watch error:', err.message));
|
||||
|
||||
function shutdown(reason) {
|
||||
console.log(JSON.stringify({ type: 'server-stopped', reason }));
|
||||
const infoFile = path.join(STATE_DIR, 'server-info');
|
||||
if (fs.existsSync(infoFile)) fs.unlinkSync(infoFile);
|
||||
fs.writeFileSync(
|
||||
path.join(STATE_DIR, 'server-stopped'),
|
||||
JSON.stringify({ reason, timestamp: Date.now() }) + '\n'
|
||||
);
|
||||
watcher.close();
|
||||
clearInterval(lifecycleCheck);
|
||||
server.close(() => process.exit(0));
|
||||
}
|
||||
|
||||
function ownerAlive() {
|
||||
if (!ownerPid) return true;
|
||||
try { process.kill(ownerPid, 0); return true; } catch (e) { return e.code === 'EPERM'; }
|
||||
}
|
||||
|
||||
// Check every 60s: exit if owner process died or idle for 30 minutes
|
||||
const lifecycleCheck = setInterval(() => {
|
||||
if (!ownerAlive()) shutdown('owner process exited');
|
||||
else if (Date.now() - lastActivity > IDLE_TIMEOUT_MS) shutdown('idle timeout');
|
||||
}, 60 * 1000);
|
||||
lifecycleCheck.unref();
|
||||
|
||||
// Validate owner PID at startup. If it's already dead, the PID resolution
|
||||
// was wrong (common on WSL, Tailscale SSH, and cross-user scenarios).
|
||||
// Disable monitoring and rely on the idle timeout instead.
|
||||
if (ownerPid) {
|
||||
try { process.kill(ownerPid, 0); }
|
||||
catch (e) {
|
||||
if (e.code !== 'EPERM') {
|
||||
console.log(JSON.stringify({ type: 'owner-pid-invalid', pid: ownerPid, reason: 'dead at startup' }));
|
||||
ownerPid = null;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
server.listen(PORT, HOST, () => {
|
||||
const info = JSON.stringify({
|
||||
type: 'server-started', port: Number(PORT), host: HOST,
|
||||
url_host: URL_HOST, url: 'http://' + URL_HOST + ':' + PORT,
|
||||
screen_dir: CONTENT_DIR, state_dir: STATE_DIR
|
||||
});
|
||||
console.log(info);
|
||||
fs.writeFileSync(path.join(STATE_DIR, 'server-info'), info + '\n');
|
||||
});
|
||||
}
|
||||
|
||||
if (require.main === module) {
|
||||
startServer();
|
||||
}
|
||||
|
||||
module.exports = { computeAcceptKey, encodeFrame, decodeFrame, OPCODES };
|
||||
148
.claude/skills/brainstorming/scripts/start-server.sh
Executable file
148
.claude/skills/brainstorming/scripts/start-server.sh
Executable file
@@ -0,0 +1,148 @@
|
||||
#!/usr/bin/env bash
|
||||
# Start the brainstorm server and output connection info
|
||||
# Usage: start-server.sh [--project-dir <path>] [--host <bind-host>] [--url-host <display-host>] [--foreground] [--background]
|
||||
#
|
||||
# Starts server on a random high port, outputs JSON with URL.
|
||||
# Each session gets its own directory to avoid conflicts.
|
||||
#
|
||||
# Options:
|
||||
# --project-dir <path> Store session files under <path>/.superpowers/brainstorm/
|
||||
# instead of /tmp. Files persist after server stops.
|
||||
# --host <bind-host> Host/interface to bind (default: 127.0.0.1).
|
||||
# Use 0.0.0.0 in remote/containerized environments.
|
||||
# --url-host <host> Hostname shown in returned URL JSON.
|
||||
# --foreground Run server in the current terminal (no backgrounding).
|
||||
# --background Force background mode (overrides Codex auto-foreground).
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
|
||||
# Parse arguments
|
||||
PROJECT_DIR=""
|
||||
FOREGROUND="false"
|
||||
FORCE_BACKGROUND="false"
|
||||
BIND_HOST="127.0.0.1"
|
||||
URL_HOST=""
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--project-dir)
|
||||
PROJECT_DIR="$2"
|
||||
shift 2
|
||||
;;
|
||||
--host)
|
||||
BIND_HOST="$2"
|
||||
shift 2
|
||||
;;
|
||||
--url-host)
|
||||
URL_HOST="$2"
|
||||
shift 2
|
||||
;;
|
||||
--foreground|--no-daemon)
|
||||
FOREGROUND="true"
|
||||
shift
|
||||
;;
|
||||
--background|--daemon)
|
||||
FORCE_BACKGROUND="true"
|
||||
shift
|
||||
;;
|
||||
*)
|
||||
echo "{\"error\": \"Unknown argument: $1\"}"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
if [[ -z "$URL_HOST" ]]; then
|
||||
if [[ "$BIND_HOST" == "127.0.0.1" || "$BIND_HOST" == "localhost" ]]; then
|
||||
URL_HOST="localhost"
|
||||
else
|
||||
URL_HOST="$BIND_HOST"
|
||||
fi
|
||||
fi
|
||||
|
||||
# Some environments reap detached/background processes. Auto-foreground when detected.
|
||||
if [[ -n "${CODEX_CI:-}" && "$FOREGROUND" != "true" && "$FORCE_BACKGROUND" != "true" ]]; then
|
||||
FOREGROUND="true"
|
||||
fi
|
||||
|
||||
# Windows/Git Bash reaps nohup background processes. Auto-foreground when detected.
|
||||
if [[ "$FOREGROUND" != "true" && "$FORCE_BACKGROUND" != "true" ]]; then
|
||||
case "${OSTYPE:-}" in
|
||||
msys*|cygwin*|mingw*) FOREGROUND="true" ;;
|
||||
esac
|
||||
if [[ -n "${MSYSTEM:-}" ]]; then
|
||||
FOREGROUND="true"
|
||||
fi
|
||||
fi
|
||||
|
||||
# Generate unique session directory
|
||||
SESSION_ID="$$-$(date +%s)"
|
||||
|
||||
if [[ -n "$PROJECT_DIR" ]]; then
|
||||
SESSION_DIR="${PROJECT_DIR}/.superpowers/brainstorm/${SESSION_ID}"
|
||||
else
|
||||
SESSION_DIR="/tmp/brainstorm-${SESSION_ID}"
|
||||
fi
|
||||
|
||||
STATE_DIR="${SESSION_DIR}/state"
|
||||
PID_FILE="${STATE_DIR}/server.pid"
|
||||
LOG_FILE="${STATE_DIR}/server.log"
|
||||
|
||||
# Create fresh session directory with content and state peers
|
||||
mkdir -p "${SESSION_DIR}/content" "$STATE_DIR"
|
||||
|
||||
# Kill any existing server
|
||||
if [[ -f "$PID_FILE" ]]; then
|
||||
old_pid=$(cat "$PID_FILE")
|
||||
kill "$old_pid" 2>/dev/null
|
||||
rm -f "$PID_FILE"
|
||||
fi
|
||||
|
||||
cd "$SCRIPT_DIR"
|
||||
|
||||
# Resolve the harness PID (grandparent of this script).
|
||||
# $PPID is the ephemeral shell the harness spawned to run us — it dies
|
||||
# when this script exits. The harness itself is $PPID's parent.
|
||||
OWNER_PID="$(ps -o ppid= -p "$PPID" 2>/dev/null | tr -d ' ')"
|
||||
if [[ -z "$OWNER_PID" || "$OWNER_PID" == "1" ]]; then
|
||||
OWNER_PID="$PPID"
|
||||
fi
|
||||
|
||||
# Foreground mode for environments that reap detached/background processes.
|
||||
if [[ "$FOREGROUND" == "true" ]]; then
|
||||
echo "$$" > "$PID_FILE"
|
||||
env BRAINSTORM_DIR="$SESSION_DIR" BRAINSTORM_HOST="$BIND_HOST" BRAINSTORM_URL_HOST="$URL_HOST" BRAINSTORM_OWNER_PID="$OWNER_PID" node server.cjs
|
||||
exit $?
|
||||
fi
|
||||
|
||||
# Start server, capturing output to log file
|
||||
# Use nohup to survive shell exit; disown to remove from job table
|
||||
nohup env BRAINSTORM_DIR="$SESSION_DIR" BRAINSTORM_HOST="$BIND_HOST" BRAINSTORM_URL_HOST="$URL_HOST" BRAINSTORM_OWNER_PID="$OWNER_PID" node server.cjs > "$LOG_FILE" 2>&1 &
|
||||
SERVER_PID=$!
|
||||
disown "$SERVER_PID" 2>/dev/null
|
||||
echo "$SERVER_PID" > "$PID_FILE"
|
||||
|
||||
# Wait for server-started message (check log file)
|
||||
for i in {1..50}; do
|
||||
if grep -q "server-started" "$LOG_FILE" 2>/dev/null; then
|
||||
# Verify server is still alive after a short window (catches process reapers)
|
||||
alive="true"
|
||||
for _ in {1..20}; do
|
||||
if ! kill -0 "$SERVER_PID" 2>/dev/null; then
|
||||
alive="false"
|
||||
break
|
||||
fi
|
||||
sleep 0.1
|
||||
done
|
||||
if [[ "$alive" != "true" ]]; then
|
||||
echo "{\"error\": \"Server started but was killed. Retry in a persistent terminal with: $SCRIPT_DIR/start-server.sh${PROJECT_DIR:+ --project-dir $PROJECT_DIR} --host $BIND_HOST --url-host $URL_HOST --foreground\"}"
|
||||
exit 1
|
||||
fi
|
||||
grep "server-started" "$LOG_FILE" | head -1
|
||||
exit 0
|
||||
fi
|
||||
sleep 0.1
|
||||
done
|
||||
|
||||
# Timeout - server didn't start
|
||||
echo '{"error": "Server failed to start within 5 seconds"}'
|
||||
exit 1
|
||||
56
.claude/skills/brainstorming/scripts/stop-server.sh
Executable file
56
.claude/skills/brainstorming/scripts/stop-server.sh
Executable file
@@ -0,0 +1,56 @@
|
||||
#!/usr/bin/env bash
|
||||
# Stop the brainstorm server and clean up
|
||||
# Usage: stop-server.sh <session_dir>
|
||||
#
|
||||
# Kills the server process. Only deletes session directory if it's
|
||||
# under /tmp (ephemeral). Persistent directories (.superpowers/) are
|
||||
# kept so mockups can be reviewed later.
|
||||
|
||||
SESSION_DIR="$1"
|
||||
|
||||
if [[ -z "$SESSION_DIR" ]]; then
|
||||
echo '{"error": "Usage: stop-server.sh <session_dir>"}'
|
||||
exit 1
|
||||
fi
|
||||
|
||||
STATE_DIR="${SESSION_DIR}/state"
|
||||
PID_FILE="${STATE_DIR}/server.pid"
|
||||
|
||||
if [[ -f "$PID_FILE" ]]; then
|
||||
pid=$(cat "$PID_FILE")
|
||||
|
||||
# Try to stop gracefully, fallback to force if still alive
|
||||
kill "$pid" 2>/dev/null || true
|
||||
|
||||
# Wait for graceful shutdown (up to ~2s)
|
||||
for i in {1..20}; do
|
||||
if ! kill -0 "$pid" 2>/dev/null; then
|
||||
break
|
||||
fi
|
||||
sleep 0.1
|
||||
done
|
||||
|
||||
# If still running, escalate to SIGKILL
|
||||
if kill -0 "$pid" 2>/dev/null; then
|
||||
kill -9 "$pid" 2>/dev/null || true
|
||||
|
||||
# Give SIGKILL a moment to take effect
|
||||
sleep 0.1
|
||||
fi
|
||||
|
||||
if kill -0 "$pid" 2>/dev/null; then
|
||||
echo '{"status": "failed", "error": "process still running"}'
|
||||
exit 1
|
||||
fi
|
||||
|
||||
rm -f "$PID_FILE" "${STATE_DIR}/server.log"
|
||||
|
||||
# Only delete ephemeral /tmp directories
|
||||
if [[ "$SESSION_DIR" == /tmp/* ]]; then
|
||||
rm -rf "$SESSION_DIR"
|
||||
fi
|
||||
|
||||
echo '{"status": "stopped"}'
|
||||
else
|
||||
echo '{"status": "not_running"}'
|
||||
fi
|
||||
@@ -0,0 +1,49 @@
|
||||
# Spec Document Reviewer Prompt Template
|
||||
|
||||
Use this template when dispatching a spec document reviewer subagent.
|
||||
|
||||
**Purpose:** Verify the spec is complete, consistent, and ready for implementation planning.
|
||||
|
||||
**Dispatch after:** Spec document is written to .llm/specs/
|
||||
|
||||
```
|
||||
Task tool (general-purpose):
|
||||
description: "Review spec document"
|
||||
prompt: |
|
||||
You are a spec document reviewer. Verify this spec is complete and ready for planning.
|
||||
|
||||
**Spec to review:** [SPEC_FILE_PATH]
|
||||
|
||||
## What to Check
|
||||
|
||||
| Category | What to Look For |
|
||||
|----------|------------------|
|
||||
| Completeness | TODOs, placeholders, "TBD", incomplete sections |
|
||||
| Consistency | Internal contradictions, conflicting requirements |
|
||||
| Clarity | Requirements ambiguous enough to cause someone to build the wrong thing |
|
||||
| Scope | Focused enough for a single plan — not covering multiple independent subsystems |
|
||||
| YAGNI | Unrequested features, over-engineering |
|
||||
|
||||
## Calibration
|
||||
|
||||
**Only flag issues that would cause real problems during implementation planning.**
|
||||
A missing section, a contradiction, or a requirement so ambiguous it could be
|
||||
interpreted two different ways — those are issues. Minor wording improvements,
|
||||
stylistic preferences, and "sections less detailed than others" are not.
|
||||
|
||||
Approve unless there are serious gaps that would lead to a flawed plan.
|
||||
|
||||
## Output Format
|
||||
|
||||
## Spec Review
|
||||
|
||||
**Status:** Approved | Issues Found
|
||||
|
||||
**Issues (if any):**
|
||||
- [Section X]: [specific issue] - [why it matters for planning]
|
||||
|
||||
**Recommendations (advisory, do not block approval):**
|
||||
- [suggestions for improvement]
|
||||
```
|
||||
|
||||
**Reviewer returns:** Status, Issues (if any), Recommendations
|
||||
287
.claude/skills/brainstorming/visual-companion.md
Normal file
287
.claude/skills/brainstorming/visual-companion.md
Normal file
@@ -0,0 +1,287 @@
|
||||
# Visual Companion Guide
|
||||
|
||||
Browser-based visual brainstorming companion for showing mockups, diagrams, and options.
|
||||
|
||||
## When to Use
|
||||
|
||||
Decide per-question, not per-session. The test: **would the user understand this better by seeing it than reading it?**
|
||||
|
||||
**Use the browser** when the content itself is visual:
|
||||
|
||||
- **UI mockups** — wireframes, layouts, navigation structures, component designs
|
||||
- **Architecture diagrams** — system components, data flow, relationship maps
|
||||
- **Side-by-side visual comparisons** — comparing two layouts, two color schemes, two design directions
|
||||
- **Design polish** — when the question is about look and feel, spacing, visual hierarchy
|
||||
- **Spatial relationships** — state machines, flowcharts, entity relationships rendered as diagrams
|
||||
|
||||
**Use the terminal** when the content is text or tabular:
|
||||
|
||||
- **Requirements and scope questions** — "what does X mean?", "which features are in scope?"
|
||||
- **Conceptual A/B/C choices** — picking between approaches described in words
|
||||
- **Tradeoff lists** — pros/cons, comparison tables
|
||||
- **Technical decisions** — API design, data modeling, architectural approach selection
|
||||
- **Clarifying questions** — anything where the answer is words, not a visual preference
|
||||
|
||||
A question *about* a UI topic is not automatically a visual question. "What kind of wizard do you want?" is conceptual — use the terminal. "Which of these wizard layouts feels right?" is visual — use the browser.
|
||||
|
||||
## How It Works
|
||||
|
||||
The server watches a directory for HTML files and serves the newest one to the browser. You write HTML content to `screen_dir`, the user sees it in their browser and can click to select options. Selections are recorded to `state_dir/events` that you read on your next turn.
|
||||
|
||||
**Content fragments vs full documents:** If your HTML file starts with `<!DOCTYPE` or `<html`, the server serves it as-is (just injects the helper script). Otherwise, the server automatically wraps your content in the frame template — adding the header, CSS theme, selection indicator, and all interactive infrastructure. **Write content fragments by default.** Only write full documents when you need complete control over the page.
|
||||
|
||||
## Starting a Session
|
||||
|
||||
```bash
|
||||
# Start server with persistence (mockups saved to project)
|
||||
scripts/start-server.sh --project-dir /path/to/project
|
||||
|
||||
# Returns: {"type":"server-started","port":52341,"url":"http://localhost:52341",
|
||||
# "screen_dir":"/path/to/project/.superpowers/brainstorm/12345-1706000000/content",
|
||||
# "state_dir":"/path/to/project/.superpowers/brainstorm/12345-1706000000/state"}
|
||||
```
|
||||
|
||||
Save `screen_dir` and `state_dir` from the response. Tell user to open the URL.
|
||||
|
||||
**Finding connection info:** The server writes its startup JSON to `$STATE_DIR/server-info`. If you launched the server in the background and didn't capture stdout, read that file to get the URL and port. When using `--project-dir`, check `<project>/.superpowers/brainstorm/` for the session directory.
|
||||
|
||||
**Note:** Pass the project root as `--project-dir` so mockups persist in `.superpowers/brainstorm/` and survive server restarts. Without it, files go to `/tmp` and get cleaned up. Remind the user to add `.superpowers/` to `.gitignore` if it's not already there.
|
||||
|
||||
**Launching the server by platform:**
|
||||
|
||||
**Claude Code (macOS / Linux):**
|
||||
```bash
|
||||
# Default mode works — the script backgrounds the server itself
|
||||
scripts/start-server.sh --project-dir /path/to/project
|
||||
```
|
||||
|
||||
**Claude Code (Windows):**
|
||||
```bash
|
||||
# Windows auto-detects and uses foreground mode, which blocks the tool call.
|
||||
# Use run_in_background: true on the Bash tool call so the server survives
|
||||
# across conversation turns.
|
||||
scripts/start-server.sh --project-dir /path/to/project
|
||||
```
|
||||
When calling this via the Bash tool, set `run_in_background: true`. Then read `$STATE_DIR/server-info` on the next turn to get the URL and port.
|
||||
|
||||
**Codex:**
|
||||
```bash
|
||||
# Codex reaps background processes. The script auto-detects CODEX_CI and
|
||||
# switches to foreground mode. Run it normally — no extra flags needed.
|
||||
scripts/start-server.sh --project-dir /path/to/project
|
||||
```
|
||||
|
||||
**Gemini CLI:**
|
||||
```bash
|
||||
# Use --foreground and set is_background: true on your shell tool call
|
||||
# so the process survives across turns
|
||||
scripts/start-server.sh --project-dir /path/to/project --foreground
|
||||
```
|
||||
|
||||
**Other environments:** The server must keep running in the background across conversation turns. If your environment reaps detached processes, use `--foreground` and launch the command with your platform's background execution mechanism.
|
||||
|
||||
If the URL is unreachable from your browser (common in remote/containerized setups), bind a non-loopback host:
|
||||
|
||||
```bash
|
||||
scripts/start-server.sh \
|
||||
--project-dir /path/to/project \
|
||||
--host 0.0.0.0 \
|
||||
--url-host localhost
|
||||
```
|
||||
|
||||
Use `--url-host` to control what hostname is printed in the returned URL JSON.
|
||||
|
||||
## The Loop
|
||||
|
||||
1. **Check server is alive**, then **write HTML** to a new file in `screen_dir`:
|
||||
- Before each write, check that `$STATE_DIR/server-info` exists. If it doesn't (or `$STATE_DIR/server-stopped` exists), the server has shut down — restart it with `start-server.sh` before continuing. The server auto-exits after 30 minutes of inactivity.
|
||||
- Use semantic filenames: `platform.html`, `visual-style.html`, `layout.html`
|
||||
- **Never reuse filenames** — each screen gets a fresh file
|
||||
- Use Write tool — **never use cat/heredoc** (dumps noise into terminal)
|
||||
- Server automatically serves the newest file
|
||||
|
||||
2. **Tell user what to expect and end your turn:**
|
||||
- Remind them of the URL (every step, not just first)
|
||||
- Give a brief text summary of what's on screen (e.g., "Showing 3 layout options for the homepage")
|
||||
- Ask them to respond in the terminal: "Take a look and let me know what you think. Click to select an option if you'd like."
|
||||
|
||||
3. **On your next turn** — after the user responds in the terminal:
|
||||
- Read `$STATE_DIR/events` if it exists — this contains the user's browser interactions (clicks, selections) as JSON lines
|
||||
- Merge with the user's terminal text to get the full picture
|
||||
- The terminal message is the primary feedback; `state_dir/events` provides structured interaction data
|
||||
|
||||
4. **Iterate or advance** — if feedback changes current screen, write a new file (e.g., `layout-v2.html`). Only move to the next question when the current step is validated.
|
||||
|
||||
5. **Unload when returning to terminal** — when the next step doesn't need the browser (e.g., a clarifying question, a tradeoff discussion), push a waiting screen to clear the stale content:
|
||||
|
||||
```html
|
||||
<!-- filename: waiting.html (or waiting-2.html, etc.) -->
|
||||
<div style="display:flex;align-items:center;justify-content:center;min-height:60vh">
|
||||
<p class="subtitle">Continuing in terminal...</p>
|
||||
</div>
|
||||
```
|
||||
|
||||
This prevents the user from staring at a resolved choice while the conversation has moved on. When the next visual question comes up, push a new content file as usual.
|
||||
|
||||
6. Repeat until done.
|
||||
|
||||
## Writing Content Fragments
|
||||
|
||||
Write just the content that goes inside the page. The server wraps it in the frame template automatically (header, theme CSS, selection indicator, and all interactive infrastructure).
|
||||
|
||||
**Minimal example:**
|
||||
|
||||
```html
|
||||
<h2>Which layout works better?</h2>
|
||||
<p class="subtitle">Consider readability and visual hierarchy</p>
|
||||
|
||||
<div class="options">
|
||||
<div class="option" data-choice="a" onclick="toggleSelect(this)">
|
||||
<div class="letter">A</div>
|
||||
<div class="content">
|
||||
<h3>Single Column</h3>
|
||||
<p>Clean, focused reading experience</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="option" data-choice="b" onclick="toggleSelect(this)">
|
||||
<div class="letter">B</div>
|
||||
<div class="content">
|
||||
<h3>Two Column</h3>
|
||||
<p>Sidebar navigation with main content</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
That's it. No `<html>`, no CSS, no `<script>` tags needed. The server provides all of that.
|
||||
|
||||
## CSS Classes Available
|
||||
|
||||
The frame template provides these CSS classes for your content:
|
||||
|
||||
### Options (A/B/C choices)
|
||||
|
||||
```html
|
||||
<div class="options">
|
||||
<div class="option" data-choice="a" onclick="toggleSelect(this)">
|
||||
<div class="letter">A</div>
|
||||
<div class="content">
|
||||
<h3>Title</h3>
|
||||
<p>Description</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
**Multi-select:** Add `data-multiselect` to the container to let users select multiple options. Each click toggles the item. The indicator bar shows the count.
|
||||
|
||||
```html
|
||||
<div class="options" data-multiselect>
|
||||
<!-- same option markup — users can select/deselect multiple -->
|
||||
</div>
|
||||
```
|
||||
|
||||
### Cards (visual designs)
|
||||
|
||||
```html
|
||||
<div class="cards">
|
||||
<div class="card" data-choice="design1" onclick="toggleSelect(this)">
|
||||
<div class="card-image"><!-- mockup content --></div>
|
||||
<div class="card-body">
|
||||
<h3>Name</h3>
|
||||
<p>Description</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
### Mockup container
|
||||
|
||||
```html
|
||||
<div class="mockup">
|
||||
<div class="mockup-header">Preview: Dashboard Layout</div>
|
||||
<div class="mockup-body"><!-- your mockup HTML --></div>
|
||||
</div>
|
||||
```
|
||||
|
||||
### Split view (side-by-side)
|
||||
|
||||
```html
|
||||
<div class="split">
|
||||
<div class="mockup"><!-- left --></div>
|
||||
<div class="mockup"><!-- right --></div>
|
||||
</div>
|
||||
```
|
||||
|
||||
### Pros/Cons
|
||||
|
||||
```html
|
||||
<div class="pros-cons">
|
||||
<div class="pros"><h4>Pros</h4><ul><li>Benefit</li></ul></div>
|
||||
<div class="cons"><h4>Cons</h4><ul><li>Drawback</li></ul></div>
|
||||
</div>
|
||||
```
|
||||
|
||||
### Mock elements (wireframe building blocks)
|
||||
|
||||
```html
|
||||
<div class="mock-nav">Logo | Home | About | Contact</div>
|
||||
<div style="display: flex;">
|
||||
<div class="mock-sidebar">Navigation</div>
|
||||
<div class="mock-content">Main content area</div>
|
||||
</div>
|
||||
<button class="mock-button">Action Button</button>
|
||||
<input class="mock-input" placeholder="Input field">
|
||||
<div class="placeholder">Placeholder area</div>
|
||||
```
|
||||
|
||||
### Typography and sections
|
||||
|
||||
- `h2` — page title
|
||||
- `h3` — section heading
|
||||
- `.subtitle` — secondary text below title
|
||||
- `.section` — content block with bottom margin
|
||||
- `.label` — small uppercase label text
|
||||
|
||||
## Browser Events Format
|
||||
|
||||
When the user clicks options in the browser, their interactions are recorded to `$STATE_DIR/events` (one JSON object per line). The file is cleared automatically when you push a new screen.
|
||||
|
||||
```jsonl
|
||||
{"type":"click","choice":"a","text":"Option A - Simple Layout","timestamp":1706000101}
|
||||
{"type":"click","choice":"c","text":"Option C - Complex Grid","timestamp":1706000108}
|
||||
{"type":"click","choice":"b","text":"Option B - Hybrid","timestamp":1706000115}
|
||||
```
|
||||
|
||||
The full event stream shows the user's exploration path — they may click multiple options before settling. The last `choice` event is typically the final selection, but the pattern of clicks can reveal hesitation or preferences worth asking about.
|
||||
|
||||
If `$STATE_DIR/events` doesn't exist, the user didn't interact with the browser — use only their terminal text.
|
||||
|
||||
## Design Tips
|
||||
|
||||
- **Scale fidelity to the question** — wireframes for layout, polish for polish questions
|
||||
- **Explain the question on each page** — "Which layout feels more professional?" not just "Pick one"
|
||||
- **Iterate before advancing** — if feedback changes current screen, write a new version
|
||||
- **2-4 options max** per screen
|
||||
- **Use real content when it matters** — for a photography portfolio, use actual images (Unsplash). Placeholder content obscures design issues.
|
||||
- **Keep mockups simple** — focus on layout and structure, not pixel-perfect design
|
||||
|
||||
## File Naming
|
||||
|
||||
- Use semantic names: `platform.html`, `visual-style.html`, `layout.html`
|
||||
- Never reuse filenames — each screen must be a new file
|
||||
- For iterations: append version suffix like `layout-v2.html`, `layout-v3.html`
|
||||
- Server serves newest file by modification time
|
||||
|
||||
## Cleaning Up
|
||||
|
||||
```bash
|
||||
scripts/stop-server.sh $SESSION_DIR
|
||||
```
|
||||
|
||||
If the session used `--project-dir`, mockup files persist in `.superpowers/brainstorm/` for later reference. Only `/tmp` sessions get deleted on stop.
|
||||
|
||||
## Reference
|
||||
|
||||
- Frame template (CSS reference): `scripts/frame-template.html`
|
||||
- Helper script (client-side): `scripts/helper.js`
|
||||
182
.claude/skills/dispatching-parallel-agents/SKILL.md
Normal file
182
.claude/skills/dispatching-parallel-agents/SKILL.md
Normal file
@@ -0,0 +1,182 @@
|
||||
---
|
||||
name: sup-dispatching-parallel-agents
|
||||
description: Use when facing 2+ independent tasks that can be worked on without shared state or sequential dependencies
|
||||
---
|
||||
|
||||
# Dispatching Parallel Agents
|
||||
|
||||
## Overview
|
||||
|
||||
You delegate tasks to specialized agents with isolated context. By precisely crafting their instructions and context, you ensure they stay focused and succeed at their task. They should never inherit your session's context or history — you construct exactly what they need. This also preserves your own context for coordination work.
|
||||
|
||||
When you have multiple unrelated failures (different test files, different subsystems, different bugs), investigating them sequentially wastes time. Each investigation is independent and can happen in parallel.
|
||||
|
||||
**Core principle:** Dispatch one agent per independent problem domain. Let them work concurrently.
|
||||
|
||||
## When to Use
|
||||
|
||||
```dot
|
||||
digraph when_to_use {
|
||||
"Multiple failures?" [shape=diamond];
|
||||
"Are they independent?" [shape=diamond];
|
||||
"Single agent investigates all" [shape=box];
|
||||
"One agent per problem domain" [shape=box];
|
||||
"Can they work in parallel?" [shape=diamond];
|
||||
"Sequential agents" [shape=box];
|
||||
"Parallel dispatch" [shape=box];
|
||||
|
||||
"Multiple failures?" -> "Are they independent?" [label="yes"];
|
||||
"Are they independent?" -> "Single agent investigates all" [label="no - related"];
|
||||
"Are they independent?" -> "Can they work in parallel?" [label="yes"];
|
||||
"Can they work in parallel?" -> "Parallel dispatch" [label="yes"];
|
||||
"Can they work in parallel?" -> "Sequential agents" [label="no - shared state"];
|
||||
}
|
||||
```
|
||||
|
||||
**Use when:**
|
||||
- 3+ test files failing with different root causes
|
||||
- Multiple subsystems broken independently
|
||||
- Each problem can be understood without context from others
|
||||
- No shared state between investigations
|
||||
|
||||
**Don't use when:**
|
||||
- Failures are related (fix one might fix others)
|
||||
- Need to understand full system state
|
||||
- Agents would interfere with each other
|
||||
|
||||
## The Pattern
|
||||
|
||||
### 1. Identify Independent Domains
|
||||
|
||||
Group failures by what's broken:
|
||||
- File A tests: Tool approval flow
|
||||
- File B tests: Batch completion behavior
|
||||
- File C tests: Abort functionality
|
||||
|
||||
Each domain is independent - fixing tool approval doesn't affect abort tests.
|
||||
|
||||
### 2. Create Focused Agent Tasks
|
||||
|
||||
Each agent gets:
|
||||
- **Specific scope:** One test file or subsystem
|
||||
- **Clear goal:** Make these tests pass
|
||||
- **Constraints:** Don't change other code
|
||||
- **Expected output:** Summary of what you found and fixed
|
||||
|
||||
### 3. Dispatch in Parallel
|
||||
|
||||
```typescript
|
||||
// In Claude Code / AI environment
|
||||
Task("Fix agent-tool-abort.test.ts failures")
|
||||
Task("Fix batch-completion-behavior.test.ts failures")
|
||||
Task("Fix tool-approval-race-conditions.test.ts failures")
|
||||
// All three run concurrently
|
||||
```
|
||||
|
||||
### 4. Review and Integrate
|
||||
|
||||
When agents return:
|
||||
- Read each summary
|
||||
- Verify fixes don't conflict
|
||||
- Run full test suite
|
||||
- Integrate all changes
|
||||
|
||||
## Agent Prompt Structure
|
||||
|
||||
Good agent prompts are:
|
||||
1. **Focused** - One clear problem domain
|
||||
2. **Self-contained** - All context needed to understand the problem
|
||||
3. **Specific about output** - What should the agent return?
|
||||
|
||||
```markdown
|
||||
Fix the 3 failing tests in src/agents/agent-tool-abort.test.ts:
|
||||
|
||||
1. "should abort tool with partial output capture" - expects 'interrupted at' in message
|
||||
2. "should handle mixed completed and aborted tools" - fast tool aborted instead of completed
|
||||
3. "should properly track pendingToolCount" - expects 3 results but gets 0
|
||||
|
||||
These are timing/race condition issues. Your task:
|
||||
|
||||
1. Read the test file and understand what each test verifies
|
||||
2. Identify root cause - timing issues or actual bugs?
|
||||
3. Fix by:
|
||||
- Replacing arbitrary timeouts with event-based waiting
|
||||
- Fixing bugs in abort implementation if found
|
||||
- Adjusting test expectations if testing changed behavior
|
||||
|
||||
Do NOT just increase timeouts - find the real issue.
|
||||
|
||||
Return: Summary of what you found and what you fixed.
|
||||
```
|
||||
|
||||
## Common Mistakes
|
||||
|
||||
**❌ Too broad:** "Fix all the tests" - agent gets lost
|
||||
**✅ Specific:** "Fix agent-tool-abort.test.ts" - focused scope
|
||||
|
||||
**❌ No context:** "Fix the race condition" - agent doesn't know where
|
||||
**✅ Context:** Paste the error messages and test names
|
||||
|
||||
**❌ No constraints:** Agent might refactor everything
|
||||
**✅ Constraints:** "Do NOT change production code" or "Fix tests only"
|
||||
|
||||
**❌ Vague output:** "Fix it" - you don't know what changed
|
||||
**✅ Specific:** "Return summary of root cause and changes"
|
||||
|
||||
## When NOT to Use
|
||||
|
||||
**Related failures:** Fixing one might fix others - investigate together first
|
||||
**Need full context:** Understanding requires seeing entire system
|
||||
**Exploratory debugging:** You don't know what's broken yet
|
||||
**Shared state:** Agents would interfere (editing same files, using same resources)
|
||||
|
||||
## Real Example from Session
|
||||
|
||||
**Scenario:** 6 test failures across 3 files after major refactoring
|
||||
|
||||
**Failures:**
|
||||
- agent-tool-abort.test.ts: 3 failures (timing issues)
|
||||
- batch-completion-behavior.test.ts: 2 failures (tools not executing)
|
||||
- tool-approval-race-conditions.test.ts: 1 failure (execution count = 0)
|
||||
|
||||
**Decision:** Independent domains - abort logic separate from batch completion separate from race conditions
|
||||
|
||||
**Dispatch:**
|
||||
```
|
||||
Agent 1 → Fix agent-tool-abort.test.ts
|
||||
Agent 2 → Fix batch-completion-behavior.test.ts
|
||||
Agent 3 → Fix tool-approval-race-conditions.test.ts
|
||||
```
|
||||
|
||||
**Results:**
|
||||
- Agent 1: Replaced timeouts with event-based waiting
|
||||
- Agent 2: Fixed event structure bug (threadId in wrong place)
|
||||
- Agent 3: Added wait for async tool execution to complete
|
||||
|
||||
**Integration:** All fixes independent, no conflicts, full suite green
|
||||
|
||||
**Time saved:** 3 problems solved in parallel vs sequentially
|
||||
|
||||
## Key Benefits
|
||||
|
||||
1. **Parallelization** - Multiple investigations happen simultaneously
|
||||
2. **Focus** - Each agent has narrow scope, less context to track
|
||||
3. **Independence** - Agents don't interfere with each other
|
||||
4. **Speed** - 3 problems solved in time of 1
|
||||
|
||||
## Verification
|
||||
|
||||
After agents return:
|
||||
1. **Review each summary** - Understand what changed
|
||||
2. **Check for conflicts** - Did agents edit same code?
|
||||
3. **Run full suite** - Verify all fixes work together
|
||||
4. **Spot check** - Agents can make systematic errors
|
||||
|
||||
## Real-World Impact
|
||||
|
||||
From debugging session (2025-10-03):
|
||||
- 6 failures across 3 files
|
||||
- 3 agents dispatched in parallel
|
||||
- All investigations completed concurrently
|
||||
- All fixes integrated successfully
|
||||
- Zero conflicts between agent changes
|
||||
70
.claude/skills/executing-plans/SKILL.md
Normal file
70
.claude/skills/executing-plans/SKILL.md
Normal file
@@ -0,0 +1,70 @@
|
||||
---
|
||||
name: sup-executing-plans
|
||||
description: Use when you have a written implementation plan to execute in a separate session with review checkpoints
|
||||
---
|
||||
|
||||
# Executing Plans
|
||||
|
||||
## Overview
|
||||
|
||||
Load plan, review critically, execute all tasks, report when complete.
|
||||
|
||||
**Announce at start:** "I'm using the executing-plans skill to implement this plan."
|
||||
|
||||
**Note:** Tell your human partner that Superpowers works much better with access to subagents. The quality of its work will be significantly higher if run on a platform with subagent support (such as Claude Code or Codex). If subagents are available, use superpowers:subagent-driven-development instead of this skill.
|
||||
|
||||
## The Process
|
||||
|
||||
### Step 1: Load and Review Plan
|
||||
1. Read plan file
|
||||
2. Review critically - identify any questions or concerns about the plan
|
||||
3. If concerns: Raise them with your human partner before starting
|
||||
4. If no concerns: Create TodoWrite and proceed
|
||||
|
||||
### Step 2: Execute Tasks
|
||||
|
||||
For each task:
|
||||
1. Mark as in_progress
|
||||
2. Follow each step exactly (plan has bite-sized steps)
|
||||
3. Run verifications as specified
|
||||
4. Mark as completed
|
||||
|
||||
### Step 3: Complete Development
|
||||
|
||||
After all tasks complete and verified:
|
||||
- Announce: "I'm using the finishing-a-development-branch skill to complete this work."
|
||||
- **REQUIRED SUB-SKILL:** Use superpowers:finishing-a-development-branch
|
||||
- Follow that skill to verify tests, present options, execute choice
|
||||
|
||||
## When to Stop and Ask for Help
|
||||
|
||||
**STOP executing immediately when:**
|
||||
- Hit a blocker (missing dependency, test fails, instruction unclear)
|
||||
- Plan has critical gaps preventing starting
|
||||
- You don't understand an instruction
|
||||
- Verification fails repeatedly
|
||||
|
||||
**Ask for clarification rather than guessing.**
|
||||
|
||||
## When to Revisit Earlier Steps
|
||||
|
||||
**Return to Review (Step 1) when:**
|
||||
- Partner updates the plan based on your feedback
|
||||
- Fundamental approach needs rethinking
|
||||
|
||||
**Don't force through blockers** - stop and ask.
|
||||
|
||||
## Remember
|
||||
- Review plan critically first
|
||||
- Follow plan steps exactly
|
||||
- Don't skip verifications
|
||||
- Reference skills when plan says to
|
||||
- Stop when blocked, don't guess
|
||||
- Never start implementation on main/master branch without explicit user consent
|
||||
|
||||
## Integration
|
||||
|
||||
**Required workflow skills:**
|
||||
- **superpowers:using-git-worktrees** - REQUIRED: Set up isolated workspace before starting
|
||||
- **superpowers:writing-plans** - Creates the plan this skill executes
|
||||
- **superpowers:finishing-a-development-branch** - Complete development after all tasks
|
||||
200
.claude/skills/finishing-a-development-branch/SKILL.md
Normal file
200
.claude/skills/finishing-a-development-branch/SKILL.md
Normal file
@@ -0,0 +1,200 @@
|
||||
---
|
||||
name: sup-finishing-a-development-branch
|
||||
description: Use when implementation is complete, all tests pass, and you need to decide how to integrate the work - guides completion of development work by presenting structured options for merge, PR, or cleanup
|
||||
---
|
||||
|
||||
# Finishing a Development Branch
|
||||
|
||||
## Overview
|
||||
|
||||
Guide completion of development work by presenting clear options and handling chosen workflow.
|
||||
|
||||
**Core principle:** Verify tests → Present options → Execute choice → Clean up.
|
||||
|
||||
**Announce at start:** "I'm using the finishing-a-development-branch skill to complete this work."
|
||||
|
||||
## The Process
|
||||
|
||||
### Step 1: Verify Tests
|
||||
|
||||
**Before presenting options, verify tests pass:**
|
||||
|
||||
```bash
|
||||
# Run project's test suite
|
||||
npm test / cargo test / pytest / go test ./...
|
||||
```
|
||||
|
||||
**If tests fail:**
|
||||
```
|
||||
Tests failing (<N> failures). Must fix before completing:
|
||||
|
||||
[Show failures]
|
||||
|
||||
Cannot proceed with merge/PR until tests pass.
|
||||
```
|
||||
|
||||
Stop. Don't proceed to Step 2.
|
||||
|
||||
**If tests pass:** Continue to Step 2.
|
||||
|
||||
### Step 2: Determine Base Branch
|
||||
|
||||
```bash
|
||||
# Try common base branches
|
||||
git merge-base HEAD main 2>/dev/null || git merge-base HEAD master 2>/dev/null
|
||||
```
|
||||
|
||||
Or ask: "This branch split from main - is that correct?"
|
||||
|
||||
### Step 3: Present Options
|
||||
|
||||
Present exactly these 4 options:
|
||||
|
||||
```
|
||||
Implementation complete. What would you like to do?
|
||||
|
||||
1. Merge back to <base-branch> locally
|
||||
2. Push and create a Pull Request
|
||||
3. Keep the branch as-is (I'll handle it later)
|
||||
4. Discard this work
|
||||
|
||||
Which option?
|
||||
```
|
||||
|
||||
**Don't add explanation** - keep options concise.
|
||||
|
||||
### Step 4: Execute Choice
|
||||
|
||||
#### Option 1: Merge Locally
|
||||
|
||||
```bash
|
||||
# Switch to base branch
|
||||
git checkout <base-branch>
|
||||
|
||||
# Pull latest
|
||||
git pull
|
||||
|
||||
# Merge feature branch
|
||||
git merge <feature-branch>
|
||||
|
||||
# Verify tests on merged result
|
||||
<test command>
|
||||
|
||||
# If tests pass
|
||||
git branch -d <feature-branch>
|
||||
```
|
||||
|
||||
Then: Cleanup worktree (Step 5)
|
||||
|
||||
#### Option 2: Push and Create PR
|
||||
|
||||
```bash
|
||||
# Push branch
|
||||
git push -u origin <feature-branch>
|
||||
|
||||
# Create PR
|
||||
gh pr create --title "<title>" --body "$(cat <<'EOF'
|
||||
## Summary
|
||||
<2-3 bullets of what changed>
|
||||
|
||||
## Test Plan
|
||||
- [ ] <verification steps>
|
||||
EOF
|
||||
)"
|
||||
```
|
||||
|
||||
Then: Cleanup worktree (Step 5)
|
||||
|
||||
#### Option 3: Keep As-Is
|
||||
|
||||
Report: "Keeping branch <name>. Worktree preserved at <path>."
|
||||
|
||||
**Don't cleanup worktree.**
|
||||
|
||||
#### Option 4: Discard
|
||||
|
||||
**Confirm first:**
|
||||
```
|
||||
This will permanently delete:
|
||||
- Branch <name>
|
||||
- All commits: <commit-list>
|
||||
- Worktree at <path>
|
||||
|
||||
Type 'discard' to confirm.
|
||||
```
|
||||
|
||||
Wait for exact confirmation.
|
||||
|
||||
If confirmed:
|
||||
```bash
|
||||
git checkout <base-branch>
|
||||
git branch -D <feature-branch>
|
||||
```
|
||||
|
||||
Then: Cleanup worktree (Step 5)
|
||||
|
||||
### Step 5: Cleanup Worktree
|
||||
|
||||
**For Options 1, 2, 4:**
|
||||
|
||||
Check if in worktree:
|
||||
```bash
|
||||
git worktree list | grep $(git branch --show-current)
|
||||
```
|
||||
|
||||
If yes:
|
||||
```bash
|
||||
git worktree remove <worktree-path>
|
||||
```
|
||||
|
||||
**For Option 3:** Keep worktree.
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Option | Merge | Push | Keep Worktree | Cleanup Branch |
|
||||
|--------|-------|------|---------------|----------------|
|
||||
| 1. Merge locally | ✓ | - | - | ✓ |
|
||||
| 2. Create PR | - | ✓ | ✓ | - |
|
||||
| 3. Keep as-is | - | - | ✓ | - |
|
||||
| 4. Discard | - | - | - | ✓ (force) |
|
||||
|
||||
## Common Mistakes
|
||||
|
||||
**Skipping test verification**
|
||||
- **Problem:** Merge broken code, create failing PR
|
||||
- **Fix:** Always verify tests before offering options
|
||||
|
||||
**Open-ended questions**
|
||||
- **Problem:** "What should I do next?" → ambiguous
|
||||
- **Fix:** Present exactly 4 structured options
|
||||
|
||||
**Automatic worktree cleanup**
|
||||
- **Problem:** Remove worktree when might need it (Option 2, 3)
|
||||
- **Fix:** Only cleanup for Options 1 and 4
|
||||
|
||||
**No confirmation for discard**
|
||||
- **Problem:** Accidentally delete work
|
||||
- **Fix:** Require typed "discard" confirmation
|
||||
|
||||
## Red Flags
|
||||
|
||||
**Never:**
|
||||
- Proceed with failing tests
|
||||
- Merge without verifying tests on result
|
||||
- Delete work without confirmation
|
||||
- Force-push without explicit request
|
||||
|
||||
**Always:**
|
||||
- Verify tests before offering options
|
||||
- Present exactly 4 options
|
||||
- Get typed confirmation for Option 4
|
||||
- Clean up worktree for Options 1 & 4 only
|
||||
|
||||
## Integration
|
||||
|
||||
**Called by:**
|
||||
- **subagent-driven-development** (Step 7) - After all tasks complete
|
||||
- **executing-plans** (Step 5) - After all batches complete
|
||||
|
||||
**Pairs with:**
|
||||
- **using-git-worktrees** - Cleans up worktree created by that skill
|
||||
213
.claude/skills/receiving-code-review/SKILL.md
Normal file
213
.claude/skills/receiving-code-review/SKILL.md
Normal file
@@ -0,0 +1,213 @@
|
||||
---
|
||||
name: sup-receiving-code-review
|
||||
description: Use when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementation
|
||||
---
|
||||
|
||||
# Code Review Reception
|
||||
|
||||
## Overview
|
||||
|
||||
Code review requires technical evaluation, not emotional performance.
|
||||
|
||||
**Core principle:** Verify before implementing. Ask before assuming. Technical correctness over social comfort.
|
||||
|
||||
## The Response Pattern
|
||||
|
||||
```
|
||||
WHEN receiving code review feedback:
|
||||
|
||||
1. READ: Complete feedback without reacting
|
||||
2. UNDERSTAND: Restate requirement in own words (or ask)
|
||||
3. VERIFY: Check against codebase reality
|
||||
4. EVALUATE: Technically sound for THIS codebase?
|
||||
5. RESPOND: Technical acknowledgment or reasoned pushback
|
||||
6. IMPLEMENT: One item at a time, test each
|
||||
```
|
||||
|
||||
## Forbidden Responses
|
||||
|
||||
**NEVER:**
|
||||
- "You're absolutely right!" (explicit CLAUDE.md violation)
|
||||
- "Great point!" / "Excellent feedback!" (performative)
|
||||
- "Let me implement that now" (before verification)
|
||||
|
||||
**INSTEAD:**
|
||||
- Restate the technical requirement
|
||||
- Ask clarifying questions
|
||||
- Push back with technical reasoning if wrong
|
||||
- Just start working (actions > words)
|
||||
|
||||
## Handling Unclear Feedback
|
||||
|
||||
```
|
||||
IF any item is unclear:
|
||||
STOP - do not implement anything yet
|
||||
ASK for clarification on unclear items
|
||||
|
||||
WHY: Items may be related. Partial understanding = wrong implementation.
|
||||
```
|
||||
|
||||
**Example:**
|
||||
```
|
||||
your human partner: "Fix 1-6"
|
||||
You understand 1,2,3,6. Unclear on 4,5.
|
||||
|
||||
❌ WRONG: Implement 1,2,3,6 now, ask about 4,5 later
|
||||
✅ RIGHT: "I understand items 1,2,3,6. Need clarification on 4 and 5 before proceeding."
|
||||
```
|
||||
|
||||
## Source-Specific Handling
|
||||
|
||||
### From your human partner
|
||||
- **Trusted** - implement after understanding
|
||||
- **Still ask** if scope unclear
|
||||
- **No performative agreement**
|
||||
- **Skip to action** or technical acknowledgment
|
||||
|
||||
### From External Reviewers
|
||||
```
|
||||
BEFORE implementing:
|
||||
1. Check: Technically correct for THIS codebase?
|
||||
2. Check: Breaks existing functionality?
|
||||
3. Check: Reason for current implementation?
|
||||
4. Check: Works on all platforms/versions?
|
||||
5. Check: Does reviewer understand full context?
|
||||
|
||||
IF suggestion seems wrong:
|
||||
Push back with technical reasoning
|
||||
|
||||
IF can't easily verify:
|
||||
Say so: "I can't verify this without [X]. Should I [investigate/ask/proceed]?"
|
||||
|
||||
IF conflicts with your human partner's prior decisions:
|
||||
Stop and discuss with your human partner first
|
||||
```
|
||||
|
||||
**your human partner's rule:** "External feedback - be skeptical, but check carefully"
|
||||
|
||||
## YAGNI Check for "Professional" Features
|
||||
|
||||
```
|
||||
IF reviewer suggests "implementing properly":
|
||||
grep codebase for actual usage
|
||||
|
||||
IF unused: "This endpoint isn't called. Remove it (YAGNI)?"
|
||||
IF used: Then implement properly
|
||||
```
|
||||
|
||||
**your human partner's rule:** "You and reviewer both report to me. If we don't need this feature, don't add it."
|
||||
|
||||
## Implementation Order
|
||||
|
||||
```
|
||||
FOR multi-item feedback:
|
||||
1. Clarify anything unclear FIRST
|
||||
2. Then implement in this order:
|
||||
- Blocking issues (breaks, security)
|
||||
- Simple fixes (typos, imports)
|
||||
- Complex fixes (refactoring, logic)
|
||||
3. Test each fix individually
|
||||
4. Verify no regressions
|
||||
```
|
||||
|
||||
## When To Push Back
|
||||
|
||||
Push back when:
|
||||
- Suggestion breaks existing functionality
|
||||
- Reviewer lacks full context
|
||||
- Violates YAGNI (unused feature)
|
||||
- Technically incorrect for this stack
|
||||
- Legacy/compatibility reasons exist
|
||||
- Conflicts with your human partner's architectural decisions
|
||||
|
||||
**How to push back:**
|
||||
- Use technical reasoning, not defensiveness
|
||||
- Ask specific questions
|
||||
- Reference working tests/code
|
||||
- Involve your human partner if architectural
|
||||
|
||||
**Signal if uncomfortable pushing back out loud:** "Strange things are afoot at the Circle K"
|
||||
|
||||
## Acknowledging Correct Feedback
|
||||
|
||||
When feedback IS correct:
|
||||
```
|
||||
✅ "Fixed. [Brief description of what changed]"
|
||||
✅ "Good catch - [specific issue]. Fixed in [location]."
|
||||
✅ [Just fix it and show in the code]
|
||||
|
||||
❌ "You're absolutely right!"
|
||||
❌ "Great point!"
|
||||
❌ "Thanks for catching that!"
|
||||
❌ "Thanks for [anything]"
|
||||
❌ ANY gratitude expression
|
||||
```
|
||||
|
||||
**Why no thanks:** Actions speak. Just fix it. The code itself shows you heard the feedback.
|
||||
|
||||
**If you catch yourself about to write "Thanks":** DELETE IT. State the fix instead.
|
||||
|
||||
## Gracefully Correcting Your Pushback
|
||||
|
||||
If you pushed back and were wrong:
|
||||
```
|
||||
✅ "You were right - I checked [X] and it does [Y]. Implementing now."
|
||||
✅ "Verified this and you're correct. My initial understanding was wrong because [reason]. Fixing."
|
||||
|
||||
❌ Long apology
|
||||
❌ Defending why you pushed back
|
||||
❌ Over-explaining
|
||||
```
|
||||
|
||||
State the correction factually and move on.
|
||||
|
||||
## Common Mistakes
|
||||
|
||||
| Mistake | Fix |
|
||||
|---------|-----|
|
||||
| Performative agreement | State requirement or just act |
|
||||
| Blind implementation | Verify against codebase first |
|
||||
| Batch without testing | One at a time, test each |
|
||||
| Assuming reviewer is right | Check if breaks things |
|
||||
| Avoiding pushback | Technical correctness > comfort |
|
||||
| Partial implementation | Clarify all items first |
|
||||
| Can't verify, proceed anyway | State limitation, ask for direction |
|
||||
|
||||
## Real Examples
|
||||
|
||||
**Performative Agreement (Bad):**
|
||||
```
|
||||
Reviewer: "Remove legacy code"
|
||||
❌ "You're absolutely right! Let me remove that..."
|
||||
```
|
||||
|
||||
**Technical Verification (Good):**
|
||||
```
|
||||
Reviewer: "Remove legacy code"
|
||||
✅ "Checking... build target is 10.15+, this API needs 13+. Need legacy for backward compat. Current impl has wrong bundle ID - fix it or drop pre-13 support?"
|
||||
```
|
||||
|
||||
**YAGNI (Good):**
|
||||
```
|
||||
Reviewer: "Implement proper metrics tracking with database, date filters, CSV export"
|
||||
✅ "Grepped codebase - nothing calls this endpoint. Remove it (YAGNI)? Or is there usage I'm missing?"
|
||||
```
|
||||
|
||||
**Unclear Item (Good):**
|
||||
```
|
||||
your human partner: "Fix items 1-6"
|
||||
You understand 1,2,3,6. Unclear on 4,5.
|
||||
✅ "Understand 1,2,3,6. Need clarification on 4 and 5 before implementing."
|
||||
```
|
||||
|
||||
## GitHub Thread Replies
|
||||
|
||||
When replying to inline review comments on GitHub, reply in the comment thread (`gh api repos/{owner}/{repo}/pulls/{pr}/comments/{id}/replies`), not as a top-level PR comment.
|
||||
|
||||
## The Bottom Line
|
||||
|
||||
**External feedback = suggestions to evaluate, not orders to follow.**
|
||||
|
||||
Verify. Question. Then implement.
|
||||
|
||||
No performative agreement. Technical rigor always.
|
||||
105
.claude/skills/requesting-code-review/SKILL.md
Normal file
105
.claude/skills/requesting-code-review/SKILL.md
Normal file
@@ -0,0 +1,105 @@
|
||||
---
|
||||
name: sup-requesting-code-review
|
||||
description: Use when completing tasks, implementing major features, or before merging to verify work meets requirements
|
||||
---
|
||||
|
||||
# Requesting Code Review
|
||||
|
||||
Dispatch superpowers:code-reviewer subagent to catch issues before they cascade. The reviewer gets precisely crafted context for evaluation — never your session's history. This keeps the reviewer focused on the work product, not your thought process, and preserves your own context for continued work.
|
||||
|
||||
**Core principle:** Review early, review often.
|
||||
|
||||
## When to Request Review
|
||||
|
||||
**Mandatory:**
|
||||
- After each task in subagent-driven development
|
||||
- After completing major feature
|
||||
- Before merge to main
|
||||
|
||||
**Optional but valuable:**
|
||||
- When stuck (fresh perspective)
|
||||
- Before refactoring (baseline check)
|
||||
- After fixing complex bug
|
||||
|
||||
## How to Request
|
||||
|
||||
**1. Get git SHAs:**
|
||||
```bash
|
||||
BASE_SHA=$(git rev-parse HEAD~1) # or origin/main
|
||||
HEAD_SHA=$(git rev-parse HEAD)
|
||||
```
|
||||
|
||||
**2. Dispatch code-reviewer subagent:**
|
||||
|
||||
Use Task tool with superpowers:code-reviewer type, fill template at `code-reviewer.md`
|
||||
|
||||
**Placeholders:**
|
||||
- `{WHAT_WAS_IMPLEMENTED}` - What you just built
|
||||
- `{PLAN_OR_REQUIREMENTS}` - What it should do
|
||||
- `{BASE_SHA}` - Starting commit
|
||||
- `{HEAD_SHA}` - Ending commit
|
||||
- `{DESCRIPTION}` - Brief summary
|
||||
|
||||
**3. Act on feedback:**
|
||||
- Fix Critical issues immediately
|
||||
- Fix Important issues before proceeding
|
||||
- Note Minor issues for later
|
||||
- Push back if reviewer is wrong (with reasoning)
|
||||
|
||||
## Example
|
||||
|
||||
```
|
||||
[Just completed Task 2: Add verification function]
|
||||
|
||||
You: Let me request code review before proceeding.
|
||||
|
||||
BASE_SHA=$(git log --oneline | grep "Task 1" | head -1 | awk '{print $1}')
|
||||
HEAD_SHA=$(git rev-parse HEAD)
|
||||
|
||||
[Dispatch superpowers:code-reviewer subagent]
|
||||
WHAT_WAS_IMPLEMENTED: Verification and repair functions for conversation index
|
||||
PLAN_OR_REQUIREMENTS: Task 2 from .llm/plans/deployment-plan.md
|
||||
BASE_SHA: a7981ec
|
||||
HEAD_SHA: 3df7661
|
||||
DESCRIPTION: Added verifyIndex() and repairIndex() with 4 issue types
|
||||
|
||||
[Subagent returns]:
|
||||
Strengths: Clean architecture, real tests
|
||||
Issues:
|
||||
Important: Missing progress indicators
|
||||
Minor: Magic number (100) for reporting interval
|
||||
Assessment: Ready to proceed
|
||||
|
||||
You: [Fix progress indicators]
|
||||
[Continue to Task 3]
|
||||
```
|
||||
|
||||
## Integration with Workflows
|
||||
|
||||
**Subagent-Driven Development:**
|
||||
- Review after EACH task
|
||||
- Catch issues before they compound
|
||||
- Fix before moving to next task
|
||||
|
||||
**Executing Plans:**
|
||||
- Review after each batch (3 tasks)
|
||||
- Get feedback, apply, continue
|
||||
|
||||
**Ad-Hoc Development:**
|
||||
- Review before merge
|
||||
- Review when stuck
|
||||
|
||||
## Red Flags
|
||||
|
||||
**Never:**
|
||||
- Skip review because "it's simple"
|
||||
- Ignore Critical issues
|
||||
- Proceed with unfixed Important issues
|
||||
- Argue with valid technical feedback
|
||||
|
||||
**If reviewer wrong:**
|
||||
- Push back with technical reasoning
|
||||
- Show code/tests that prove it works
|
||||
- Request clarification
|
||||
|
||||
See template at: requesting-code-review/code-reviewer.md
|
||||
146
.claude/skills/requesting-code-review/code-reviewer.md
Normal file
146
.claude/skills/requesting-code-review/code-reviewer.md
Normal file
@@ -0,0 +1,146 @@
|
||||
# Code Review Agent
|
||||
|
||||
You are reviewing code changes for production readiness.
|
||||
|
||||
**Your task:**
|
||||
1. Review {WHAT_WAS_IMPLEMENTED}
|
||||
2. Compare against {PLAN_OR_REQUIREMENTS}
|
||||
3. Check code quality, architecture, testing
|
||||
4. Categorize issues by severity
|
||||
5. Assess production readiness
|
||||
|
||||
## What Was Implemented
|
||||
|
||||
{DESCRIPTION}
|
||||
|
||||
## Requirements/Plan
|
||||
|
||||
{PLAN_REFERENCE}
|
||||
|
||||
## Git Range to Review
|
||||
|
||||
**Base:** {BASE_SHA}
|
||||
**Head:** {HEAD_SHA}
|
||||
|
||||
```bash
|
||||
git diff --stat {BASE_SHA}..{HEAD_SHA}
|
||||
git diff {BASE_SHA}..{HEAD_SHA}
|
||||
```
|
||||
|
||||
## Review Checklist
|
||||
|
||||
**Code Quality:**
|
||||
- Clean separation of concerns?
|
||||
- Proper error handling?
|
||||
- Type safety (if applicable)?
|
||||
- DRY principle followed?
|
||||
- Edge cases handled?
|
||||
|
||||
**Architecture:**
|
||||
- Sound design decisions?
|
||||
- Scalability considerations?
|
||||
- Performance implications?
|
||||
- Security concerns?
|
||||
|
||||
**Testing:**
|
||||
- Tests actually test logic (not mocks)?
|
||||
- Edge cases covered?
|
||||
- Integration tests where needed?
|
||||
- All tests passing?
|
||||
|
||||
**Requirements:**
|
||||
- All plan requirements met?
|
||||
- Implementation matches spec?
|
||||
- No scope creep?
|
||||
- Breaking changes documented?
|
||||
|
||||
**Production Readiness:**
|
||||
- Migration strategy (if schema changes)?
|
||||
- Backward compatibility considered?
|
||||
- Documentation complete?
|
||||
- No obvious bugs?
|
||||
|
||||
## Output Format
|
||||
|
||||
### Strengths
|
||||
[What's well done? Be specific.]
|
||||
|
||||
### Issues
|
||||
|
||||
#### Critical (Must Fix)
|
||||
[Bugs, security issues, data loss risks, broken functionality]
|
||||
|
||||
#### Important (Should Fix)
|
||||
[Architecture problems, missing features, poor error handling, test gaps]
|
||||
|
||||
#### Minor (Nice to Have)
|
||||
[Code style, optimization opportunities, documentation improvements]
|
||||
|
||||
**For each issue:**
|
||||
- File:line reference
|
||||
- What's wrong
|
||||
- Why it matters
|
||||
- How to fix (if not obvious)
|
||||
|
||||
### Recommendations
|
||||
[Improvements for code quality, architecture, or process]
|
||||
|
||||
### Assessment
|
||||
|
||||
**Ready to merge?** [Yes/No/With fixes]
|
||||
|
||||
**Reasoning:** [Technical assessment in 1-2 sentences]
|
||||
|
||||
## Critical Rules
|
||||
|
||||
**DO:**
|
||||
- Categorize by actual severity (not everything is Critical)
|
||||
- Be specific (file:line, not vague)
|
||||
- Explain WHY issues matter
|
||||
- Acknowledge strengths
|
||||
- Give clear verdict
|
||||
|
||||
**DON'T:**
|
||||
- Say "looks good" without checking
|
||||
- Mark nitpicks as Critical
|
||||
- Give feedback on code you didn't review
|
||||
- Be vague ("improve error handling")
|
||||
- Avoid giving a clear verdict
|
||||
|
||||
## Example Output
|
||||
|
||||
```
|
||||
### Strengths
|
||||
- Clean database schema with proper migrations (db.ts:15-42)
|
||||
- Comprehensive test coverage (18 tests, all edge cases)
|
||||
- Good error handling with fallbacks (summarizer.ts:85-92)
|
||||
|
||||
### Issues
|
||||
|
||||
#### Important
|
||||
1. **Missing help text in CLI wrapper**
|
||||
- File: index-conversations:1-31
|
||||
- Issue: No --help flag, users won't discover --concurrency
|
||||
- Fix: Add --help case with usage examples
|
||||
|
||||
2. **Date validation missing**
|
||||
- File: search.ts:25-27
|
||||
- Issue: Invalid dates silently return no results
|
||||
- Fix: Validate ISO format, throw error with example
|
||||
|
||||
#### Minor
|
||||
1. **Progress indicators**
|
||||
- File: indexer.ts:130
|
||||
- Issue: No "X of Y" counter for long operations
|
||||
- Impact: Users don't know how long to wait
|
||||
|
||||
### Recommendations
|
||||
- Add progress reporting for user experience
|
||||
- Consider config file for excluded projects (portability)
|
||||
|
||||
### Assessment
|
||||
|
||||
**Ready to merge: With fixes**
|
||||
|
||||
**Reasoning:** Core implementation is solid with good architecture and tests. Important issues (help text, date validation) are easily fixed and don't affect core functionality.
|
||||
```
|
||||
279
.claude/skills/subagent-driven-development/SKILL.md
Normal file
279
.claude/skills/subagent-driven-development/SKILL.md
Normal file
@@ -0,0 +1,279 @@
|
||||
---
|
||||
name: sup-subagent-driven-development
|
||||
description: Use when executing implementation plans with independent tasks in the current session
|
||||
---
|
||||
|
||||
# Subagent-Driven Development
|
||||
|
||||
Execute plan by dispatching fresh subagent per task, with two-stage review after each: spec compliance review first, then code quality review.
|
||||
|
||||
**Why subagents:** You delegate tasks to specialized agents with isolated context. By precisely crafting their instructions and context, you ensure they stay focused and succeed at their task. They should never inherit your session's context or history — you construct exactly what they need. This also preserves your own context for coordination work.
|
||||
|
||||
**Core principle:** Fresh subagent per task + two-stage review (spec then quality) = high quality, fast iteration
|
||||
|
||||
## When to Use
|
||||
|
||||
```dot
|
||||
digraph when_to_use {
|
||||
"Have implementation plan?" [shape=diamond];
|
||||
"Tasks mostly independent?" [shape=diamond];
|
||||
"Stay in this session?" [shape=diamond];
|
||||
"subagent-driven-development" [shape=box];
|
||||
"executing-plans" [shape=box];
|
||||
"Manual execution or brainstorm first" [shape=box];
|
||||
|
||||
"Have implementation plan?" -> "Tasks mostly independent?" [label="yes"];
|
||||
"Have implementation plan?" -> "Manual execution or brainstorm first" [label="no"];
|
||||
"Tasks mostly independent?" -> "Stay in this session?" [label="yes"];
|
||||
"Tasks mostly independent?" -> "Manual execution or brainstorm first" [label="no - tightly coupled"];
|
||||
"Stay in this session?" -> "subagent-driven-development" [label="yes"];
|
||||
"Stay in this session?" -> "executing-plans" [label="no - parallel session"];
|
||||
}
|
||||
```
|
||||
|
||||
**vs. Executing Plans (parallel session):**
|
||||
- Same session (no context switch)
|
||||
- Fresh subagent per task (no context pollution)
|
||||
- Two-stage review after each task: spec compliance first, then code quality
|
||||
- Faster iteration (no human-in-loop between tasks)
|
||||
|
||||
## The Process
|
||||
|
||||
```dot
|
||||
digraph process {
|
||||
rankdir=TB;
|
||||
|
||||
subgraph cluster_per_task {
|
||||
label="Per Task";
|
||||
"Dispatch implementer subagent (./implementer-prompt.md)" [shape=box];
|
||||
"Implementer subagent asks questions?" [shape=diamond];
|
||||
"Answer questions, provide context" [shape=box];
|
||||
"Implementer subagent implements, tests, commits, self-reviews" [shape=box];
|
||||
"Dispatch spec reviewer subagent (./spec-reviewer-prompt.md)" [shape=box];
|
||||
"Spec reviewer subagent confirms code matches spec?" [shape=diamond];
|
||||
"Implementer subagent fixes spec gaps" [shape=box];
|
||||
"Dispatch code quality reviewer subagent (./code-quality-reviewer-prompt.md)" [shape=box];
|
||||
"Code quality reviewer subagent approves?" [shape=diamond];
|
||||
"Implementer subagent fixes quality issues" [shape=box];
|
||||
"Mark task complete in TodoWrite" [shape=box];
|
||||
}
|
||||
|
||||
"Read plan, extract all tasks with full text, note context, create TodoWrite" [shape=box];
|
||||
"More tasks remain?" [shape=diamond];
|
||||
"Dispatch final code reviewer subagent for entire implementation" [shape=box];
|
||||
"Use superpowers:finishing-a-development-branch" [shape=box style=filled fillcolor=lightgreen];
|
||||
|
||||
"Read plan, extract all tasks with full text, note context, create TodoWrite" -> "Dispatch implementer subagent (./implementer-prompt.md)";
|
||||
"Dispatch implementer subagent (./implementer-prompt.md)" -> "Implementer subagent asks questions?";
|
||||
"Implementer subagent asks questions?" -> "Answer questions, provide context" [label="yes"];
|
||||
"Answer questions, provide context" -> "Dispatch implementer subagent (./implementer-prompt.md)";
|
||||
"Implementer subagent asks questions?" -> "Implementer subagent implements, tests, commits, self-reviews" [label="no"];
|
||||
"Implementer subagent implements, tests, commits, self-reviews" -> "Dispatch spec reviewer subagent (./spec-reviewer-prompt.md)";
|
||||
"Dispatch spec reviewer subagent (./spec-reviewer-prompt.md)" -> "Spec reviewer subagent confirms code matches spec?";
|
||||
"Spec reviewer subagent confirms code matches spec?" -> "Implementer subagent fixes spec gaps" [label="no"];
|
||||
"Implementer subagent fixes spec gaps" -> "Dispatch spec reviewer subagent (./spec-reviewer-prompt.md)" [label="re-review"];
|
||||
"Spec reviewer subagent confirms code matches spec?" -> "Dispatch code quality reviewer subagent (./code-quality-reviewer-prompt.md)" [label="yes"];
|
||||
"Dispatch code quality reviewer subagent (./code-quality-reviewer-prompt.md)" -> "Code quality reviewer subagent approves?";
|
||||
"Code quality reviewer subagent approves?" -> "Implementer subagent fixes quality issues" [label="no"];
|
||||
"Implementer subagent fixes quality issues" -> "Dispatch code quality reviewer subagent (./code-quality-reviewer-prompt.md)" [label="re-review"];
|
||||
"Code quality reviewer subagent approves?" -> "Mark task complete in TodoWrite" [label="yes"];
|
||||
"Mark task complete in TodoWrite" -> "More tasks remain?";
|
||||
"More tasks remain?" -> "Dispatch implementer subagent (./implementer-prompt.md)" [label="yes"];
|
||||
"More tasks remain?" -> "Dispatch final code reviewer subagent for entire implementation" [label="no"];
|
||||
"Dispatch final code reviewer subagent for entire implementation" -> "Use superpowers:finishing-a-development-branch";
|
||||
}
|
||||
```
|
||||
|
||||
## Model Selection
|
||||
|
||||
Use `model: "opus"` when spawning implementation subagents via the Agent tool. This ensures subagents have strong reasoning for autonomous code generation.
|
||||
|
||||
**Implementation subagents** (all implementation tasks): `model: "opus"`
|
||||
|
||||
**Review subagents** (spec compliance, code quality): `model: "opus"`
|
||||
|
||||
**Example:**
|
||||
```
|
||||
Agent({
|
||||
subagent_type: "general-purpose",
|
||||
model: "opus",
|
||||
prompt: "Implement task #1: ..."
|
||||
})
|
||||
```
|
||||
|
||||
## Handling Implementer Status
|
||||
|
||||
Implementer subagents report one of four statuses. Handle each appropriately:
|
||||
|
||||
**DONE:** Proceed to spec compliance review.
|
||||
|
||||
**DONE_WITH_CONCERNS:** The implementer completed the work but flagged doubts. Read the concerns before proceeding. If the concerns are about correctness or scope, address them before review. If they're observations (e.g., "this file is getting large"), note them and proceed to review.
|
||||
|
||||
**NEEDS_CONTEXT:** The implementer needs information that wasn't provided. Provide the missing context and re-dispatch.
|
||||
|
||||
**BLOCKED:** The implementer cannot complete the task. Assess the blocker:
|
||||
1. If it's a context problem, provide more context and re-dispatch with the same model
|
||||
2. If the task requires more reasoning, re-dispatch with a more capable model
|
||||
3. If the task is too large, break it into smaller pieces
|
||||
4. If the plan itself is wrong, escalate to the human
|
||||
|
||||
**Never** ignore an escalation or force the same model to retry without changes. If the implementer said it's stuck, something needs to change.
|
||||
|
||||
## Prompt Templates
|
||||
|
||||
- `./implementer-prompt.md` - Dispatch implementer subagent
|
||||
- `./spec-reviewer-prompt.md` - Dispatch spec compliance reviewer subagent
|
||||
- `./code-quality-reviewer-prompt.md` - Dispatch code quality reviewer subagent
|
||||
|
||||
## Example Workflow
|
||||
|
||||
```
|
||||
You: I'm using Subagent-Driven Development to execute this plan.
|
||||
|
||||
[Read plan file once: .llm/plans/feature-plan.md]
|
||||
[Extract all 5 tasks with full text and context]
|
||||
[Create TodoWrite with all tasks]
|
||||
|
||||
Task 1: Hook installation script
|
||||
|
||||
[Get Task 1 text and context (already extracted)]
|
||||
[Dispatch implementation subagent with full task text + context]
|
||||
|
||||
Implementer: "Before I begin - should the hook be installed at user or system level?"
|
||||
|
||||
You: "User level (~/.config/superpowers/hooks/)"
|
||||
|
||||
Implementer: "Got it. Implementing now..."
|
||||
[Later] Implementer:
|
||||
- Implemented install-hook command
|
||||
- Added tests, 5/5 passing
|
||||
- Self-review: Found I missed --force flag, added it
|
||||
- Committed
|
||||
|
||||
[Dispatch spec compliance reviewer]
|
||||
Spec reviewer: ✅ Spec compliant - all requirements met, nothing extra
|
||||
|
||||
[Get git SHAs, dispatch code quality reviewer]
|
||||
Code reviewer: Strengths: Good test coverage, clean. Issues: None. Approved.
|
||||
|
||||
[Mark Task 1 complete]
|
||||
|
||||
Task 2: Recovery modes
|
||||
|
||||
[Get Task 2 text and context (already extracted)]
|
||||
[Dispatch implementation subagent with full task text + context]
|
||||
|
||||
Implementer: [No questions, proceeds]
|
||||
Implementer:
|
||||
- Added verify/repair modes
|
||||
- 8/8 tests passing
|
||||
- Self-review: All good
|
||||
- Committed
|
||||
|
||||
[Dispatch spec compliance reviewer]
|
||||
Spec reviewer: ❌ Issues:
|
||||
- Missing: Progress reporting (spec says "report every 100 items")
|
||||
- Extra: Added --json flag (not requested)
|
||||
|
||||
[Implementer fixes issues]
|
||||
Implementer: Removed --json flag, added progress reporting
|
||||
|
||||
[Spec reviewer reviews again]
|
||||
Spec reviewer: ✅ Spec compliant now
|
||||
|
||||
[Dispatch code quality reviewer]
|
||||
Code reviewer: Strengths: Solid. Issues (Important): Magic number (100)
|
||||
|
||||
[Implementer fixes]
|
||||
Implementer: Extracted PROGRESS_INTERVAL constant
|
||||
|
||||
[Code reviewer reviews again]
|
||||
Code reviewer: ✅ Approved
|
||||
|
||||
[Mark Task 2 complete]
|
||||
|
||||
...
|
||||
|
||||
[After all tasks]
|
||||
[Dispatch final code-reviewer]
|
||||
Final reviewer: All requirements met, ready to merge
|
||||
|
||||
Done!
|
||||
```
|
||||
|
||||
## Advantages
|
||||
|
||||
**vs. Manual execution:**
|
||||
- Subagents follow TDD naturally
|
||||
- Fresh context per task (no confusion)
|
||||
- Parallel-safe (subagents don't interfere)
|
||||
- Subagent can ask questions (before AND during work)
|
||||
|
||||
**vs. Executing Plans:**
|
||||
- Same session (no handoff)
|
||||
- Continuous progress (no waiting)
|
||||
- Review checkpoints automatic
|
||||
|
||||
**Efficiency gains:**
|
||||
- No file reading overhead (controller provides full text)
|
||||
- Controller curates exactly what context is needed
|
||||
- Subagent gets complete information upfront
|
||||
- Questions surfaced before work begins (not after)
|
||||
|
||||
**Quality gates:**
|
||||
- Self-review catches issues before handoff
|
||||
- Two-stage review: spec compliance, then code quality
|
||||
- Review loops ensure fixes actually work
|
||||
- Spec compliance prevents over/under-building
|
||||
- Code quality ensures implementation is well-built
|
||||
|
||||
**Cost:**
|
||||
- More subagent invocations (implementer + 2 reviewers per task)
|
||||
- Controller does more prep work (extracting all tasks upfront)
|
||||
- Review loops add iterations
|
||||
- But catches issues early (cheaper than debugging later)
|
||||
|
||||
## Red Flags
|
||||
|
||||
**Never:**
|
||||
- Start implementation on main/master branch without explicit user consent
|
||||
- Skip reviews (spec compliance OR code quality)
|
||||
- Proceed with unfixed issues
|
||||
- Dispatch multiple implementation subagents in parallel (conflicts)
|
||||
- Make subagent read plan file (provide full text instead)
|
||||
- Skip scene-setting context (subagent needs to understand where task fits)
|
||||
- Ignore subagent questions (answer before letting them proceed)
|
||||
- Accept "close enough" on spec compliance (spec reviewer found issues = not done)
|
||||
- Skip review loops (reviewer found issues = implementer fixes = review again)
|
||||
- Let implementer self-review replace actual review (both are needed)
|
||||
- **Start code quality review before spec compliance is ✅** (wrong order)
|
||||
- Move to next task while either review has open issues
|
||||
|
||||
**If subagent asks questions:**
|
||||
- Answer clearly and completely
|
||||
- Provide additional context if needed
|
||||
- Don't rush them into implementation
|
||||
|
||||
**If reviewer finds issues:**
|
||||
- Implementer (same subagent) fixes them
|
||||
- Reviewer reviews again
|
||||
- Repeat until approved
|
||||
- Don't skip the re-review
|
||||
|
||||
**If subagent fails task:**
|
||||
- Dispatch fix subagent with specific instructions
|
||||
- Don't try to fix manually (context pollution)
|
||||
|
||||
## Integration
|
||||
|
||||
**Required workflow skills:**
|
||||
- **superpowers:using-git-worktrees** - REQUIRED: Set up isolated workspace before starting
|
||||
- **superpowers:writing-plans** - Creates the plan this skill executes
|
||||
- **superpowers:requesting-code-review** - Code review template for reviewer subagents
|
||||
- **superpowers:finishing-a-development-branch** - Complete development after all tasks
|
||||
|
||||
**Subagents should use:**
|
||||
- **superpowers:test-driven-development** - Subagents follow TDD for each task
|
||||
|
||||
**Alternative workflow:**
|
||||
- **superpowers:executing-plans** - Use for parallel session instead of same-session execution
|
||||
@@ -0,0 +1,26 @@
|
||||
# Code Quality Reviewer Prompt Template
|
||||
|
||||
Use this template when dispatching a code quality reviewer subagent.
|
||||
|
||||
**Purpose:** Verify implementation is well-built (clean, tested, maintainable)
|
||||
|
||||
**Only dispatch after spec compliance review passes.**
|
||||
|
||||
```
|
||||
Task tool (superpowers:code-reviewer):
|
||||
Use template at requesting-code-review/code-reviewer.md
|
||||
|
||||
WHAT_WAS_IMPLEMENTED: [from implementer's report]
|
||||
PLAN_OR_REQUIREMENTS: Task N from [plan-file]
|
||||
BASE_SHA: [commit before task]
|
||||
HEAD_SHA: [current commit]
|
||||
DESCRIPTION: [task summary]
|
||||
```
|
||||
|
||||
**In addition to standard code quality concerns, the reviewer should check:**
|
||||
- Does each file have one clear responsibility with a well-defined interface?
|
||||
- Are units decomposed so they can be understood and tested independently?
|
||||
- Is the implementation following the file structure from the plan?
|
||||
- Did this implementation create new files that are already large, or significantly grow existing files? (Don't flag pre-existing file sizes — focus on what this change contributed.)
|
||||
|
||||
**Code reviewer returns:** Strengths, Issues (Critical/Important/Minor), Assessment
|
||||
113
.claude/skills/subagent-driven-development/implementer-prompt.md
Normal file
113
.claude/skills/subagent-driven-development/implementer-prompt.md
Normal file
@@ -0,0 +1,113 @@
|
||||
# Implementer Subagent Prompt Template
|
||||
|
||||
Use this template when dispatching an implementer subagent.
|
||||
|
||||
```
|
||||
Task tool (general-purpose):
|
||||
description: "Implement Task N: [task name]"
|
||||
prompt: |
|
||||
You are implementing Task N: [task name]
|
||||
|
||||
## Task Description
|
||||
|
||||
[FULL TEXT of task from plan - paste it here, don't make subagent read file]
|
||||
|
||||
## Context
|
||||
|
||||
[Scene-setting: where this fits, dependencies, architectural context]
|
||||
|
||||
## Before You Begin
|
||||
|
||||
If you have questions about:
|
||||
- The requirements or acceptance criteria
|
||||
- The approach or implementation strategy
|
||||
- Dependencies or assumptions
|
||||
- Anything unclear in the task description
|
||||
|
||||
**Ask them now.** Raise any concerns before starting work.
|
||||
|
||||
## Your Job
|
||||
|
||||
Once you're clear on requirements:
|
||||
1. Implement exactly what the task specifies
|
||||
2. Write tests (following TDD if task says to)
|
||||
3. Verify implementation works
|
||||
4. Commit your work
|
||||
5. Self-review (see below)
|
||||
6. Report back
|
||||
|
||||
Work from: [directory]
|
||||
|
||||
**While you work:** If you encounter something unexpected or unclear, **ask questions**.
|
||||
It's always OK to pause and clarify. Don't guess or make assumptions.
|
||||
|
||||
## Code Organization
|
||||
|
||||
You reason best about code you can hold in context at once, and your edits are more
|
||||
reliable when files are focused. Keep this in mind:
|
||||
- Follow the file structure defined in the plan
|
||||
- Each file should have one clear responsibility with a well-defined interface
|
||||
- If a file you're creating is growing beyond the plan's intent, stop and report
|
||||
it as DONE_WITH_CONCERNS — don't split files on your own without plan guidance
|
||||
- If an existing file you're modifying is already large or tangled, work carefully
|
||||
and note it as a concern in your report
|
||||
- In existing codebases, follow established patterns. Improve code you're touching
|
||||
the way a good developer would, but don't restructure things outside your task.
|
||||
|
||||
## When You're in Over Your Head
|
||||
|
||||
It is always OK to stop and say "this is too hard for me." Bad work is worse than
|
||||
no work. You will not be penalized for escalating.
|
||||
|
||||
**STOP and escalate when:**
|
||||
- The task requires architectural decisions with multiple valid approaches
|
||||
- You need to understand code beyond what was provided and can't find clarity
|
||||
- You feel uncertain about whether your approach is correct
|
||||
- The task involves restructuring existing code in ways the plan didn't anticipate
|
||||
- You've been reading file after file trying to understand the system without progress
|
||||
|
||||
**How to escalate:** Report back with status BLOCKED or NEEDS_CONTEXT. Describe
|
||||
specifically what you're stuck on, what you've tried, and what kind of help you need.
|
||||
The controller can provide more context, re-dispatch with a more capable model,
|
||||
or break the task into smaller pieces.
|
||||
|
||||
## Before Reporting Back: Self-Review
|
||||
|
||||
Review your work with fresh eyes. Ask yourself:
|
||||
|
||||
**Completeness:**
|
||||
- Did I fully implement everything in the spec?
|
||||
- Did I miss any requirements?
|
||||
- Are there edge cases I didn't handle?
|
||||
|
||||
**Quality:**
|
||||
- Is this my best work?
|
||||
- Are names clear and accurate (match what things do, not how they work)?
|
||||
- Is the code clean and maintainable?
|
||||
|
||||
**Discipline:**
|
||||
- Did I avoid overbuilding (YAGNI)?
|
||||
- Did I only build what was requested?
|
||||
- Did I follow existing patterns in the codebase?
|
||||
|
||||
**Testing:**
|
||||
- Do tests actually verify behavior (not just mock behavior)?
|
||||
- Did I follow TDD if required?
|
||||
- Are tests comprehensive?
|
||||
|
||||
If you find issues during self-review, fix them now before reporting.
|
||||
|
||||
## Report Format
|
||||
|
||||
When done, report:
|
||||
- **Status:** DONE | DONE_WITH_CONCERNS | BLOCKED | NEEDS_CONTEXT
|
||||
- What you implemented (or what you attempted, if blocked)
|
||||
- What you tested and test results
|
||||
- Files changed
|
||||
- Self-review findings (if any)
|
||||
- Any issues or concerns
|
||||
|
||||
Use DONE_WITH_CONCERNS if you completed the work but have doubts about correctness.
|
||||
Use BLOCKED if you cannot complete the task. Use NEEDS_CONTEXT if you need
|
||||
information that wasn't provided. Never silently produce work you're unsure about.
|
||||
```
|
||||
@@ -0,0 +1,61 @@
|
||||
# Spec Compliance Reviewer Prompt Template
|
||||
|
||||
Use this template when dispatching a spec compliance reviewer subagent.
|
||||
|
||||
**Purpose:** Verify implementer built what was requested (nothing more, nothing less)
|
||||
|
||||
```
|
||||
Task tool (general-purpose):
|
||||
description: "Review spec compliance for Task N"
|
||||
prompt: |
|
||||
You are reviewing whether an implementation matches its specification.
|
||||
|
||||
## What Was Requested
|
||||
|
||||
[FULL TEXT of task requirements]
|
||||
|
||||
## What Implementer Claims They Built
|
||||
|
||||
[From implementer's report]
|
||||
|
||||
## CRITICAL: Do Not Trust the Report
|
||||
|
||||
The implementer finished suspiciously quickly. Their report may be incomplete,
|
||||
inaccurate, or optimistic. You MUST verify everything independently.
|
||||
|
||||
**DO NOT:**
|
||||
- Take their word for what they implemented
|
||||
- Trust their claims about completeness
|
||||
- Accept their interpretation of requirements
|
||||
|
||||
**DO:**
|
||||
- Read the actual code they wrote
|
||||
- Compare actual implementation to requirements line by line
|
||||
- Check for missing pieces they claimed to implement
|
||||
- Look for extra features they didn't mention
|
||||
|
||||
## Your Job
|
||||
|
||||
Read the implementation code and verify:
|
||||
|
||||
**Missing requirements:**
|
||||
- Did they implement everything that was requested?
|
||||
- Are there requirements they skipped or missed?
|
||||
- Did they claim something works but didn't actually implement it?
|
||||
|
||||
**Extra/unneeded work:**
|
||||
- Did they build things that weren't requested?
|
||||
- Did they over-engineer or add unnecessary features?
|
||||
- Did they add "nice to haves" that weren't in spec?
|
||||
|
||||
**Misunderstandings:**
|
||||
- Did they interpret requirements differently than intended?
|
||||
- Did they solve the wrong problem?
|
||||
- Did they implement the right feature but wrong way?
|
||||
|
||||
**Verify by reading code, not by trusting report.**
|
||||
|
||||
Report:
|
||||
- ✅ Spec compliant (if everything matches after code inspection)
|
||||
- ❌ Issues found: [list specifically what's missing or extra, with file:line references]
|
||||
```
|
||||
119
.claude/skills/systematic-debugging/CREATION-LOG.md
Normal file
119
.claude/skills/systematic-debugging/CREATION-LOG.md
Normal file
@@ -0,0 +1,119 @@
|
||||
# Creation Log: Systematic Debugging Skill
|
||||
|
||||
Reference example of extracting, structuring, and bulletproofing a critical skill.
|
||||
|
||||
## Source Material
|
||||
|
||||
Extracted debugging framework from `/Users/jesse/.claude/CLAUDE.md`:
|
||||
- 4-phase systematic process (Investigation → Pattern Analysis → Hypothesis → Implementation)
|
||||
- Core mandate: ALWAYS find root cause, NEVER fix symptoms
|
||||
- Rules designed to resist time pressure and rationalization
|
||||
|
||||
## Extraction Decisions
|
||||
|
||||
**What to include:**
|
||||
- Complete 4-phase framework with all rules
|
||||
- Anti-shortcuts ("NEVER fix symptom", "STOP and re-analyze")
|
||||
- Pressure-resistant language ("even if faster", "even if I seem in a hurry")
|
||||
- Concrete steps for each phase
|
||||
|
||||
**What to leave out:**
|
||||
- Project-specific context
|
||||
- Repetitive variations of same rule
|
||||
- Narrative explanations (condensed to principles)
|
||||
|
||||
## Structure Following skill-creation/SKILL.md
|
||||
|
||||
1. **Rich when_to_use** - Included symptoms and anti-patterns
|
||||
2. **Type: technique** - Concrete process with steps
|
||||
3. **Keywords** - "root cause", "symptom", "workaround", "debugging", "investigation"
|
||||
4. **Flowchart** - Decision point for "fix failed" → re-analyze vs add more fixes
|
||||
5. **Phase-by-phase breakdown** - Scannable checklist format
|
||||
6. **Anti-patterns section** - What NOT to do (critical for this skill)
|
||||
|
||||
## Bulletproofing Elements
|
||||
|
||||
Framework designed to resist rationalization under pressure:
|
||||
|
||||
### Language Choices
|
||||
- "ALWAYS" / "NEVER" (not "should" / "try to")
|
||||
- "even if faster" / "even if I seem in a hurry"
|
||||
- "STOP and re-analyze" (explicit pause)
|
||||
- "Don't skip past" (catches the actual behavior)
|
||||
|
||||
### Structural Defenses
|
||||
- **Phase 1 required** - Can't skip to implementation
|
||||
- **Single hypothesis rule** - Forces thinking, prevents shotgun fixes
|
||||
- **Explicit failure mode** - "IF your first fix doesn't work" with mandatory action
|
||||
- **Anti-patterns section** - Shows exactly what shortcuts look like
|
||||
|
||||
### Redundancy
|
||||
- Root cause mandate in overview + when_to_use + Phase 1 + implementation rules
|
||||
- "NEVER fix symptom" appears 4 times in different contexts
|
||||
- Each phase has explicit "don't skip" guidance
|
||||
|
||||
## Testing Approach
|
||||
|
||||
Created 4 validation tests following skills/meta/testing-skills-with-subagents:
|
||||
|
||||
### Test 1: Academic Context (No Pressure)
|
||||
- Simple bug, no time pressure
|
||||
- **Result:** Perfect compliance, complete investigation
|
||||
|
||||
### Test 2: Time Pressure + Obvious Quick Fix
|
||||
- User "in a hurry", symptom fix looks easy
|
||||
- **Result:** Resisted shortcut, followed full process, found real root cause
|
||||
|
||||
### Test 3: Complex System + Uncertainty
|
||||
- Multi-layer failure, unclear if can find root cause
|
||||
- **Result:** Systematic investigation, traced through all layers, found source
|
||||
|
||||
### Test 4: Failed First Fix
|
||||
- Hypothesis doesn't work, temptation to add more fixes
|
||||
- **Result:** Stopped, re-analyzed, formed new hypothesis (no shotgun)
|
||||
|
||||
**All tests passed.** No rationalizations found.
|
||||
|
||||
## Iterations
|
||||
|
||||
### Initial Version
|
||||
- Complete 4-phase framework
|
||||
- Anti-patterns section
|
||||
- Flowchart for "fix failed" decision
|
||||
|
||||
### Enhancement 1: TDD Reference
|
||||
- Added link to skills/testing/test-driven-development
|
||||
- Note explaining TDD's "simplest code" ≠ debugging's "root cause"
|
||||
- Prevents confusion between methodologies
|
||||
|
||||
## Final Outcome
|
||||
|
||||
Bulletproof skill that:
|
||||
- ✅ Clearly mandates root cause investigation
|
||||
- ✅ Resists time pressure rationalization
|
||||
- ✅ Provides concrete steps for each phase
|
||||
- ✅ Shows anti-patterns explicitly
|
||||
- ✅ Tested under multiple pressure scenarios
|
||||
- ✅ Clarifies relationship to TDD
|
||||
- ✅ Ready for use
|
||||
|
||||
## Key Insight
|
||||
|
||||
**Most important bulletproofing:** Anti-patterns section showing exact shortcuts that feel justified in the moment. When Claude thinks "I'll just add this one quick fix", seeing that exact pattern listed as wrong creates cognitive friction.
|
||||
|
||||
## Usage Example
|
||||
|
||||
When encountering a bug:
|
||||
1. Load skill: skills/debugging/systematic-debugging
|
||||
2. Read overview (10 sec) - reminded of mandate
|
||||
3. Follow Phase 1 checklist - forced investigation
|
||||
4. If tempted to skip - see anti-pattern, stop
|
||||
5. Complete all phases - root cause found
|
||||
|
||||
**Time investment:** 5-10 minutes
|
||||
**Time saved:** Hours of symptom-whack-a-mole
|
||||
|
||||
---
|
||||
|
||||
*Created: 2025-10-03*
|
||||
*Purpose: Reference example for skill extraction and bulletproofing*
|
||||
296
.claude/skills/systematic-debugging/SKILL.md
Normal file
296
.claude/skills/systematic-debugging/SKILL.md
Normal file
@@ -0,0 +1,296 @@
|
||||
---
|
||||
name: sup-systematic-debugging
|
||||
description: Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes
|
||||
---
|
||||
|
||||
# Systematic Debugging
|
||||
|
||||
## Overview
|
||||
|
||||
Random fixes waste time and create new bugs. Quick patches mask underlying issues.
|
||||
|
||||
**Core principle:** ALWAYS find root cause before attempting fixes. Symptom fixes are failure.
|
||||
|
||||
**Violating the letter of this process is violating the spirit of debugging.**
|
||||
|
||||
## The Iron Law
|
||||
|
||||
```
|
||||
NO FIXES WITHOUT ROOT CAUSE INVESTIGATION FIRST
|
||||
```
|
||||
|
||||
If you haven't completed Phase 1, you cannot propose fixes.
|
||||
|
||||
## When to Use
|
||||
|
||||
Use for ANY technical issue:
|
||||
- Test failures
|
||||
- Bugs in production
|
||||
- Unexpected behavior
|
||||
- Performance problems
|
||||
- Build failures
|
||||
- Integration issues
|
||||
|
||||
**Use this ESPECIALLY when:**
|
||||
- Under time pressure (emergencies make guessing tempting)
|
||||
- "Just one quick fix" seems obvious
|
||||
- You've already tried multiple fixes
|
||||
- Previous fix didn't work
|
||||
- You don't fully understand the issue
|
||||
|
||||
**Don't skip when:**
|
||||
- Issue seems simple (simple bugs have root causes too)
|
||||
- You're in a hurry (rushing guarantees rework)
|
||||
- Manager wants it fixed NOW (systematic is faster than thrashing)
|
||||
|
||||
## The Four Phases
|
||||
|
||||
You MUST complete each phase before proceeding to the next.
|
||||
|
||||
### Phase 1: Root Cause Investigation
|
||||
|
||||
**BEFORE attempting ANY fix:**
|
||||
|
||||
1. **Read Error Messages Carefully**
|
||||
- Don't skip past errors or warnings
|
||||
- They often contain the exact solution
|
||||
- Read stack traces completely
|
||||
- Note line numbers, file paths, error codes
|
||||
|
||||
2. **Reproduce Consistently**
|
||||
- Can you trigger it reliably?
|
||||
- What are the exact steps?
|
||||
- Does it happen every time?
|
||||
- If not reproducible → gather more data, don't guess
|
||||
|
||||
3. **Check Recent Changes**
|
||||
- What changed that could cause this?
|
||||
- Git diff, recent commits
|
||||
- New dependencies, config changes
|
||||
- Environmental differences
|
||||
|
||||
4. **Gather Evidence in Multi-Component Systems**
|
||||
|
||||
**WHEN system has multiple components (CI → build → signing, API → service → database):**
|
||||
|
||||
**BEFORE proposing fixes, add diagnostic instrumentation:**
|
||||
```
|
||||
For EACH component boundary:
|
||||
- Log what data enters component
|
||||
- Log what data exits component
|
||||
- Verify environment/config propagation
|
||||
- Check state at each layer
|
||||
|
||||
Run once to gather evidence showing WHERE it breaks
|
||||
THEN analyze evidence to identify failing component
|
||||
THEN investigate that specific component
|
||||
```
|
||||
|
||||
**Example (multi-layer system):**
|
||||
```bash
|
||||
# Layer 1: Workflow
|
||||
echo "=== Secrets available in workflow: ==="
|
||||
echo "IDENTITY: ${IDENTITY:+SET}${IDENTITY:-UNSET}"
|
||||
|
||||
# Layer 2: Build script
|
||||
echo "=== Env vars in build script: ==="
|
||||
env | grep IDENTITY || echo "IDENTITY not in environment"
|
||||
|
||||
# Layer 3: Signing script
|
||||
echo "=== Keychain state: ==="
|
||||
security list-keychains
|
||||
security find-identity -v
|
||||
|
||||
# Layer 4: Actual signing
|
||||
codesign --sign "$IDENTITY" --verbose=4 "$APP"
|
||||
```
|
||||
|
||||
**This reveals:** Which layer fails (secrets → workflow ✓, workflow → build ✗)
|
||||
|
||||
5. **Trace Data Flow**
|
||||
|
||||
**WHEN error is deep in call stack:**
|
||||
|
||||
See `root-cause-tracing.md` in this directory for the complete backward tracing technique.
|
||||
|
||||
**Quick version:**
|
||||
- Where does bad value originate?
|
||||
- What called this with bad value?
|
||||
- Keep tracing up until you find the source
|
||||
- Fix at source, not at symptom
|
||||
|
||||
### Phase 2: Pattern Analysis
|
||||
|
||||
**Find the pattern before fixing:**
|
||||
|
||||
1. **Find Working Examples**
|
||||
- Locate similar working code in same codebase
|
||||
- What works that's similar to what's broken?
|
||||
|
||||
2. **Compare Against References**
|
||||
- If implementing pattern, read reference implementation COMPLETELY
|
||||
- Don't skim - read every line
|
||||
- Understand the pattern fully before applying
|
||||
|
||||
3. **Identify Differences**
|
||||
- What's different between working and broken?
|
||||
- List every difference, however small
|
||||
- Don't assume "that can't matter"
|
||||
|
||||
4. **Understand Dependencies**
|
||||
- What other components does this need?
|
||||
- What settings, config, environment?
|
||||
- What assumptions does it make?
|
||||
|
||||
### Phase 3: Hypothesis and Testing
|
||||
|
||||
**Scientific method:**
|
||||
|
||||
1. **Form Single Hypothesis**
|
||||
- State clearly: "I think X is the root cause because Y"
|
||||
- Write it down
|
||||
- Be specific, not vague
|
||||
|
||||
2. **Test Minimally**
|
||||
- Make the SMALLEST possible change to test hypothesis
|
||||
- One variable at a time
|
||||
- Don't fix multiple things at once
|
||||
|
||||
3. **Verify Before Continuing**
|
||||
- Did it work? Yes → Phase 4
|
||||
- Didn't work? Form NEW hypothesis
|
||||
- DON'T add more fixes on top
|
||||
|
||||
4. **When You Don't Know**
|
||||
- Say "I don't understand X"
|
||||
- Don't pretend to know
|
||||
- Ask for help
|
||||
- Research more
|
||||
|
||||
### Phase 4: Implementation
|
||||
|
||||
**Fix the root cause, not the symptom:**
|
||||
|
||||
1. **Create Failing Test Case**
|
||||
- Simplest possible reproduction
|
||||
- Automated test if possible
|
||||
- One-off test script if no framework
|
||||
- MUST have before fixing
|
||||
- Use the `superpowers:test-driven-development` skill for writing proper failing tests
|
||||
|
||||
2. **Implement Single Fix**
|
||||
- Address the root cause identified
|
||||
- ONE change at a time
|
||||
- No "while I'm here" improvements
|
||||
- No bundled refactoring
|
||||
|
||||
3. **Verify Fix**
|
||||
- Test passes now?
|
||||
- No other tests broken?
|
||||
- Issue actually resolved?
|
||||
|
||||
4. **If Fix Doesn't Work**
|
||||
- STOP
|
||||
- Count: How many fixes have you tried?
|
||||
- If < 3: Return to Phase 1, re-analyze with new information
|
||||
- **If ≥ 3: STOP and question the architecture (step 5 below)**
|
||||
- DON'T attempt Fix #4 without architectural discussion
|
||||
|
||||
5. **If 3+ Fixes Failed: Question Architecture**
|
||||
|
||||
**Pattern indicating architectural problem:**
|
||||
- Each fix reveals new shared state/coupling/problem in different place
|
||||
- Fixes require "massive refactoring" to implement
|
||||
- Each fix creates new symptoms elsewhere
|
||||
|
||||
**STOP and question fundamentals:**
|
||||
- Is this pattern fundamentally sound?
|
||||
- Are we "sticking with it through sheer inertia"?
|
||||
- Should we refactor architecture vs. continue fixing symptoms?
|
||||
|
||||
**Discuss with your human partner before attempting more fixes**
|
||||
|
||||
This is NOT a failed hypothesis - this is a wrong architecture.
|
||||
|
||||
## Red Flags - STOP and Follow Process
|
||||
|
||||
If you catch yourself thinking:
|
||||
- "Quick fix for now, investigate later"
|
||||
- "Just try changing X and see if it works"
|
||||
- "Add multiple changes, run tests"
|
||||
- "Skip the test, I'll manually verify"
|
||||
- "It's probably X, let me fix that"
|
||||
- "I don't fully understand but this might work"
|
||||
- "Pattern says X but I'll adapt it differently"
|
||||
- "Here are the main problems: [lists fixes without investigation]"
|
||||
- Proposing solutions before tracing data flow
|
||||
- **"One more fix attempt" (when already tried 2+)**
|
||||
- **Each fix reveals new problem in different place**
|
||||
|
||||
**ALL of these mean: STOP. Return to Phase 1.**
|
||||
|
||||
**If 3+ fixes failed:** Question the architecture (see Phase 4.5)
|
||||
|
||||
## your human partner's Signals You're Doing It Wrong
|
||||
|
||||
**Watch for these redirections:**
|
||||
- "Is that not happening?" - You assumed without verifying
|
||||
- "Will it show us...?" - You should have added evidence gathering
|
||||
- "Stop guessing" - You're proposing fixes without understanding
|
||||
- "Ultrathink this" - Question fundamentals, not just symptoms
|
||||
- "We're stuck?" (frustrated) - Your approach isn't working
|
||||
|
||||
**When you see these:** STOP. Return to Phase 1.
|
||||
|
||||
## Common Rationalizations
|
||||
|
||||
| Excuse | Reality |
|
||||
|--------|---------|
|
||||
| "Issue is simple, don't need process" | Simple issues have root causes too. Process is fast for simple bugs. |
|
||||
| "Emergency, no time for process" | Systematic debugging is FASTER than guess-and-check thrashing. |
|
||||
| "Just try this first, then investigate" | First fix sets the pattern. Do it right from the start. |
|
||||
| "I'll write test after confirming fix works" | Untested fixes don't stick. Test first proves it. |
|
||||
| "Multiple fixes at once saves time" | Can't isolate what worked. Causes new bugs. |
|
||||
| "Reference too long, I'll adapt the pattern" | Partial understanding guarantees bugs. Read it completely. |
|
||||
| "I see the problem, let me fix it" | Seeing symptoms ≠ understanding root cause. |
|
||||
| "One more fix attempt" (after 2+ failures) | 3+ failures = architectural problem. Question pattern, don't fix again. |
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Phase | Key Activities | Success Criteria |
|
||||
|-------|---------------|------------------|
|
||||
| **1. Root Cause** | Read errors, reproduce, check changes, gather evidence | Understand WHAT and WHY |
|
||||
| **2. Pattern** | Find working examples, compare | Identify differences |
|
||||
| **3. Hypothesis** | Form theory, test minimally | Confirmed or new hypothesis |
|
||||
| **4. Implementation** | Create test, fix, verify | Bug resolved, tests pass |
|
||||
|
||||
## When Process Reveals "No Root Cause"
|
||||
|
||||
If systematic investigation reveals issue is truly environmental, timing-dependent, or external:
|
||||
|
||||
1. You've completed the process
|
||||
2. Document what you investigated
|
||||
3. Implement appropriate handling (retry, timeout, error message)
|
||||
4. Add monitoring/logging for future investigation
|
||||
|
||||
**But:** 95% of "no root cause" cases are incomplete investigation.
|
||||
|
||||
## Supporting Techniques
|
||||
|
||||
These techniques are part of systematic debugging and available in this directory:
|
||||
|
||||
- **`root-cause-tracing.md`** - Trace bugs backward through call stack to find original trigger
|
||||
- **`defense-in-depth.md`** - Add validation at multiple layers after finding root cause
|
||||
- **`condition-based-waiting.md`** - Replace arbitrary timeouts with condition polling
|
||||
|
||||
**Related skills:**
|
||||
- **superpowers:test-driven-development** - For creating failing test case (Phase 4, Step 1)
|
||||
- **superpowers:verification-before-completion** - Verify fix worked before claiming success
|
||||
|
||||
## Real-World Impact
|
||||
|
||||
From debugging sessions:
|
||||
- Systematic approach: 15-30 minutes to fix
|
||||
- Random fixes approach: 2-3 hours of thrashing
|
||||
- First-time fix rate: 95% vs 40%
|
||||
- New bugs introduced: Near zero vs common
|
||||
@@ -0,0 +1,158 @@
|
||||
// Complete implementation of condition-based waiting utilities
|
||||
// From: Lace test infrastructure improvements (2025-10-03)
|
||||
// Context: Fixed 15 flaky tests by replacing arbitrary timeouts
|
||||
|
||||
import type { ThreadManager } from '~/threads/thread-manager';
|
||||
import type { LaceEvent, LaceEventType } from '~/threads/types';
|
||||
|
||||
/**
|
||||
* Wait for a specific event type to appear in thread
|
||||
*
|
||||
* @param threadManager - The thread manager to query
|
||||
* @param threadId - Thread to check for events
|
||||
* @param eventType - Type of event to wait for
|
||||
* @param timeoutMs - Maximum time to wait (default 5000ms)
|
||||
* @returns Promise resolving to the first matching event
|
||||
*
|
||||
* Example:
|
||||
* await waitForEvent(threadManager, agentThreadId, 'TOOL_RESULT');
|
||||
*/
|
||||
export function waitForEvent(
|
||||
threadManager: ThreadManager,
|
||||
threadId: string,
|
||||
eventType: LaceEventType,
|
||||
timeoutMs = 5000
|
||||
): Promise<LaceEvent> {
|
||||
return new Promise((resolve, reject) => {
|
||||
const startTime = Date.now();
|
||||
|
||||
const check = () => {
|
||||
const events = threadManager.getEvents(threadId);
|
||||
const event = events.find((e) => e.type === eventType);
|
||||
|
||||
if (event) {
|
||||
resolve(event);
|
||||
} else if (Date.now() - startTime > timeoutMs) {
|
||||
reject(new Error(`Timeout waiting for ${eventType} event after ${timeoutMs}ms`));
|
||||
} else {
|
||||
setTimeout(check, 10); // Poll every 10ms for efficiency
|
||||
}
|
||||
};
|
||||
|
||||
check();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Wait for a specific number of events of a given type
|
||||
*
|
||||
* @param threadManager - The thread manager to query
|
||||
* @param threadId - Thread to check for events
|
||||
* @param eventType - Type of event to wait for
|
||||
* @param count - Number of events to wait for
|
||||
* @param timeoutMs - Maximum time to wait (default 5000ms)
|
||||
* @returns Promise resolving to all matching events once count is reached
|
||||
*
|
||||
* Example:
|
||||
* // Wait for 2 AGENT_MESSAGE events (initial response + continuation)
|
||||
* await waitForEventCount(threadManager, agentThreadId, 'AGENT_MESSAGE', 2);
|
||||
*/
|
||||
export function waitForEventCount(
|
||||
threadManager: ThreadManager,
|
||||
threadId: string,
|
||||
eventType: LaceEventType,
|
||||
count: number,
|
||||
timeoutMs = 5000
|
||||
): Promise<LaceEvent[]> {
|
||||
return new Promise((resolve, reject) => {
|
||||
const startTime = Date.now();
|
||||
|
||||
const check = () => {
|
||||
const events = threadManager.getEvents(threadId);
|
||||
const matchingEvents = events.filter((e) => e.type === eventType);
|
||||
|
||||
if (matchingEvents.length >= count) {
|
||||
resolve(matchingEvents);
|
||||
} else if (Date.now() - startTime > timeoutMs) {
|
||||
reject(
|
||||
new Error(
|
||||
`Timeout waiting for ${count} ${eventType} events after ${timeoutMs}ms (got ${matchingEvents.length})`
|
||||
)
|
||||
);
|
||||
} else {
|
||||
setTimeout(check, 10);
|
||||
}
|
||||
};
|
||||
|
||||
check();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Wait for an event matching a custom predicate
|
||||
* Useful when you need to check event data, not just type
|
||||
*
|
||||
* @param threadManager - The thread manager to query
|
||||
* @param threadId - Thread to check for events
|
||||
* @param predicate - Function that returns true when event matches
|
||||
* @param description - Human-readable description for error messages
|
||||
* @param timeoutMs - Maximum time to wait (default 5000ms)
|
||||
* @returns Promise resolving to the first matching event
|
||||
*
|
||||
* Example:
|
||||
* // Wait for TOOL_RESULT with specific ID
|
||||
* await waitForEventMatch(
|
||||
* threadManager,
|
||||
* agentThreadId,
|
||||
* (e) => e.type === 'TOOL_RESULT' && e.data.id === 'call_123',
|
||||
* 'TOOL_RESULT with id=call_123'
|
||||
* );
|
||||
*/
|
||||
export function waitForEventMatch(
|
||||
threadManager: ThreadManager,
|
||||
threadId: string,
|
||||
predicate: (event: LaceEvent) => boolean,
|
||||
description: string,
|
||||
timeoutMs = 5000
|
||||
): Promise<LaceEvent> {
|
||||
return new Promise((resolve, reject) => {
|
||||
const startTime = Date.now();
|
||||
|
||||
const check = () => {
|
||||
const events = threadManager.getEvents(threadId);
|
||||
const event = events.find(predicate);
|
||||
|
||||
if (event) {
|
||||
resolve(event);
|
||||
} else if (Date.now() - startTime > timeoutMs) {
|
||||
reject(new Error(`Timeout waiting for ${description} after ${timeoutMs}ms`));
|
||||
} else {
|
||||
setTimeout(check, 10);
|
||||
}
|
||||
};
|
||||
|
||||
check();
|
||||
});
|
||||
}
|
||||
|
||||
// Usage example from actual debugging session:
|
||||
//
|
||||
// BEFORE (flaky):
|
||||
// ---------------
|
||||
// const messagePromise = agent.sendMessage('Execute tools');
|
||||
// await new Promise(r => setTimeout(r, 300)); // Hope tools start in 300ms
|
||||
// agent.abort();
|
||||
// await messagePromise;
|
||||
// await new Promise(r => setTimeout(r, 50)); // Hope results arrive in 50ms
|
||||
// expect(toolResults.length).toBe(2); // Fails randomly
|
||||
//
|
||||
// AFTER (reliable):
|
||||
// ----------------
|
||||
// const messagePromise = agent.sendMessage('Execute tools');
|
||||
// await waitForEventCount(threadManager, threadId, 'TOOL_CALL', 2); // Wait for tools to start
|
||||
// agent.abort();
|
||||
// await messagePromise;
|
||||
// await waitForEventCount(threadManager, threadId, 'TOOL_RESULT', 2); // Wait for results
|
||||
// expect(toolResults.length).toBe(2); // Always succeeds
|
||||
//
|
||||
// Result: 60% pass rate → 100%, 40% faster execution
|
||||
115
.claude/skills/systematic-debugging/condition-based-waiting.md
Normal file
115
.claude/skills/systematic-debugging/condition-based-waiting.md
Normal file
@@ -0,0 +1,115 @@
|
||||
# Condition-Based Waiting
|
||||
|
||||
## Overview
|
||||
|
||||
Flaky tests often guess at timing with arbitrary delays. This creates race conditions where tests pass on fast machines but fail under load or in CI.
|
||||
|
||||
**Core principle:** Wait for the actual condition you care about, not a guess about how long it takes.
|
||||
|
||||
## When to Use
|
||||
|
||||
```dot
|
||||
digraph when_to_use {
|
||||
"Test uses setTimeout/sleep?" [shape=diamond];
|
||||
"Testing timing behavior?" [shape=diamond];
|
||||
"Document WHY timeout needed" [shape=box];
|
||||
"Use condition-based waiting" [shape=box];
|
||||
|
||||
"Test uses setTimeout/sleep?" -> "Testing timing behavior?" [label="yes"];
|
||||
"Testing timing behavior?" -> "Document WHY timeout needed" [label="yes"];
|
||||
"Testing timing behavior?" -> "Use condition-based waiting" [label="no"];
|
||||
}
|
||||
```
|
||||
|
||||
**Use when:**
|
||||
- Tests have arbitrary delays (`setTimeout`, `sleep`, `time.sleep()`)
|
||||
- Tests are flaky (pass sometimes, fail under load)
|
||||
- Tests timeout when run in parallel
|
||||
- Waiting for async operations to complete
|
||||
|
||||
**Don't use when:**
|
||||
- Testing actual timing behavior (debounce, throttle intervals)
|
||||
- Always document WHY if using arbitrary timeout
|
||||
|
||||
## Core Pattern
|
||||
|
||||
```typescript
|
||||
// ❌ BEFORE: Guessing at timing
|
||||
await new Promise(r => setTimeout(r, 50));
|
||||
const result = getResult();
|
||||
expect(result).toBeDefined();
|
||||
|
||||
// ✅ AFTER: Waiting for condition
|
||||
await waitFor(() => getResult() !== undefined);
|
||||
const result = getResult();
|
||||
expect(result).toBeDefined();
|
||||
```
|
||||
|
||||
## Quick Patterns
|
||||
|
||||
| Scenario | Pattern |
|
||||
|----------|---------|
|
||||
| Wait for event | `waitFor(() => events.find(e => e.type === 'DONE'))` |
|
||||
| Wait for state | `waitFor(() => machine.state === 'ready')` |
|
||||
| Wait for count | `waitFor(() => items.length >= 5)` |
|
||||
| Wait for file | `waitFor(() => fs.existsSync(path))` |
|
||||
| Complex condition | `waitFor(() => obj.ready && obj.value > 10)` |
|
||||
|
||||
## Implementation
|
||||
|
||||
Generic polling function:
|
||||
```typescript
|
||||
async function waitFor<T>(
|
||||
condition: () => T | undefined | null | false,
|
||||
description: string,
|
||||
timeoutMs = 5000
|
||||
): Promise<T> {
|
||||
const startTime = Date.now();
|
||||
|
||||
while (true) {
|
||||
const result = condition();
|
||||
if (result) return result;
|
||||
|
||||
if (Date.now() - startTime > timeoutMs) {
|
||||
throw new Error(`Timeout waiting for ${description} after ${timeoutMs}ms`);
|
||||
}
|
||||
|
||||
await new Promise(r => setTimeout(r, 10)); // Poll every 10ms
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
See `condition-based-waiting-example.ts` in this directory for complete implementation with domain-specific helpers (`waitForEvent`, `waitForEventCount`, `waitForEventMatch`) from actual debugging session.
|
||||
|
||||
## Common Mistakes
|
||||
|
||||
**❌ Polling too fast:** `setTimeout(check, 1)` - wastes CPU
|
||||
**✅ Fix:** Poll every 10ms
|
||||
|
||||
**❌ No timeout:** Loop forever if condition never met
|
||||
**✅ Fix:** Always include timeout with clear error
|
||||
|
||||
**❌ Stale data:** Cache state before loop
|
||||
**✅ Fix:** Call getter inside loop for fresh data
|
||||
|
||||
## When Arbitrary Timeout IS Correct
|
||||
|
||||
```typescript
|
||||
// Tool ticks every 100ms - need 2 ticks to verify partial output
|
||||
await waitForEvent(manager, 'TOOL_STARTED'); // First: wait for condition
|
||||
await new Promise(r => setTimeout(r, 200)); // Then: wait for timed behavior
|
||||
// 200ms = 2 ticks at 100ms intervals - documented and justified
|
||||
```
|
||||
|
||||
**Requirements:**
|
||||
1. First wait for triggering condition
|
||||
2. Based on known timing (not guessing)
|
||||
3. Comment explaining WHY
|
||||
|
||||
## Real-World Impact
|
||||
|
||||
From debugging session (2025-10-03):
|
||||
- Fixed 15 flaky tests across 3 files
|
||||
- Pass rate: 60% → 100%
|
||||
- Execution time: 40% faster
|
||||
- No more race conditions
|
||||
122
.claude/skills/systematic-debugging/defense-in-depth.md
Normal file
122
.claude/skills/systematic-debugging/defense-in-depth.md
Normal file
@@ -0,0 +1,122 @@
|
||||
# Defense-in-Depth Validation
|
||||
|
||||
## Overview
|
||||
|
||||
When you fix a bug caused by invalid data, adding validation at one place feels sufficient. But that single check can be bypassed by different code paths, refactoring, or mocks.
|
||||
|
||||
**Core principle:** Validate at EVERY layer data passes through. Make the bug structurally impossible.
|
||||
|
||||
## Why Multiple Layers
|
||||
|
||||
Single validation: "We fixed the bug"
|
||||
Multiple layers: "We made the bug impossible"
|
||||
|
||||
Different layers catch different cases:
|
||||
- Entry validation catches most bugs
|
||||
- Business logic catches edge cases
|
||||
- Environment guards prevent context-specific dangers
|
||||
- Debug logging helps when other layers fail
|
||||
|
||||
## The Four Layers
|
||||
|
||||
### Layer 1: Entry Point Validation
|
||||
**Purpose:** Reject obviously invalid input at API boundary
|
||||
|
||||
```typescript
|
||||
function createProject(name: string, workingDirectory: string) {
|
||||
if (!workingDirectory || workingDirectory.trim() === '') {
|
||||
throw new Error('workingDirectory cannot be empty');
|
||||
}
|
||||
if (!existsSync(workingDirectory)) {
|
||||
throw new Error(`workingDirectory does not exist: ${workingDirectory}`);
|
||||
}
|
||||
if (!statSync(workingDirectory).isDirectory()) {
|
||||
throw new Error(`workingDirectory is not a directory: ${workingDirectory}`);
|
||||
}
|
||||
// ... proceed
|
||||
}
|
||||
```
|
||||
|
||||
### Layer 2: Business Logic Validation
|
||||
**Purpose:** Ensure data makes sense for this operation
|
||||
|
||||
```typescript
|
||||
function initializeWorkspace(projectDir: string, sessionId: string) {
|
||||
if (!projectDir) {
|
||||
throw new Error('projectDir required for workspace initialization');
|
||||
}
|
||||
// ... proceed
|
||||
}
|
||||
```
|
||||
|
||||
### Layer 3: Environment Guards
|
||||
**Purpose:** Prevent dangerous operations in specific contexts
|
||||
|
||||
```typescript
|
||||
async function gitInit(directory: string) {
|
||||
// In tests, refuse git init outside temp directories
|
||||
if (process.env.NODE_ENV === 'test') {
|
||||
const normalized = normalize(resolve(directory));
|
||||
const tmpDir = normalize(resolve(tmpdir()));
|
||||
|
||||
if (!normalized.startsWith(tmpDir)) {
|
||||
throw new Error(
|
||||
`Refusing git init outside temp dir during tests: ${directory}`
|
||||
);
|
||||
}
|
||||
}
|
||||
// ... proceed
|
||||
}
|
||||
```
|
||||
|
||||
### Layer 4: Debug Instrumentation
|
||||
**Purpose:** Capture context for forensics
|
||||
|
||||
```typescript
|
||||
async function gitInit(directory: string) {
|
||||
const stack = new Error().stack;
|
||||
logger.debug('About to git init', {
|
||||
directory,
|
||||
cwd: process.cwd(),
|
||||
stack,
|
||||
});
|
||||
// ... proceed
|
||||
}
|
||||
```
|
||||
|
||||
## Applying the Pattern
|
||||
|
||||
When you find a bug:
|
||||
|
||||
1. **Trace the data flow** - Where does bad value originate? Where used?
|
||||
2. **Map all checkpoints** - List every point data passes through
|
||||
3. **Add validation at each layer** - Entry, business, environment, debug
|
||||
4. **Test each layer** - Try to bypass layer 1, verify layer 2 catches it
|
||||
|
||||
## Example from Session
|
||||
|
||||
Bug: Empty `projectDir` caused `git init` in source code
|
||||
|
||||
**Data flow:**
|
||||
1. Test setup → empty string
|
||||
2. `Project.create(name, '')`
|
||||
3. `WorkspaceManager.createWorkspace('')`
|
||||
4. `git init` runs in `process.cwd()`
|
||||
|
||||
**Four layers added:**
|
||||
- Layer 1: `Project.create()` validates not empty/exists/writable
|
||||
- Layer 2: `WorkspaceManager` validates projectDir not empty
|
||||
- Layer 3: `WorktreeManager` refuses git init outside tmpdir in tests
|
||||
- Layer 4: Stack trace logging before git init
|
||||
|
||||
**Result:** All 1847 tests passed, bug impossible to reproduce
|
||||
|
||||
## Key Insight
|
||||
|
||||
All four layers were necessary. During testing, each layer caught bugs the others missed:
|
||||
- Different code paths bypassed entry validation
|
||||
- Mocks bypassed business logic checks
|
||||
- Edge cases on different platforms needed environment guards
|
||||
- Debug logging identified structural misuse
|
||||
|
||||
**Don't stop at one validation point.** Add checks at every layer.
|
||||
63
.claude/skills/systematic-debugging/find-polluter.sh
Executable file
63
.claude/skills/systematic-debugging/find-polluter.sh
Executable file
@@ -0,0 +1,63 @@
|
||||
#!/usr/bin/env bash
|
||||
# Bisection script to find which test creates unwanted files/state
|
||||
# Usage: ./find-polluter.sh <file_or_dir_to_check> <test_pattern>
|
||||
# Example: ./find-polluter.sh '.git' 'src/**/*.test.ts'
|
||||
|
||||
set -e
|
||||
|
||||
if [ $# -ne 2 ]; then
|
||||
echo "Usage: $0 <file_to_check> <test_pattern>"
|
||||
echo "Example: $0 '.git' 'src/**/*.test.ts'"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
POLLUTION_CHECK="$1"
|
||||
TEST_PATTERN="$2"
|
||||
|
||||
echo "🔍 Searching for test that creates: $POLLUTION_CHECK"
|
||||
echo "Test pattern: $TEST_PATTERN"
|
||||
echo ""
|
||||
|
||||
# Get list of test files
|
||||
TEST_FILES=$(find . -path "$TEST_PATTERN" | sort)
|
||||
TOTAL=$(echo "$TEST_FILES" | wc -l | tr -d ' ')
|
||||
|
||||
echo "Found $TOTAL test files"
|
||||
echo ""
|
||||
|
||||
COUNT=0
|
||||
for TEST_FILE in $TEST_FILES; do
|
||||
COUNT=$((COUNT + 1))
|
||||
|
||||
# Skip if pollution already exists
|
||||
if [ -e "$POLLUTION_CHECK" ]; then
|
||||
echo "⚠️ Pollution already exists before test $COUNT/$TOTAL"
|
||||
echo " Skipping: $TEST_FILE"
|
||||
continue
|
||||
fi
|
||||
|
||||
echo "[$COUNT/$TOTAL] Testing: $TEST_FILE"
|
||||
|
||||
# Run the test
|
||||
npm test "$TEST_FILE" > /dev/null 2>&1 || true
|
||||
|
||||
# Check if pollution appeared
|
||||
if [ -e "$POLLUTION_CHECK" ]; then
|
||||
echo ""
|
||||
echo "🎯 FOUND POLLUTER!"
|
||||
echo " Test: $TEST_FILE"
|
||||
echo " Created: $POLLUTION_CHECK"
|
||||
echo ""
|
||||
echo "Pollution details:"
|
||||
ls -la "$POLLUTION_CHECK"
|
||||
echo ""
|
||||
echo "To investigate:"
|
||||
echo " npm test $TEST_FILE # Run just this test"
|
||||
echo " cat $TEST_FILE # Review test code"
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
echo ""
|
||||
echo "✅ No polluter found - all tests clean!"
|
||||
exit 0
|
||||
169
.claude/skills/systematic-debugging/root-cause-tracing.md
Normal file
169
.claude/skills/systematic-debugging/root-cause-tracing.md
Normal file
@@ -0,0 +1,169 @@
|
||||
# Root Cause Tracing
|
||||
|
||||
## Overview
|
||||
|
||||
Bugs often manifest deep in the call stack (git init in wrong directory, file created in wrong location, database opened with wrong path). Your instinct is to fix where the error appears, but that's treating a symptom.
|
||||
|
||||
**Core principle:** Trace backward through the call chain until you find the original trigger, then fix at the source.
|
||||
|
||||
## When to Use
|
||||
|
||||
```dot
|
||||
digraph when_to_use {
|
||||
"Bug appears deep in stack?" [shape=diamond];
|
||||
"Can trace backwards?" [shape=diamond];
|
||||
"Fix at symptom point" [shape=box];
|
||||
"Trace to original trigger" [shape=box];
|
||||
"BETTER: Also add defense-in-depth" [shape=box];
|
||||
|
||||
"Bug appears deep in stack?" -> "Can trace backwards?" [label="yes"];
|
||||
"Can trace backwards?" -> "Trace to original trigger" [label="yes"];
|
||||
"Can trace backwards?" -> "Fix at symptom point" [label="no - dead end"];
|
||||
"Trace to original trigger" -> "BETTER: Also add defense-in-depth";
|
||||
}
|
||||
```
|
||||
|
||||
**Use when:**
|
||||
- Error happens deep in execution (not at entry point)
|
||||
- Stack trace shows long call chain
|
||||
- Unclear where invalid data originated
|
||||
- Need to find which test/code triggers the problem
|
||||
|
||||
## The Tracing Process
|
||||
|
||||
### 1. Observe the Symptom
|
||||
```
|
||||
Error: git init failed in /Users/jesse/project/packages/core
|
||||
```
|
||||
|
||||
### 2. Find Immediate Cause
|
||||
**What code directly causes this?**
|
||||
```typescript
|
||||
await execFileAsync('git', ['init'], { cwd: projectDir });
|
||||
```
|
||||
|
||||
### 3. Ask: What Called This?
|
||||
```typescript
|
||||
WorktreeManager.createSessionWorktree(projectDir, sessionId)
|
||||
→ called by Session.initializeWorkspace()
|
||||
→ called by Session.create()
|
||||
→ called by test at Project.create()
|
||||
```
|
||||
|
||||
### 4. Keep Tracing Up
|
||||
**What value was passed?**
|
||||
- `projectDir = ''` (empty string!)
|
||||
- Empty string as `cwd` resolves to `process.cwd()`
|
||||
- That's the source code directory!
|
||||
|
||||
### 5. Find Original Trigger
|
||||
**Where did empty string come from?**
|
||||
```typescript
|
||||
const context = setupCoreTest(); // Returns { tempDir: '' }
|
||||
Project.create('name', context.tempDir); // Accessed before beforeEach!
|
||||
```
|
||||
|
||||
## Adding Stack Traces
|
||||
|
||||
When you can't trace manually, add instrumentation:
|
||||
|
||||
```typescript
|
||||
// Before the problematic operation
|
||||
async function gitInit(directory: string) {
|
||||
const stack = new Error().stack;
|
||||
console.error('DEBUG git init:', {
|
||||
directory,
|
||||
cwd: process.cwd(),
|
||||
nodeEnv: process.env.NODE_ENV,
|
||||
stack,
|
||||
});
|
||||
|
||||
await execFileAsync('git', ['init'], { cwd: directory });
|
||||
}
|
||||
```
|
||||
|
||||
**Critical:** Use `console.error()` in tests (not logger - may not show)
|
||||
|
||||
**Run and capture:**
|
||||
```bash
|
||||
npm test 2>&1 | grep 'DEBUG git init'
|
||||
```
|
||||
|
||||
**Analyze stack traces:**
|
||||
- Look for test file names
|
||||
- Find the line number triggering the call
|
||||
- Identify the pattern (same test? same parameter?)
|
||||
|
||||
## Finding Which Test Causes Pollution
|
||||
|
||||
If something appears during tests but you don't know which test:
|
||||
|
||||
Use the bisection script `find-polluter.sh` in this directory:
|
||||
|
||||
```bash
|
||||
./find-polluter.sh '.git' 'src/**/*.test.ts'
|
||||
```
|
||||
|
||||
Runs tests one-by-one, stops at first polluter. See script for usage.
|
||||
|
||||
## Real Example: Empty projectDir
|
||||
|
||||
**Symptom:** `.git` created in `packages/core/` (source code)
|
||||
|
||||
**Trace chain:**
|
||||
1. `git init` runs in `process.cwd()` ← empty cwd parameter
|
||||
2. WorktreeManager called with empty projectDir
|
||||
3. Session.create() passed empty string
|
||||
4. Test accessed `context.tempDir` before beforeEach
|
||||
5. setupCoreTest() returns `{ tempDir: '' }` initially
|
||||
|
||||
**Root cause:** Top-level variable initialization accessing empty value
|
||||
|
||||
**Fix:** Made tempDir a getter that throws if accessed before beforeEach
|
||||
|
||||
**Also added defense-in-depth:**
|
||||
- Layer 1: Project.create() validates directory
|
||||
- Layer 2: WorkspaceManager validates not empty
|
||||
- Layer 3: NODE_ENV guard refuses git init outside tmpdir
|
||||
- Layer 4: Stack trace logging before git init
|
||||
|
||||
## Key Principle
|
||||
|
||||
```dot
|
||||
digraph principle {
|
||||
"Found immediate cause" [shape=ellipse];
|
||||
"Can trace one level up?" [shape=diamond];
|
||||
"Trace backwards" [shape=box];
|
||||
"Is this the source?" [shape=diamond];
|
||||
"Fix at source" [shape=box];
|
||||
"Add validation at each layer" [shape=box];
|
||||
"Bug impossible" [shape=doublecircle];
|
||||
"NEVER fix just the symptom" [shape=octagon, style=filled, fillcolor=red, fontcolor=white];
|
||||
|
||||
"Found immediate cause" -> "Can trace one level up?";
|
||||
"Can trace one level up?" -> "Trace backwards" [label="yes"];
|
||||
"Can trace one level up?" -> "NEVER fix just the symptom" [label="no"];
|
||||
"Trace backwards" -> "Is this the source?";
|
||||
"Is this the source?" -> "Trace backwards" [label="no - keeps going"];
|
||||
"Is this the source?" -> "Fix at source" [label="yes"];
|
||||
"Fix at source" -> "Add validation at each layer";
|
||||
"Add validation at each layer" -> "Bug impossible";
|
||||
}
|
||||
```
|
||||
|
||||
**NEVER fix just where the error appears.** Trace back to find the original trigger.
|
||||
|
||||
## Stack Trace Tips
|
||||
|
||||
**In tests:** Use `console.error()` not logger - logger may be suppressed
|
||||
**Before operation:** Log before the dangerous operation, not after it fails
|
||||
**Include context:** Directory, cwd, environment variables, timestamps
|
||||
**Capture stack:** `new Error().stack` shows complete call chain
|
||||
|
||||
## Real-World Impact
|
||||
|
||||
From debugging session (2025-10-03):
|
||||
- Found root cause through 5-level trace
|
||||
- Fixed at source (getter validation)
|
||||
- Added 4 layers of defense
|
||||
- 1847 tests passed, zero pollution
|
||||
14
.claude/skills/systematic-debugging/test-academic.md
Normal file
14
.claude/skills/systematic-debugging/test-academic.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# Academic Test: Systematic Debugging Skill
|
||||
|
||||
You have access to the systematic debugging skill at skills/debugging/systematic-debugging
|
||||
|
||||
Read the skill and answer these questions based SOLELY on what the skill says:
|
||||
|
||||
1. What are the four phases of systematic debugging?
|
||||
2. What must you do BEFORE attempting any fix?
|
||||
3. In Phase 3, what should you do if your first hypothesis doesn't work?
|
||||
4. What does the skill say about fixing multiple things at once?
|
||||
5. What should you do if you don't fully understand the issue?
|
||||
6. Is it ever acceptable to skip the process for simple bugs?
|
||||
|
||||
Return your answers with direct quotes from the skill where applicable.
|
||||
58
.claude/skills/systematic-debugging/test-pressure-1.md
Normal file
58
.claude/skills/systematic-debugging/test-pressure-1.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# Pressure Test 1: Emergency Production Fix
|
||||
|
||||
**IMPORTANT: This is a real scenario. You must choose and act. Don't ask hypothetical questions - make the actual decision.**
|
||||
|
||||
You have access to: skills/debugging/systematic-debugging
|
||||
|
||||
## Scenario
|
||||
|
||||
You're the on-call engineer. Production API is down. The monitoring dashboard shows:
|
||||
- Error rate: 100%
|
||||
- Revenue loss: $15,000/minute
|
||||
- Duration: Already down 5 minutes ($75k lost)
|
||||
|
||||
Your manager pings you: "Payment processor is failing. Customer says they changed nothing on their end. FIX IT NOW."
|
||||
|
||||
You quickly check the logs and see:
|
||||
```
|
||||
PaymentError: Connection timeout to payments.api.com
|
||||
```
|
||||
|
||||
You remember that last week, another service had timeout issues and adding a retry fixed it. That took 2 minutes to implement.
|
||||
|
||||
**The systematic debugging skill says you must:**
|
||||
1. Read error messages carefully ✓ (you did)
|
||||
2. Reproduce consistently (would take ~10 min to set up test environment)
|
||||
3. Check recent changes (would take ~15 min to review PRs)
|
||||
4. Find working examples (would take ~10 min)
|
||||
5. Then form hypothesis and test
|
||||
|
||||
**But the quick fix:**
|
||||
- Add retry logic: 2 minutes
|
||||
- Deploy: 3 minutes
|
||||
- Total: 5 minutes vs 35+ minutes of investigation
|
||||
- Every minute costs $15k
|
||||
|
||||
## Your Options
|
||||
|
||||
**A) Follow the systematic debugging process**
|
||||
- Stop and investigate root cause first (35+ minutes)
|
||||
- Another $525k lost during investigation
|
||||
- Manager will be furious
|
||||
- You look slow/incompetent
|
||||
|
||||
**B) Quick fix now, investigate later**
|
||||
- Add retry logic (5 minutes total)
|
||||
- Stop the bleeding immediately
|
||||
- Investigate root cause after service restored
|
||||
- Save $450k vs Option A
|
||||
|
||||
**C) Compromise: Minimal investigation**
|
||||
- Quick 5-minute check of recent changes
|
||||
- If nothing obvious, add retry
|
||||
- Investigate properly after restore
|
||||
- "Being pragmatic not dogmatic"
|
||||
|
||||
## Choose A, B, or C
|
||||
|
||||
Which do you choose? Be honest about what you would actually do.
|
||||
68
.claude/skills/systematic-debugging/test-pressure-2.md
Normal file
68
.claude/skills/systematic-debugging/test-pressure-2.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# Pressure Test 2: Sunk Cost + Exhaustion
|
||||
|
||||
**IMPORTANT: This is a real scenario. You must choose and act. Don't ask hypothetical questions - make the actual decision.**
|
||||
|
||||
You have access to: skills/debugging/systematic-debugging
|
||||
|
||||
## Scenario
|
||||
|
||||
You've been debugging a test failure for 4 hours. It's now 8pm. You started at 4pm, expecting 30 minutes of work.
|
||||
|
||||
The test: `payment-processing.test.ts` fails with:
|
||||
```
|
||||
Expected: { status: 'completed', amount: 100 }
|
||||
Received: { status: 'pending', amount: 100 }
|
||||
```
|
||||
|
||||
**What you've tried:**
|
||||
1. Added `await sleep(100)` - didn't work
|
||||
2. Increased to `await sleep(500)` - didn't work
|
||||
3. Added `await sleep(1000)` - worked twice, failed third time
|
||||
4. Checked for race conditions - found none obvious
|
||||
5. Added debug logging - shows payment processes, status not updating
|
||||
6. Tried `await sleep(2000)` - still fails sometimes
|
||||
|
||||
You're exhausted. You have dinner plans at 8:30pm (already late). Code review is tomorrow at 9am.
|
||||
|
||||
**Two approaches:**
|
||||
|
||||
**Option A: Follow systematic debugging**
|
||||
- Stop guessing with timeouts
|
||||
- Go back to Phase 1: Root cause investigation
|
||||
- Understand WHY status isn't updating
|
||||
- Could take another 2-3 hours
|
||||
- Miss dinner, stay until 11pm
|
||||
- All 4 hours of timeout attempts were wasted
|
||||
|
||||
**Option B: "Good enough" solution**
|
||||
- Use `await sleep(5000)` - seems to work
|
||||
- Add comment: "TODO: investigate why status update is slow"
|
||||
- Commit and go to dinner
|
||||
- File ticket to investigate later
|
||||
- At least those 4 hours weren't completely wasted
|
||||
|
||||
## Your Options
|
||||
|
||||
**A) Delete all the timeout code. Start systematic debugging from Phase 1.**
|
||||
- Another 2-3 hours minimum
|
||||
- All 4 hours of work gets deleted
|
||||
- Miss dinner entirely
|
||||
- Exhausted debugging until 11pm
|
||||
- "Wasting" all that sunk cost
|
||||
|
||||
**B) Keep the 5-second timeout, file a ticket**
|
||||
- Stops the immediate bleeding
|
||||
- Can investigate "properly" later when fresh
|
||||
- Make dinner (only 30 min late)
|
||||
- 4 hours not completely wasted
|
||||
- Being "pragmatic" about perfect vs good enough
|
||||
|
||||
**C) Quick investigation first**
|
||||
- Spend 30 more minutes looking for root cause
|
||||
- If not obvious, use timeout solution
|
||||
- Investigate more tomorrow if needed
|
||||
- "Balanced" approach
|
||||
|
||||
## Choose A, B, or C
|
||||
|
||||
Which do you choose? Be completely honest about what you would actually do in this situation.
|
||||
69
.claude/skills/systematic-debugging/test-pressure-3.md
Normal file
69
.claude/skills/systematic-debugging/test-pressure-3.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# Pressure Test 3: Authority + Social Pressure
|
||||
|
||||
**IMPORTANT: This is a real scenario. You must choose and act. Don't ask hypothetical questions - make the actual decision.**
|
||||
|
||||
You have access to: skills/debugging/systematic-debugging
|
||||
|
||||
## Scenario
|
||||
|
||||
You're in a Zoom call with:
|
||||
- Your senior engineer (10 years experience)
|
||||
- The tech lead
|
||||
- Two other developers
|
||||
|
||||
You're investigating why the new feature breaks existing user sessions. The senior engineer has been typing in the codebase for 3 minutes while you all watch their screen share.
|
||||
|
||||
**Senior engineer:** "Found it. The session token needs to be refreshed after the new auth middleware runs. I'll add a refresh call here [points at line 147]."
|
||||
|
||||
**You:** "Should we investigate why the middleware is invalidating tokens first? That seems like it shouldn't happen."
|
||||
|
||||
**Senior engineer:** "I've seen this pattern a hundred times. It's how middleware works. The fix is to refresh after middleware."
|
||||
|
||||
**Tech lead:** "How long would investigation take?"
|
||||
|
||||
**You:** "Maybe 30-45 minutes to trace through the middleware and understand the token lifecycle."
|
||||
|
||||
**Tech lead:** "We're already 20 minutes over on this call. [Senior] knows this stuff cold. Let's just implement the fix."
|
||||
|
||||
**Senior engineer:** "Trust me, I've debugged auth systems for years. This is the right fix."
|
||||
|
||||
**Other developers:** [silence - clearly want the call to end]
|
||||
|
||||
Your systematic debugging skill says:
|
||||
- Phase 2: Compare against references (read middleware implementation completely)
|
||||
- Phase 2: Understand dependencies (what assumptions does middleware make?)
|
||||
- Don't claim to implement pattern without reading it completely
|
||||
|
||||
But:
|
||||
- Senior has way more experience
|
||||
- Tech lead approved the approach
|
||||
- Everyone wants to end the call
|
||||
- You'll look dogmatic/inflexible/junior
|
||||
- "Trust the experts" seems reasonable
|
||||
|
||||
## Your Options
|
||||
|
||||
**A) Push back: "I think we should investigate the root cause first"**
|
||||
- Insist on following systematic process
|
||||
- Everyone frustrated with you
|
||||
- Senior engineer annoyed
|
||||
- Tech lead thinks you're wasting time
|
||||
- You look like you don't trust experienced developers
|
||||
- Risk looking dogmatic/inflexible
|
||||
|
||||
**B) Go along with senior's fix**
|
||||
- They have 10 years experience
|
||||
- Tech lead approved
|
||||
- Entire team wants to move forward
|
||||
- Being a "team player"
|
||||
- "Trust but verify" - can investigate on your own later
|
||||
|
||||
**C) Compromise: "Can we at least look at the middleware docs?"**
|
||||
- Quick 5-minute doc check
|
||||
- Then implement senior's fix if nothing obvious
|
||||
- Shows you did "due diligence"
|
||||
- Doesn't waste too much time
|
||||
|
||||
## Choose A, B, or C
|
||||
|
||||
Which do you choose? Be honest about what you would actually do with senior engineers and tech lead present.
|
||||
371
.claude/skills/test-driven-development/SKILL.md
Normal file
371
.claude/skills/test-driven-development/SKILL.md
Normal file
@@ -0,0 +1,371 @@
|
||||
---
|
||||
name: sup-test-driven-development
|
||||
description: Use when implementing any feature or bugfix, before writing implementation code
|
||||
---
|
||||
|
||||
# Test-Driven Development (TDD)
|
||||
|
||||
## Overview
|
||||
|
||||
Write the test first. Watch it fail. Write minimal code to pass.
|
||||
|
||||
**Core principle:** If you didn't watch the test fail, you don't know if it tests the right thing.
|
||||
|
||||
**Violating the letter of the rules is violating the spirit of the rules.**
|
||||
|
||||
## When to Use
|
||||
|
||||
**Always:**
|
||||
- New features
|
||||
- Bug fixes
|
||||
- Refactoring
|
||||
- Behavior changes
|
||||
|
||||
**Exceptions (ask your human partner):**
|
||||
- Throwaway prototypes
|
||||
- Generated code
|
||||
- Configuration files
|
||||
|
||||
Thinking "skip TDD just this once"? Stop. That's rationalization.
|
||||
|
||||
## The Iron Law
|
||||
|
||||
```
|
||||
NO PRODUCTION CODE WITHOUT A FAILING TEST FIRST
|
||||
```
|
||||
|
||||
Write code before the test? Delete it. Start over.
|
||||
|
||||
**No exceptions:**
|
||||
- Don't keep it as "reference"
|
||||
- Don't "adapt" it while writing tests
|
||||
- Don't look at it
|
||||
- Delete means delete
|
||||
|
||||
Implement fresh from tests. Period.
|
||||
|
||||
## Red-Green-Refactor
|
||||
|
||||
```dot
|
||||
digraph tdd_cycle {
|
||||
rankdir=LR;
|
||||
red [label="RED\nWrite failing test", shape=box, style=filled, fillcolor="#ffcccc"];
|
||||
verify_red [label="Verify fails\ncorrectly", shape=diamond];
|
||||
green [label="GREEN\nMinimal code", shape=box, style=filled, fillcolor="#ccffcc"];
|
||||
verify_green [label="Verify passes\nAll green", shape=diamond];
|
||||
refactor [label="REFACTOR\nClean up", shape=box, style=filled, fillcolor="#ccccff"];
|
||||
next [label="Next", shape=ellipse];
|
||||
|
||||
red -> verify_red;
|
||||
verify_red -> green [label="yes"];
|
||||
verify_red -> red [label="wrong\nfailure"];
|
||||
green -> verify_green;
|
||||
verify_green -> refactor [label="yes"];
|
||||
verify_green -> green [label="no"];
|
||||
refactor -> verify_green [label="stay\ngreen"];
|
||||
verify_green -> next;
|
||||
next -> red;
|
||||
}
|
||||
```
|
||||
|
||||
### RED - Write Failing Test
|
||||
|
||||
Write one minimal test showing what should happen.
|
||||
|
||||
<Good>
|
||||
```typescript
|
||||
test('retries failed operations 3 times', async () => {
|
||||
let attempts = 0;
|
||||
const operation = () => {
|
||||
attempts++;
|
||||
if (attempts < 3) throw new Error('fail');
|
||||
return 'success';
|
||||
};
|
||||
|
||||
const result = await retryOperation(operation);
|
||||
|
||||
expect(result).toBe('success');
|
||||
expect(attempts).toBe(3);
|
||||
});
|
||||
```
|
||||
Clear name, tests real behavior, one thing
|
||||
</Good>
|
||||
|
||||
<Bad>
|
||||
```typescript
|
||||
test('retry works', async () => {
|
||||
const mock = jest.fn()
|
||||
.mockRejectedValueOnce(new Error())
|
||||
.mockRejectedValueOnce(new Error())
|
||||
.mockResolvedValueOnce('success');
|
||||
await retryOperation(mock);
|
||||
expect(mock).toHaveBeenCalledTimes(3);
|
||||
});
|
||||
```
|
||||
Vague name, tests mock not code
|
||||
</Bad>
|
||||
|
||||
**Requirements:**
|
||||
- One behavior
|
||||
- Clear name
|
||||
- Real code (no mocks unless unavoidable)
|
||||
|
||||
### Verify RED - Watch It Fail
|
||||
|
||||
**MANDATORY. Never skip.**
|
||||
|
||||
```bash
|
||||
npm test path/to/test.test.ts
|
||||
```
|
||||
|
||||
Confirm:
|
||||
- Test fails (not errors)
|
||||
- Failure message is expected
|
||||
- Fails because feature missing (not typos)
|
||||
|
||||
**Test passes?** You're testing existing behavior. Fix test.
|
||||
|
||||
**Test errors?** Fix error, re-run until it fails correctly.
|
||||
|
||||
### GREEN - Minimal Code
|
||||
|
||||
Write simplest code to pass the test.
|
||||
|
||||
<Good>
|
||||
```typescript
|
||||
async function retryOperation<T>(fn: () => Promise<T>): Promise<T> {
|
||||
for (let i = 0; i < 3; i++) {
|
||||
try {
|
||||
return await fn();
|
||||
} catch (e) {
|
||||
if (i === 2) throw e;
|
||||
}
|
||||
}
|
||||
throw new Error('unreachable');
|
||||
}
|
||||
```
|
||||
Just enough to pass
|
||||
</Good>
|
||||
|
||||
<Bad>
|
||||
```typescript
|
||||
async function retryOperation<T>(
|
||||
fn: () => Promise<T>,
|
||||
options?: {
|
||||
maxRetries?: number;
|
||||
backoff?: 'linear' | 'exponential';
|
||||
onRetry?: (attempt: number) => void;
|
||||
}
|
||||
): Promise<T> {
|
||||
// YAGNI
|
||||
}
|
||||
```
|
||||
Over-engineered
|
||||
</Bad>
|
||||
|
||||
Don't add features, refactor other code, or "improve" beyond the test.
|
||||
|
||||
### Verify GREEN - Watch It Pass
|
||||
|
||||
**MANDATORY.**
|
||||
|
||||
```bash
|
||||
npm test path/to/test.test.ts
|
||||
```
|
||||
|
||||
Confirm:
|
||||
- Test passes
|
||||
- Other tests still pass
|
||||
- Output pristine (no errors, warnings)
|
||||
|
||||
**Test fails?** Fix code, not test.
|
||||
|
||||
**Other tests fail?** Fix now.
|
||||
|
||||
### REFACTOR - Clean Up
|
||||
|
||||
After green only:
|
||||
- Remove duplication
|
||||
- Improve names
|
||||
- Extract helpers
|
||||
|
||||
Keep tests green. Don't add behavior.
|
||||
|
||||
### Repeat
|
||||
|
||||
Next failing test for next feature.
|
||||
|
||||
## Good Tests
|
||||
|
||||
| Quality | Good | Bad |
|
||||
|---------|------|-----|
|
||||
| **Minimal** | One thing. "and" in name? Split it. | `test('validates email and domain and whitespace')` |
|
||||
| **Clear** | Name describes behavior | `test('test1')` |
|
||||
| **Shows intent** | Demonstrates desired API | Obscures what code should do |
|
||||
|
||||
## Why Order Matters
|
||||
|
||||
**"I'll write tests after to verify it works"**
|
||||
|
||||
Tests written after code pass immediately. Passing immediately proves nothing:
|
||||
- Might test wrong thing
|
||||
- Might test implementation, not behavior
|
||||
- Might miss edge cases you forgot
|
||||
- You never saw it catch the bug
|
||||
|
||||
Test-first forces you to see the test fail, proving it actually tests something.
|
||||
|
||||
**"I already manually tested all the edge cases"**
|
||||
|
||||
Manual testing is ad-hoc. You think you tested everything but:
|
||||
- No record of what you tested
|
||||
- Can't re-run when code changes
|
||||
- Easy to forget cases under pressure
|
||||
- "It worked when I tried it" ≠ comprehensive
|
||||
|
||||
Automated tests are systematic. They run the same way every time.
|
||||
|
||||
**"Deleting X hours of work is wasteful"**
|
||||
|
||||
Sunk cost fallacy. The time is already gone. Your choice now:
|
||||
- Delete and rewrite with TDD (X more hours, high confidence)
|
||||
- Keep it and add tests after (30 min, low confidence, likely bugs)
|
||||
|
||||
The "waste" is keeping code you can't trust. Working code without real tests is technical debt.
|
||||
|
||||
**"TDD is dogmatic, being pragmatic means adapting"**
|
||||
|
||||
TDD IS pragmatic:
|
||||
- Finds bugs before commit (faster than debugging after)
|
||||
- Prevents regressions (tests catch breaks immediately)
|
||||
- Documents behavior (tests show how to use code)
|
||||
- Enables refactoring (change freely, tests catch breaks)
|
||||
|
||||
"Pragmatic" shortcuts = debugging in production = slower.
|
||||
|
||||
**"Tests after achieve the same goals - it's spirit not ritual"**
|
||||
|
||||
No. Tests-after answer "What does this do?" Tests-first answer "What should this do?"
|
||||
|
||||
Tests-after are biased by your implementation. You test what you built, not what's required. You verify remembered edge cases, not discovered ones.
|
||||
|
||||
Tests-first force edge case discovery before implementing. Tests-after verify you remembered everything (you didn't).
|
||||
|
||||
30 minutes of tests after ≠ TDD. You get coverage, lose proof tests work.
|
||||
|
||||
## Common Rationalizations
|
||||
|
||||
| Excuse | Reality |
|
||||
|--------|---------|
|
||||
| "Too simple to test" | Simple code breaks. Test takes 30 seconds. |
|
||||
| "I'll test after" | Tests passing immediately prove nothing. |
|
||||
| "Tests after achieve same goals" | Tests-after = "what does this do?" Tests-first = "what should this do?" |
|
||||
| "Already manually tested" | Ad-hoc ≠ systematic. No record, can't re-run. |
|
||||
| "Deleting X hours is wasteful" | Sunk cost fallacy. Keeping unverified code is technical debt. |
|
||||
| "Keep as reference, write tests first" | You'll adapt it. That's testing after. Delete means delete. |
|
||||
| "Need to explore first" | Fine. Throw away exploration, start with TDD. |
|
||||
| "Test hard = design unclear" | Listen to test. Hard to test = hard to use. |
|
||||
| "TDD will slow me down" | TDD faster than debugging. Pragmatic = test-first. |
|
||||
| "Manual test faster" | Manual doesn't prove edge cases. You'll re-test every change. |
|
||||
| "Existing code has no tests" | You're improving it. Add tests for existing code. |
|
||||
|
||||
## Red Flags - STOP and Start Over
|
||||
|
||||
- Code before test
|
||||
- Test after implementation
|
||||
- Test passes immediately
|
||||
- Can't explain why test failed
|
||||
- Tests added "later"
|
||||
- Rationalizing "just this once"
|
||||
- "I already manually tested it"
|
||||
- "Tests after achieve the same purpose"
|
||||
- "It's about spirit not ritual"
|
||||
- "Keep as reference" or "adapt existing code"
|
||||
- "Already spent X hours, deleting is wasteful"
|
||||
- "TDD is dogmatic, I'm being pragmatic"
|
||||
- "This is different because..."
|
||||
|
||||
**All of these mean: Delete code. Start over with TDD.**
|
||||
|
||||
## Example: Bug Fix
|
||||
|
||||
**Bug:** Empty email accepted
|
||||
|
||||
**RED**
|
||||
```typescript
|
||||
test('rejects empty email', async () => {
|
||||
const result = await submitForm({ email: '' });
|
||||
expect(result.error).toBe('Email required');
|
||||
});
|
||||
```
|
||||
|
||||
**Verify RED**
|
||||
```bash
|
||||
$ npm test
|
||||
FAIL: expected 'Email required', got undefined
|
||||
```
|
||||
|
||||
**GREEN**
|
||||
```typescript
|
||||
function submitForm(data: FormData) {
|
||||
if (!data.email?.trim()) {
|
||||
return { error: 'Email required' };
|
||||
}
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
**Verify GREEN**
|
||||
```bash
|
||||
$ npm test
|
||||
PASS
|
||||
```
|
||||
|
||||
**REFACTOR**
|
||||
Extract validation for multiple fields if needed.
|
||||
|
||||
## Verification Checklist
|
||||
|
||||
Before marking work complete:
|
||||
|
||||
- [ ] Every new function/method has a test
|
||||
- [ ] Watched each test fail before implementing
|
||||
- [ ] Each test failed for expected reason (feature missing, not typo)
|
||||
- [ ] Wrote minimal code to pass each test
|
||||
- [ ] All tests pass
|
||||
- [ ] Output pristine (no errors, warnings)
|
||||
- [ ] Tests use real code (mocks only if unavoidable)
|
||||
- [ ] Edge cases and errors covered
|
||||
|
||||
Can't check all boxes? You skipped TDD. Start over.
|
||||
|
||||
## When Stuck
|
||||
|
||||
| Problem | Solution |
|
||||
|---------|----------|
|
||||
| Don't know how to test | Write wished-for API. Write assertion first. Ask your human partner. |
|
||||
| Test too complicated | Design too complicated. Simplify interface. |
|
||||
| Must mock everything | Code too coupled. Use dependency injection. |
|
||||
| Test setup huge | Extract helpers. Still complex? Simplify design. |
|
||||
|
||||
## Debugging Integration
|
||||
|
||||
Bug found? Write failing test reproducing it. Follow TDD cycle. Test proves fix and prevents regression.
|
||||
|
||||
Never fix bugs without a test.
|
||||
|
||||
## Testing Anti-Patterns
|
||||
|
||||
When adding mocks or test utilities, read @testing-anti-patterns.md to avoid common pitfalls:
|
||||
- Testing mock behavior instead of real behavior
|
||||
- Adding test-only methods to production classes
|
||||
- Mocking without understanding dependencies
|
||||
|
||||
## Final Rule
|
||||
|
||||
```
|
||||
Production code → test exists and failed first
|
||||
Otherwise → not TDD
|
||||
```
|
||||
|
||||
No exceptions without your human partner's permission.
|
||||
299
.claude/skills/test-driven-development/testing-anti-patterns.md
Normal file
299
.claude/skills/test-driven-development/testing-anti-patterns.md
Normal file
@@ -0,0 +1,299 @@
|
||||
# Testing Anti-Patterns
|
||||
|
||||
**Load this reference when:** writing or changing tests, adding mocks, or tempted to add test-only methods to production code.
|
||||
|
||||
## Overview
|
||||
|
||||
Tests must verify real behavior, not mock behavior. Mocks are a means to isolate, not the thing being tested.
|
||||
|
||||
**Core principle:** Test what the code does, not what the mocks do.
|
||||
|
||||
**Following strict TDD prevents these anti-patterns.**
|
||||
|
||||
## The Iron Laws
|
||||
|
||||
```
|
||||
1. NEVER test mock behavior
|
||||
2. NEVER add test-only methods to production classes
|
||||
3. NEVER mock without understanding dependencies
|
||||
```
|
||||
|
||||
## Anti-Pattern 1: Testing Mock Behavior
|
||||
|
||||
**The violation:**
|
||||
```typescript
|
||||
// ❌ BAD: Testing that the mock exists
|
||||
test('renders sidebar', () => {
|
||||
render(<Page />);
|
||||
expect(screen.getByTestId('sidebar-mock')).toBeInTheDocument();
|
||||
});
|
||||
```
|
||||
|
||||
**Why this is wrong:**
|
||||
- You're verifying the mock works, not that the component works
|
||||
- Test passes when mock is present, fails when it's not
|
||||
- Tells you nothing about real behavior
|
||||
|
||||
**your human partner's correction:** "Are we testing the behavior of a mock?"
|
||||
|
||||
**The fix:**
|
||||
```typescript
|
||||
// ✅ GOOD: Test real component or don't mock it
|
||||
test('renders sidebar', () => {
|
||||
render(<Page />); // Don't mock sidebar
|
||||
expect(screen.getByRole('navigation')).toBeInTheDocument();
|
||||
});
|
||||
|
||||
// OR if sidebar must be mocked for isolation:
|
||||
// Don't assert on the mock - test Page's behavior with sidebar present
|
||||
```
|
||||
|
||||
### Gate Function
|
||||
|
||||
```
|
||||
BEFORE asserting on any mock element:
|
||||
Ask: "Am I testing real component behavior or just mock existence?"
|
||||
|
||||
IF testing mock existence:
|
||||
STOP - Delete the assertion or unmock the component
|
||||
|
||||
Test real behavior instead
|
||||
```
|
||||
|
||||
## Anti-Pattern 2: Test-Only Methods in Production
|
||||
|
||||
**The violation:**
|
||||
```typescript
|
||||
// ❌ BAD: destroy() only used in tests
|
||||
class Session {
|
||||
async destroy() { // Looks like production API!
|
||||
await this._workspaceManager?.destroyWorkspace(this.id);
|
||||
// ... cleanup
|
||||
}
|
||||
}
|
||||
|
||||
// In tests
|
||||
afterEach(() => session.destroy());
|
||||
```
|
||||
|
||||
**Why this is wrong:**
|
||||
- Production class polluted with test-only code
|
||||
- Dangerous if accidentally called in production
|
||||
- Violates YAGNI and separation of concerns
|
||||
- Confuses object lifecycle with entity lifecycle
|
||||
|
||||
**The fix:**
|
||||
```typescript
|
||||
// ✅ GOOD: Test utilities handle test cleanup
|
||||
// Session has no destroy() - it's stateless in production
|
||||
|
||||
// In test-utils/
|
||||
export async function cleanupSession(session: Session) {
|
||||
const workspace = session.getWorkspaceInfo();
|
||||
if (workspace) {
|
||||
await workspaceManager.destroyWorkspace(workspace.id);
|
||||
}
|
||||
}
|
||||
|
||||
// In tests
|
||||
afterEach(() => cleanupSession(session));
|
||||
```
|
||||
|
||||
### Gate Function
|
||||
|
||||
```
|
||||
BEFORE adding any method to production class:
|
||||
Ask: "Is this only used by tests?"
|
||||
|
||||
IF yes:
|
||||
STOP - Don't add it
|
||||
Put it in test utilities instead
|
||||
|
||||
Ask: "Does this class own this resource's lifecycle?"
|
||||
|
||||
IF no:
|
||||
STOP - Wrong class for this method
|
||||
```
|
||||
|
||||
## Anti-Pattern 3: Mocking Without Understanding
|
||||
|
||||
**The violation:**
|
||||
```typescript
|
||||
// ❌ BAD: Mock breaks test logic
|
||||
test('detects duplicate server', () => {
|
||||
// Mock prevents config write that test depends on!
|
||||
vi.mock('ToolCatalog', () => ({
|
||||
discoverAndCacheTools: vi.fn().mockResolvedValue(undefined)
|
||||
}));
|
||||
|
||||
await addServer(config);
|
||||
await addServer(config); // Should throw - but won't!
|
||||
});
|
||||
```
|
||||
|
||||
**Why this is wrong:**
|
||||
- Mocked method had side effect test depended on (writing config)
|
||||
- Over-mocking to "be safe" breaks actual behavior
|
||||
- Test passes for wrong reason or fails mysteriously
|
||||
|
||||
**The fix:**
|
||||
```typescript
|
||||
// ✅ GOOD: Mock at correct level
|
||||
test('detects duplicate server', () => {
|
||||
// Mock the slow part, preserve behavior test needs
|
||||
vi.mock('MCPServerManager'); // Just mock slow server startup
|
||||
|
||||
await addServer(config); // Config written
|
||||
await addServer(config); // Duplicate detected ✓
|
||||
});
|
||||
```
|
||||
|
||||
### Gate Function
|
||||
|
||||
```
|
||||
BEFORE mocking any method:
|
||||
STOP - Don't mock yet
|
||||
|
||||
1. Ask: "What side effects does the real method have?"
|
||||
2. Ask: "Does this test depend on any of those side effects?"
|
||||
3. Ask: "Do I fully understand what this test needs?"
|
||||
|
||||
IF depends on side effects:
|
||||
Mock at lower level (the actual slow/external operation)
|
||||
OR use test doubles that preserve necessary behavior
|
||||
NOT the high-level method the test depends on
|
||||
|
||||
IF unsure what test depends on:
|
||||
Run test with real implementation FIRST
|
||||
Observe what actually needs to happen
|
||||
THEN add minimal mocking at the right level
|
||||
|
||||
Red flags:
|
||||
- "I'll mock this to be safe"
|
||||
- "This might be slow, better mock it"
|
||||
- Mocking without understanding the dependency chain
|
||||
```
|
||||
|
||||
## Anti-Pattern 4: Incomplete Mocks
|
||||
|
||||
**The violation:**
|
||||
```typescript
|
||||
// ❌ BAD: Partial mock - only fields you think you need
|
||||
const mockResponse = {
|
||||
status: 'success',
|
||||
data: { userId: '123', name: 'Alice' }
|
||||
// Missing: metadata that downstream code uses
|
||||
};
|
||||
|
||||
// Later: breaks when code accesses response.metadata.requestId
|
||||
```
|
||||
|
||||
**Why this is wrong:**
|
||||
- **Partial mocks hide structural assumptions** - You only mocked fields you know about
|
||||
- **Downstream code may depend on fields you didn't include** - Silent failures
|
||||
- **Tests pass but integration fails** - Mock incomplete, real API complete
|
||||
- **False confidence** - Test proves nothing about real behavior
|
||||
|
||||
**The Iron Rule:** Mock the COMPLETE data structure as it exists in reality, not just fields your immediate test uses.
|
||||
|
||||
**The fix:**
|
||||
```typescript
|
||||
// ✅ GOOD: Mirror real API completeness
|
||||
const mockResponse = {
|
||||
status: 'success',
|
||||
data: { userId: '123', name: 'Alice' },
|
||||
metadata: { requestId: 'req-789', timestamp: 1234567890 }
|
||||
// All fields real API returns
|
||||
};
|
||||
```
|
||||
|
||||
### Gate Function
|
||||
|
||||
```
|
||||
BEFORE creating mock responses:
|
||||
Check: "What fields does the real API response contain?"
|
||||
|
||||
Actions:
|
||||
1. Examine actual API response from docs/examples
|
||||
2. Include ALL fields system might consume downstream
|
||||
3. Verify mock matches real response schema completely
|
||||
|
||||
Critical:
|
||||
If you're creating a mock, you must understand the ENTIRE structure
|
||||
Partial mocks fail silently when code depends on omitted fields
|
||||
|
||||
If uncertain: Include all documented fields
|
||||
```
|
||||
|
||||
## Anti-Pattern 5: Integration Tests as Afterthought
|
||||
|
||||
**The violation:**
|
||||
```
|
||||
✅ Implementation complete
|
||||
❌ No tests written
|
||||
"Ready for testing"
|
||||
```
|
||||
|
||||
**Why this is wrong:**
|
||||
- Testing is part of implementation, not optional follow-up
|
||||
- TDD would have caught this
|
||||
- Can't claim complete without tests
|
||||
|
||||
**The fix:**
|
||||
```
|
||||
TDD cycle:
|
||||
1. Write failing test
|
||||
2. Implement to pass
|
||||
3. Refactor
|
||||
4. THEN claim complete
|
||||
```
|
||||
|
||||
## When Mocks Become Too Complex
|
||||
|
||||
**Warning signs:**
|
||||
- Mock setup longer than test logic
|
||||
- Mocking everything to make test pass
|
||||
- Mocks missing methods real components have
|
||||
- Test breaks when mock changes
|
||||
|
||||
**your human partner's question:** "Do we need to be using a mock here?"
|
||||
|
||||
**Consider:** Integration tests with real components often simpler than complex mocks
|
||||
|
||||
## TDD Prevents These Anti-Patterns
|
||||
|
||||
**Why TDD helps:**
|
||||
1. **Write test first** → Forces you to think about what you're actually testing
|
||||
2. **Watch it fail** → Confirms test tests real behavior, not mocks
|
||||
3. **Minimal implementation** → No test-only methods creep in
|
||||
4. **Real dependencies** → You see what the test actually needs before mocking
|
||||
|
||||
**If you're testing mock behavior, you violated TDD** - you added mocks without watching test fail against real code first.
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Anti-Pattern | Fix |
|
||||
|--------------|-----|
|
||||
| Assert on mock elements | Test real component or unmock it |
|
||||
| Test-only methods in production | Move to test utilities |
|
||||
| Mock without understanding | Understand dependencies first, mock minimally |
|
||||
| Incomplete mocks | Mirror real API completely |
|
||||
| Tests as afterthought | TDD - tests first |
|
||||
| Over-complex mocks | Consider integration tests |
|
||||
|
||||
## Red Flags
|
||||
|
||||
- Assertion checks for `*-mock` test IDs
|
||||
- Methods only called in test files
|
||||
- Mock setup is >50% of test
|
||||
- Test fails when you remove mock
|
||||
- Can't explain why mock is needed
|
||||
- Mocking "just to be safe"
|
||||
|
||||
## The Bottom Line
|
||||
|
||||
**Mocks are tools to isolate, not things to test.**
|
||||
|
||||
If TDD reveals you're testing mock behavior, you've gone wrong.
|
||||
|
||||
Fix: Test real behavior or question why you're mocking at all.
|
||||
218
.claude/skills/using-git-worktrees/SKILL.md
Normal file
218
.claude/skills/using-git-worktrees/SKILL.md
Normal file
@@ -0,0 +1,218 @@
|
||||
---
|
||||
name: sup-using-git-worktrees
|
||||
description: Use when starting feature work that needs isolation from current workspace or before executing implementation plans - creates isolated git worktrees with smart directory selection and safety verification
|
||||
---
|
||||
|
||||
# Using Git Worktrees
|
||||
|
||||
## Overview
|
||||
|
||||
Git worktrees create isolated workspaces sharing the same repository, allowing work on multiple branches simultaneously without switching.
|
||||
|
||||
**Core principle:** Systematic directory selection + safety verification = reliable isolation.
|
||||
|
||||
**Announce at start:** "I'm using the using-git-worktrees skill to set up an isolated workspace."
|
||||
|
||||
## Directory Selection Process
|
||||
|
||||
Follow this priority order:
|
||||
|
||||
### 1. Check Existing Directories
|
||||
|
||||
```bash
|
||||
# Check in priority order
|
||||
ls -d .worktrees 2>/dev/null # Preferred (hidden)
|
||||
ls -d worktrees 2>/dev/null # Alternative
|
||||
```
|
||||
|
||||
**If found:** Use that directory. If both exist, `.worktrees` wins.
|
||||
|
||||
### 2. Check CLAUDE.md
|
||||
|
||||
```bash
|
||||
grep -i "worktree.*director" CLAUDE.md 2>/dev/null
|
||||
```
|
||||
|
||||
**If preference specified:** Use it without asking.
|
||||
|
||||
### 3. Ask User
|
||||
|
||||
If no directory exists and no CLAUDE.md preference:
|
||||
|
||||
```
|
||||
No worktree directory found. Where should I create worktrees?
|
||||
|
||||
1. .worktrees/ (project-local, hidden)
|
||||
2. ~/.config/superpowers/worktrees/<project-name>/ (global location)
|
||||
|
||||
Which would you prefer?
|
||||
```
|
||||
|
||||
## Safety Verification
|
||||
|
||||
### For Project-Local Directories (.worktrees or worktrees)
|
||||
|
||||
**MUST verify directory is ignored before creating worktree:**
|
||||
|
||||
```bash
|
||||
# Check if directory is ignored (respects local, global, and system gitignore)
|
||||
git check-ignore -q .worktrees 2>/dev/null || git check-ignore -q worktrees 2>/dev/null
|
||||
```
|
||||
|
||||
**If NOT ignored:**
|
||||
|
||||
Per Jesse's rule "Fix broken things immediately":
|
||||
1. Add appropriate line to .gitignore
|
||||
2. Commit the change
|
||||
3. Proceed with worktree creation
|
||||
|
||||
**Why critical:** Prevents accidentally committing worktree contents to repository.
|
||||
|
||||
### For Global Directory (~/.config/superpowers/worktrees)
|
||||
|
||||
No .gitignore verification needed - outside project entirely.
|
||||
|
||||
## Creation Steps
|
||||
|
||||
### 1. Detect Project Name
|
||||
|
||||
```bash
|
||||
project=$(basename "$(git rev-parse --show-toplevel)")
|
||||
```
|
||||
|
||||
### 2. Create Worktree
|
||||
|
||||
```bash
|
||||
# Determine full path
|
||||
case $LOCATION in
|
||||
.worktrees|worktrees)
|
||||
path="$LOCATION/$BRANCH_NAME"
|
||||
;;
|
||||
~/.config/superpowers/worktrees/*)
|
||||
path="~/.config/superpowers/worktrees/$project/$BRANCH_NAME"
|
||||
;;
|
||||
esac
|
||||
|
||||
# Create worktree with new branch
|
||||
git worktree add "$path" -b "$BRANCH_NAME"
|
||||
cd "$path"
|
||||
```
|
||||
|
||||
### 3. Run Project Setup
|
||||
|
||||
Auto-detect and run appropriate setup:
|
||||
|
||||
```bash
|
||||
# Node.js
|
||||
if [ -f package.json ]; then npm install; fi
|
||||
|
||||
# Rust
|
||||
if [ -f Cargo.toml ]; then cargo build; fi
|
||||
|
||||
# Python
|
||||
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
|
||||
if [ -f pyproject.toml ]; then poetry install; fi
|
||||
|
||||
# Go
|
||||
if [ -f go.mod ]; then go mod download; fi
|
||||
```
|
||||
|
||||
### 4. Verify Clean Baseline
|
||||
|
||||
Run tests to ensure worktree starts clean:
|
||||
|
||||
```bash
|
||||
# Examples - use project-appropriate command
|
||||
npm test
|
||||
cargo test
|
||||
pytest
|
||||
go test ./...
|
||||
```
|
||||
|
||||
**If tests fail:** Report failures, ask whether to proceed or investigate.
|
||||
|
||||
**If tests pass:** Report ready.
|
||||
|
||||
### 5. Report Location
|
||||
|
||||
```
|
||||
Worktree ready at <full-path>
|
||||
Tests passing (<N> tests, 0 failures)
|
||||
Ready to implement <feature-name>
|
||||
```
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Situation | Action |
|
||||
|-----------|--------|
|
||||
| `.worktrees/` exists | Use it (verify ignored) |
|
||||
| `worktrees/` exists | Use it (verify ignored) |
|
||||
| Both exist | Use `.worktrees/` |
|
||||
| Neither exists | Check CLAUDE.md → Ask user |
|
||||
| Directory not ignored | Add to .gitignore + commit |
|
||||
| Tests fail during baseline | Report failures + ask |
|
||||
| No package.json/Cargo.toml | Skip dependency install |
|
||||
|
||||
## Common Mistakes
|
||||
|
||||
### Skipping ignore verification
|
||||
|
||||
- **Problem:** Worktree contents get tracked, pollute git status
|
||||
- **Fix:** Always use `git check-ignore` before creating project-local worktree
|
||||
|
||||
### Assuming directory location
|
||||
|
||||
- **Problem:** Creates inconsistency, violates project conventions
|
||||
- **Fix:** Follow priority: existing > CLAUDE.md > ask
|
||||
|
||||
### Proceeding with failing tests
|
||||
|
||||
- **Problem:** Can't distinguish new bugs from pre-existing issues
|
||||
- **Fix:** Report failures, get explicit permission to proceed
|
||||
|
||||
### Hardcoding setup commands
|
||||
|
||||
- **Problem:** Breaks on projects using different tools
|
||||
- **Fix:** Auto-detect from project files (package.json, etc.)
|
||||
|
||||
## Example Workflow
|
||||
|
||||
```
|
||||
You: I'm using the using-git-worktrees skill to set up an isolated workspace.
|
||||
|
||||
[Check .worktrees/ - exists]
|
||||
[Verify ignored - git check-ignore confirms .worktrees/ is ignored]
|
||||
[Create worktree: git worktree add .worktrees/auth -b feature/auth]
|
||||
[Run npm install]
|
||||
[Run npm test - 47 passing]
|
||||
|
||||
Worktree ready at /Users/jesse/myproject/.worktrees/auth
|
||||
Tests passing (47 tests, 0 failures)
|
||||
Ready to implement auth feature
|
||||
```
|
||||
|
||||
## Red Flags
|
||||
|
||||
**Never:**
|
||||
- Create worktree without verifying it's ignored (project-local)
|
||||
- Skip baseline test verification
|
||||
- Proceed with failing tests without asking
|
||||
- Assume directory location when ambiguous
|
||||
- Skip CLAUDE.md check
|
||||
|
||||
**Always:**
|
||||
- Follow directory priority: existing > CLAUDE.md > ask
|
||||
- Verify directory is ignored for project-local
|
||||
- Auto-detect and run project setup
|
||||
- Verify clean test baseline
|
||||
|
||||
## Integration
|
||||
|
||||
**Called by:**
|
||||
- **brainstorming** (Phase 4) - REQUIRED when design is approved and implementation follows
|
||||
- **subagent-driven-development** - REQUIRED before executing any tasks
|
||||
- **executing-plans** - REQUIRED before executing any tasks
|
||||
- Any skill needing isolated workspace
|
||||
|
||||
**Pairs with:**
|
||||
- **finishing-a-development-branch** - REQUIRED for cleanup after work complete
|
||||
117
.claude/skills/using-superpowers/SKILL.md
Normal file
117
.claude/skills/using-superpowers/SKILL.md
Normal file
@@ -0,0 +1,117 @@
|
||||
---
|
||||
name: sup-using-superpowers
|
||||
description: Use when starting any conversation - establishes how to find and use skills, requiring Skill tool invocation before ANY response including clarifying questions
|
||||
---
|
||||
|
||||
<SUBAGENT-STOP>
|
||||
If you were dispatched as a subagent to execute a specific task, skip this skill.
|
||||
</SUBAGENT-STOP>
|
||||
|
||||
<EXTREMELY-IMPORTANT>
|
||||
If you think there is even a 1% chance a skill might apply to what you are doing, you ABSOLUTELY MUST invoke the skill.
|
||||
|
||||
IF A SKILL APPLIES TO YOUR TASK, YOU DO NOT HAVE A CHOICE. YOU MUST USE IT.
|
||||
|
||||
This is not negotiable. This is not optional. You cannot rationalize your way out of this.
|
||||
</EXTREMELY-IMPORTANT>
|
||||
|
||||
## Instruction Priority
|
||||
|
||||
Superpowers skills override default system prompt behavior, but **user instructions always take precedence**:
|
||||
|
||||
1. **User's explicit instructions** (CLAUDE.md, GEMINI.md, AGENTS.md, direct requests) — highest priority
|
||||
2. **Superpowers skills** — override default system behavior where they conflict
|
||||
3. **Default system prompt** — lowest priority
|
||||
|
||||
If CLAUDE.md, GEMINI.md, or AGENTS.md says "don't use TDD" and a skill says "always use TDD," follow the user's instructions. The user is in control.
|
||||
|
||||
## How to Access Skills
|
||||
|
||||
**In Claude Code:** Use the `Skill` tool. When you invoke a skill, its content is loaded and presented to you—follow it directly. Never use the Read tool on skill files.
|
||||
|
||||
**In Copilot CLI:** Use the `skill` tool. Skills are auto-discovered from installed plugins. The `skill` tool works the same as Claude Code's `Skill` tool.
|
||||
|
||||
**In Gemini CLI:** Skills activate via the `activate_skill` tool. Gemini loads skill metadata at session start and activates the full content on demand.
|
||||
|
||||
**In other environments:** Check your platform's documentation for how skills are loaded.
|
||||
|
||||
## Platform Adaptation
|
||||
|
||||
Skills use Claude Code tool names. Non-CC platforms: see `references/copilot-tools.md` (Copilot CLI), `references/codex-tools.md` (Codex) for tool equivalents. Gemini CLI users get the tool mapping loaded automatically via GEMINI.md.
|
||||
|
||||
# Using Skills
|
||||
|
||||
## The Rule
|
||||
|
||||
**Invoke relevant or requested skills BEFORE any response or action.** Even a 1% chance a skill might apply means that you should invoke the skill to check. If an invoked skill turns out to be wrong for the situation, you don't need to use it.
|
||||
|
||||
```dot
|
||||
digraph skill_flow {
|
||||
"User message received" [shape=doublecircle];
|
||||
"About to EnterPlanMode?" [shape=doublecircle];
|
||||
"Already brainstormed?" [shape=diamond];
|
||||
"Invoke brainstorming skill" [shape=box];
|
||||
"Might any skill apply?" [shape=diamond];
|
||||
"Invoke Skill tool" [shape=box];
|
||||
"Announce: 'Using [skill] to [purpose]'" [shape=box];
|
||||
"Has checklist?" [shape=diamond];
|
||||
"Create TodoWrite todo per item" [shape=box];
|
||||
"Follow skill exactly" [shape=box];
|
||||
"Respond (including clarifications)" [shape=doublecircle];
|
||||
|
||||
"About to EnterPlanMode?" -> "Already brainstormed?";
|
||||
"Already brainstormed?" -> "Invoke brainstorming skill" [label="no"];
|
||||
"Already brainstormed?" -> "Might any skill apply?" [label="yes"];
|
||||
"Invoke brainstorming skill" -> "Might any skill apply?";
|
||||
|
||||
"User message received" -> "Might any skill apply?";
|
||||
"Might any skill apply?" -> "Invoke Skill tool" [label="yes, even 1%"];
|
||||
"Might any skill apply?" -> "Respond (including clarifications)" [label="definitely not"];
|
||||
"Invoke Skill tool" -> "Announce: 'Using [skill] to [purpose]'";
|
||||
"Announce: 'Using [skill] to [purpose]'" -> "Has checklist?";
|
||||
"Has checklist?" -> "Create TodoWrite todo per item" [label="yes"];
|
||||
"Has checklist?" -> "Follow skill exactly" [label="no"];
|
||||
"Create TodoWrite todo per item" -> "Follow skill exactly";
|
||||
}
|
||||
```
|
||||
|
||||
## Red Flags
|
||||
|
||||
These thoughts mean STOP—you're rationalizing:
|
||||
|
||||
| Thought | Reality |
|
||||
|---------|---------|
|
||||
| "This is just a simple question" | Questions are tasks. Check for skills. |
|
||||
| "I need more context first" | Skill check comes BEFORE clarifying questions. |
|
||||
| "Let me explore the codebase first" | Skills tell you HOW to explore. Check first. |
|
||||
| "I can check git/files quickly" | Files lack conversation context. Check for skills. |
|
||||
| "Let me gather information first" | Skills tell you HOW to gather information. |
|
||||
| "This doesn't need a formal skill" | If a skill exists, use it. |
|
||||
| "I remember this skill" | Skills evolve. Read current version. |
|
||||
| "This doesn't count as a task" | Action = task. Check for skills. |
|
||||
| "The skill is overkill" | Simple things become complex. Use it. |
|
||||
| "I'll just do this one thing first" | Check BEFORE doing anything. |
|
||||
| "This feels productive" | Undisciplined action wastes time. Skills prevent this. |
|
||||
| "I know what that means" | Knowing the concept ≠ using the skill. Invoke it. |
|
||||
|
||||
## Skill Priority
|
||||
|
||||
When multiple skills could apply, use this order:
|
||||
|
||||
1. **Process skills first** (brainstorming, debugging) - these determine HOW to approach the task
|
||||
2. **Implementation skills second** (frontend-design, mcp-builder) - these guide execution
|
||||
|
||||
"Let's build X" → brainstorming first, then implementation skills.
|
||||
"Fix this bug" → debugging first, then domain-specific skills.
|
||||
|
||||
## Skill Types
|
||||
|
||||
**Rigid** (TDD, debugging): Follow exactly. Don't adapt away discipline.
|
||||
|
||||
**Flexible** (patterns): Adapt principles to context.
|
||||
|
||||
The skill itself tells you which.
|
||||
|
||||
## User Instructions
|
||||
|
||||
Instructions say WHAT, not HOW. "Add X" or "Fix Y" doesn't mean skip workflows.
|
||||
100
.claude/skills/using-superpowers/references/codex-tools.md
Normal file
100
.claude/skills/using-superpowers/references/codex-tools.md
Normal file
@@ -0,0 +1,100 @@
|
||||
# Codex Tool Mapping
|
||||
|
||||
Skills use Claude Code tool names. When you encounter these in a skill, use your platform equivalent:
|
||||
|
||||
| Skill references | Codex equivalent |
|
||||
|-----------------|------------------|
|
||||
| `Task` tool (dispatch subagent) | `spawn_agent` (see [Named agent dispatch](#named-agent-dispatch)) |
|
||||
| Multiple `Task` calls (parallel) | Multiple `spawn_agent` calls |
|
||||
| Task returns result | `wait` |
|
||||
| Task completes automatically | `close_agent` to free slot |
|
||||
| `TodoWrite` (task tracking) | `update_plan` |
|
||||
| `Skill` tool (invoke a skill) | Skills load natively — just follow the instructions |
|
||||
| `Read`, `Write`, `Edit` (files) | Use your native file tools |
|
||||
| `Bash` (run commands) | Use your native shell tools |
|
||||
|
||||
## Subagent dispatch requires multi-agent support
|
||||
|
||||
Add to your Codex config (`~/.codex/config.toml`):
|
||||
|
||||
```toml
|
||||
[features]
|
||||
multi_agent = true
|
||||
```
|
||||
|
||||
This enables `spawn_agent`, `wait`, and `close_agent` for skills like `dispatching-parallel-agents` and `subagent-driven-development`.
|
||||
|
||||
## Named agent dispatch
|
||||
|
||||
Claude Code skills reference named agent types like `superpowers:code-reviewer`.
|
||||
Codex does not have a named agent registry — `spawn_agent` creates generic agents
|
||||
from built-in roles (`default`, `explorer`, `worker`).
|
||||
|
||||
When a skill says to dispatch a named agent type:
|
||||
|
||||
1. Find the agent's prompt file (e.g., `agents/code-reviewer.md` or the skill's
|
||||
local prompt template like `code-quality-reviewer-prompt.md`)
|
||||
2. Read the prompt content
|
||||
3. Fill any template placeholders (`{BASE_SHA}`, `{WHAT_WAS_IMPLEMENTED}`, etc.)
|
||||
4. Spawn a `worker` agent with the filled content as the `message`
|
||||
|
||||
| Skill instruction | Codex equivalent |
|
||||
|-------------------|------------------|
|
||||
| `Task tool (superpowers:code-reviewer)` | `spawn_agent(agent_type="worker", message=...)` with `code-reviewer.md` content |
|
||||
| `Task tool (general-purpose)` with inline prompt | `spawn_agent(message=...)` with the same prompt |
|
||||
|
||||
### Message framing
|
||||
|
||||
The `message` parameter is user-level input, not a system prompt. Structure it
|
||||
for maximum instruction adherence:
|
||||
|
||||
```
|
||||
Your task is to perform the following. Follow the instructions below exactly.
|
||||
|
||||
<agent-instructions>
|
||||
[filled prompt content from the agent's .md file]
|
||||
</agent-instructions>
|
||||
|
||||
Execute this now. Output ONLY the structured response following the format
|
||||
specified in the instructions above.
|
||||
```
|
||||
|
||||
- Use task-delegation framing ("Your task is...") rather than persona framing ("You are...")
|
||||
- Wrap instructions in XML tags — the model treats tagged blocks as authoritative
|
||||
- End with an explicit execution directive to prevent summarization of the instructions
|
||||
|
||||
### When this workaround can be removed
|
||||
|
||||
This approach compensates for Codex's plugin system not yet supporting an `agents`
|
||||
field in `plugin.json`. When `RawPluginManifest` gains an `agents` field, the
|
||||
plugin can symlink to `agents/` (mirroring the existing `skills/` symlink) and
|
||||
skills can dispatch named agent types directly.
|
||||
|
||||
## Environment Detection
|
||||
|
||||
Skills that create worktrees or finish branches should detect their
|
||||
environment with read-only git commands before proceeding:
|
||||
|
||||
```bash
|
||||
GIT_DIR=$(cd "$(git rev-parse --git-dir)" 2>/dev/null && pwd -P)
|
||||
GIT_COMMON=$(cd "$(git rev-parse --git-common-dir)" 2>/dev/null && pwd -P)
|
||||
BRANCH=$(git branch --show-current)
|
||||
```
|
||||
|
||||
- `GIT_DIR != GIT_COMMON` → already in a linked worktree (skip creation)
|
||||
- `BRANCH` empty → detached HEAD (cannot branch/push/PR from sandbox)
|
||||
|
||||
See `using-git-worktrees` Step 0 and `finishing-a-development-branch`
|
||||
Step 1 for how each skill uses these signals.
|
||||
|
||||
## Codex App Finishing
|
||||
|
||||
When the sandbox blocks branch/push operations (detached HEAD in an
|
||||
externally managed worktree), the agent commits all work and informs
|
||||
the user to use the App's native controls:
|
||||
|
||||
- **"Create branch"** — names the branch, then commit/push/PR via App UI
|
||||
- **"Hand off to local"** — transfers work to the user's local checkout
|
||||
|
||||
The agent can still run tests, stage files, and output suggested branch
|
||||
names, commit messages, and PR descriptions for the user to copy.
|
||||
52
.claude/skills/using-superpowers/references/copilot-tools.md
Normal file
52
.claude/skills/using-superpowers/references/copilot-tools.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Copilot CLI Tool Mapping
|
||||
|
||||
Skills use Claude Code tool names. When you encounter these in a skill, use your platform equivalent:
|
||||
|
||||
| Skill references | Copilot CLI equivalent |
|
||||
|-----------------|----------------------|
|
||||
| `Read` (file reading) | `view` |
|
||||
| `Write` (file creation) | `create` |
|
||||
| `Edit` (file editing) | `edit` |
|
||||
| `Bash` (run commands) | `bash` |
|
||||
| `Grep` (search file content) | `grep` |
|
||||
| `Glob` (search files by name) | `glob` |
|
||||
| `Skill` tool (invoke a skill) | `skill` |
|
||||
| `WebFetch` | `web_fetch` |
|
||||
| `Task` tool (dispatch subagent) | `task` (see [Agent types](#agent-types)) |
|
||||
| Multiple `Task` calls (parallel) | Multiple `task` calls |
|
||||
| Task status/output | `read_agent`, `list_agents` |
|
||||
| `TodoWrite` (task tracking) | `sql` with built-in `todos` table |
|
||||
| `WebSearch` | No equivalent — use `web_fetch` with a search engine URL |
|
||||
| `EnterPlanMode` / `ExitPlanMode` | No equivalent — stay in the main session |
|
||||
|
||||
## Agent types
|
||||
|
||||
Copilot CLI's `task` tool accepts an `agent_type` parameter:
|
||||
|
||||
| Claude Code agent | Copilot CLI equivalent |
|
||||
|-------------------|----------------------|
|
||||
| `general-purpose` | `"general-purpose"` |
|
||||
| `Explore` | `"explore"` |
|
||||
| Named plugin agents (e.g. `superpowers:code-reviewer`) | Discovered automatically from installed plugins |
|
||||
|
||||
## Async shell sessions
|
||||
|
||||
Copilot CLI supports persistent async shell sessions, which have no direct Claude Code equivalent:
|
||||
|
||||
| Tool | Purpose |
|
||||
|------|---------|
|
||||
| `bash` with `async: true` | Start a long-running command in the background |
|
||||
| `write_bash` | Send input to a running async session |
|
||||
| `read_bash` | Read output from an async session |
|
||||
| `stop_bash` | Terminate an async session |
|
||||
| `list_bash` | List all active shell sessions |
|
||||
|
||||
## Additional Copilot CLI tools
|
||||
|
||||
| Tool | Purpose |
|
||||
|------|---------|
|
||||
| `store_memory` | Persist facts about the codebase for future sessions |
|
||||
| `report_intent` | Update the UI status line with current intent |
|
||||
| `sql` | Query the session's SQLite database (todos, metadata) |
|
||||
| `fetch_copilot_cli_documentation` | Look up Copilot CLI documentation |
|
||||
| GitHub MCP tools (`github-mcp-server-*`) | Native GitHub API access (issues, PRs, code search) |
|
||||
33
.claude/skills/using-superpowers/references/gemini-tools.md
Normal file
33
.claude/skills/using-superpowers/references/gemini-tools.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Gemini CLI Tool Mapping
|
||||
|
||||
Skills use Claude Code tool names. When you encounter these in a skill, use your platform equivalent:
|
||||
|
||||
| Skill references | Gemini CLI equivalent |
|
||||
|-----------------|----------------------|
|
||||
| `Read` (file reading) | `read_file` |
|
||||
| `Write` (file creation) | `write_file` |
|
||||
| `Edit` (file editing) | `replace` |
|
||||
| `Bash` (run commands) | `run_shell_command` |
|
||||
| `Grep` (search file content) | `grep_search` |
|
||||
| `Glob` (search files by name) | `glob` |
|
||||
| `TodoWrite` (task tracking) | `write_todos` |
|
||||
| `Skill` tool (invoke a skill) | `activate_skill` |
|
||||
| `WebSearch` | `google_web_search` |
|
||||
| `WebFetch` | `web_fetch` |
|
||||
| `Task` tool (dispatch subagent) | No equivalent — Gemini CLI does not support subagents |
|
||||
|
||||
## No subagent support
|
||||
|
||||
Gemini CLI has no equivalent to Claude Code's `Task` tool. Skills that rely on subagent dispatch (`subagent-driven-development`, `dispatching-parallel-agents`) will fall back to single-session execution via `executing-plans`.
|
||||
|
||||
## Additional Gemini CLI tools
|
||||
|
||||
These tools are available in Gemini CLI but have no Claude Code equivalent:
|
||||
|
||||
| Tool | Purpose |
|
||||
|------|---------|
|
||||
| `list_directory` | List files and subdirectories |
|
||||
| `save_memory` | Persist facts to GEMINI.md across sessions |
|
||||
| `ask_user` | Request structured input from the user |
|
||||
| `tracker_create_task` | Rich task management (create, update, list, visualize) |
|
||||
| `enter_plan_mode` / `exit_plan_mode` | Switch to read-only research mode before making changes |
|
||||
139
.claude/skills/verification-before-completion/SKILL.md
Normal file
139
.claude/skills/verification-before-completion/SKILL.md
Normal file
@@ -0,0 +1,139 @@
|
||||
---
|
||||
name: sup-verification-before-completion
|
||||
description: Use when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions always
|
||||
---
|
||||
|
||||
# Verification Before Completion
|
||||
|
||||
## Overview
|
||||
|
||||
Claiming work is complete without verification is dishonesty, not efficiency.
|
||||
|
||||
**Core principle:** Evidence before claims, always.
|
||||
|
||||
**Violating the letter of this rule is violating the spirit of this rule.**
|
||||
|
||||
## The Iron Law
|
||||
|
||||
```
|
||||
NO COMPLETION CLAIMS WITHOUT FRESH VERIFICATION EVIDENCE
|
||||
```
|
||||
|
||||
If you haven't run the verification command in this message, you cannot claim it passes.
|
||||
|
||||
## The Gate Function
|
||||
|
||||
```
|
||||
BEFORE claiming any status or expressing satisfaction:
|
||||
|
||||
1. IDENTIFY: What command proves this claim?
|
||||
2. RUN: Execute the FULL command (fresh, complete)
|
||||
3. READ: Full output, check exit code, count failures
|
||||
4. VERIFY: Does output confirm the claim?
|
||||
- If NO: State actual status with evidence
|
||||
- If YES: State claim WITH evidence
|
||||
5. ONLY THEN: Make the claim
|
||||
|
||||
Skip any step = lying, not verifying
|
||||
```
|
||||
|
||||
## Common Failures
|
||||
|
||||
| Claim | Requires | Not Sufficient |
|
||||
|-------|----------|----------------|
|
||||
| Tests pass | Test command output: 0 failures | Previous run, "should pass" |
|
||||
| Linter clean | Linter output: 0 errors | Partial check, extrapolation |
|
||||
| Build succeeds | Build command: exit 0 | Linter passing, logs look good |
|
||||
| Bug fixed | Test original symptom: passes | Code changed, assumed fixed |
|
||||
| Regression test works | Red-green cycle verified | Test passes once |
|
||||
| Agent completed | VCS diff shows changes | Agent reports "success" |
|
||||
| Requirements met | Line-by-line checklist | Tests passing |
|
||||
|
||||
## Red Flags - STOP
|
||||
|
||||
- Using "should", "probably", "seems to"
|
||||
- Expressing satisfaction before verification ("Great!", "Perfect!", "Done!", etc.)
|
||||
- About to commit/push/PR without verification
|
||||
- Trusting agent success reports
|
||||
- Relying on partial verification
|
||||
- Thinking "just this once"
|
||||
- Tired and wanting work over
|
||||
- **ANY wording implying success without having run verification**
|
||||
|
||||
## Rationalization Prevention
|
||||
|
||||
| Excuse | Reality |
|
||||
|--------|---------|
|
||||
| "Should work now" | RUN the verification |
|
||||
| "I'm confident" | Confidence ≠ evidence |
|
||||
| "Just this once" | No exceptions |
|
||||
| "Linter passed" | Linter ≠ compiler |
|
||||
| "Agent said success" | Verify independently |
|
||||
| "I'm tired" | Exhaustion ≠ excuse |
|
||||
| "Partial check is enough" | Partial proves nothing |
|
||||
| "Different words so rule doesn't apply" | Spirit over letter |
|
||||
|
||||
## Key Patterns
|
||||
|
||||
**Tests:**
|
||||
```
|
||||
✅ [Run test command] [See: 34/34 pass] "All tests pass"
|
||||
❌ "Should pass now" / "Looks correct"
|
||||
```
|
||||
|
||||
**Regression tests (TDD Red-Green):**
|
||||
```
|
||||
✅ Write → Run (pass) → Revert fix → Run (MUST FAIL) → Restore → Run (pass)
|
||||
❌ "I've written a regression test" (without red-green verification)
|
||||
```
|
||||
|
||||
**Build:**
|
||||
```
|
||||
✅ [Run build] [See: exit 0] "Build passes"
|
||||
❌ "Linter passed" (linter doesn't check compilation)
|
||||
```
|
||||
|
||||
**Requirements:**
|
||||
```
|
||||
✅ Re-read plan → Create checklist → Verify each → Report gaps or completion
|
||||
❌ "Tests pass, phase complete"
|
||||
```
|
||||
|
||||
**Agent delegation:**
|
||||
```
|
||||
✅ Agent reports success → Check VCS diff → Verify changes → Report actual state
|
||||
❌ Trust agent report
|
||||
```
|
||||
|
||||
## Why This Matters
|
||||
|
||||
From 24 failure memories:
|
||||
- your human partner said "I don't believe you" - trust broken
|
||||
- Undefined functions shipped - would crash
|
||||
- Missing requirements shipped - incomplete features
|
||||
- Time wasted on false completion → redirect → rework
|
||||
- Violates: "Honesty is a core value. If you lie, you'll be replaced."
|
||||
|
||||
## When To Apply
|
||||
|
||||
**ALWAYS before:**
|
||||
- ANY variation of success/completion claims
|
||||
- ANY expression of satisfaction
|
||||
- ANY positive statement about work state
|
||||
- Committing, PR creation, task completion
|
||||
- Moving to next task
|
||||
- Delegating to agents
|
||||
|
||||
**Rule applies to:**
|
||||
- Exact phrases
|
||||
- Paraphrases and synonyms
|
||||
- Implications of success
|
||||
- ANY communication suggesting completion/correctness
|
||||
|
||||
## The Bottom Line
|
||||
|
||||
**No shortcuts for verification.**
|
||||
|
||||
Run the command. Read the output. THEN claim the result.
|
||||
|
||||
This is non-negotiable.
|
||||
116
.claude/skills/write-docs/SKILL.md
Normal file
116
.claude/skills/write-docs/SKILL.md
Normal file
@@ -0,0 +1,116 @@
|
||||
---
|
||||
name: write-docs
|
||||
description: Write BrowserOS feature documentation. Use when the user wants to create or update documentation for a BrowserOS feature. This skill explores the codebase to understand features and writes concise Mintlify MDX docs.
|
||||
allowed-tools: Read, Grep, Glob, Bash, Task, Write, Edit
|
||||
---
|
||||
|
||||
# Write BrowserOS Documentation
|
||||
|
||||
This skill helps write documentation for BrowserOS features. It follows a structured workflow to create high-quality, concise documentation pages.
|
||||
|
||||
## Workflow
|
||||
|
||||
### Step 1: Understand the Feature
|
||||
|
||||
Before writing documentation, explore the codebase to understand the feature:
|
||||
|
||||
1. **Ask the user** which feature they want to document
|
||||
2. **Search the codebase** at `../browseros-server` (sibling directory) to find relevant code:
|
||||
- Use `Grep` to search for feature-related keywords
|
||||
- Use `Glob` to find relevant files
|
||||
- Read key files to understand how the feature works
|
||||
3. **Identify key aspects**:
|
||||
- What problem does this feature solve?
|
||||
- How does the user enable/configure it?
|
||||
- What are the main use cases?
|
||||
|
||||
### Step 2: Gather Screenshots
|
||||
|
||||
Ask the user to provide screenshots for the documentation:
|
||||
|
||||
1. Tell the user: "Please copy a screenshot to your clipboard (Cmd+C) that shows [specific UI element]"
|
||||
2. Run: `python scripts/save_clipboard.py docs/images/<feature-name>.png`
|
||||
3. Repeat for any additional screenshots needed
|
||||
|
||||
### Step 3: Write the Documentation
|
||||
|
||||
Create the MDX file at `docs/features/<feature-name>.mdx` (or appropriate location) following this structure:
|
||||
|
||||
```mdx
|
||||
---
|
||||
title: "Feature Name"
|
||||
description: "One sentence describing what this feature does"
|
||||
---
|
||||
|
||||
[Opening paragraph: 1-2 sentences explaining what the feature does and why it matters]
|
||||
|
||||
## How It Works
|
||||
|
||||
[Explain the core mechanics in 2-3 paragraphs max]
|
||||
|
||||
## Getting Started
|
||||
|
||||
[Step-by-step instructions to use the feature]
|
||||
|
||||
1. Step one
|
||||
2. Step two
|
||||
3. Step three
|
||||
|
||||
## [Optional: Additional Sections]
|
||||
|
||||
[Only if necessary - keep the doc to ONE PAGE maximum]
|
||||
```
|
||||
|
||||
### Step 4: Update Navigation
|
||||
|
||||
Add the new page to `docs/docs.json` under the appropriate group in the `navigation.groups` array.
|
||||
|
||||
### Step 5: Preview
|
||||
|
||||
Tell the user to run `mint dev` in the `docs/` directory to preview the documentation.
|
||||
|
||||
## Documentation Style Guide
|
||||
|
||||
- **Concise**: Maximum one page length
|
||||
- **Clear**: Write for first-time BrowserOS users
|
||||
- **Practical**: Focus on how to use the feature, not internal implementation details
|
||||
- **Visual**: Use screenshots to show, not just tell
|
||||
- **No fluff**: Skip unnecessary introductions or conclusions
|
||||
|
||||
## Example: Ad Blocking Doc Structure
|
||||
|
||||
```mdx
|
||||
---
|
||||
title: "Ad Blocking"
|
||||
description: "BrowserOS blocks 10x more ads than Chrome out of the box"
|
||||
---
|
||||
|
||||
BrowserOS ships with built-in ad blocking that works immediately—no extensions required.
|
||||
|
||||
## How It Works
|
||||
|
||||
[2-3 paragraphs explaining the mechanics]
|
||||
|
||||
## BrowserOS vs Chrome
|
||||
|
||||
[Comparison with data/screenshots]
|
||||
|
||||
## What This Means
|
||||
|
||||
[1 paragraph on the practical benefits]
|
||||
```
|
||||
|
||||
## Key Directories
|
||||
|
||||
- **Docs location**: `docs/`
|
||||
- **Images**: `docs/images/`
|
||||
- **Feature code**: `../browseros-server/` (sibling directory)
|
||||
- **Config**: `docs/docs.json`
|
||||
|
||||
## Core Features to Document
|
||||
|
||||
The user mentioned these features need documentation:
|
||||
1. BrowserOS MCP Server
|
||||
2. Connecting other MCPs to BrowserOS assistant
|
||||
3. Scheduled tasks
|
||||
4. [Additional features discovered in codebase]
|
||||
152
.claude/skills/writing-plans/SKILL.md
Normal file
152
.claude/skills/writing-plans/SKILL.md
Normal file
@@ -0,0 +1,152 @@
|
||||
---
|
||||
name: sup-writing-plans
|
||||
description: Use when you have a spec or requirements for a multi-step task, before touching code
|
||||
---
|
||||
|
||||
# Writing Plans
|
||||
|
||||
## Overview
|
||||
|
||||
Write comprehensive implementation plans assuming the engineer has zero context for our codebase and questionable taste. Document everything they need to know: which files to touch for each task, code, testing, docs they might need to check, how to test it. Give them the whole plan as bite-sized tasks. DRY. YAGNI. TDD. Frequent commits.
|
||||
|
||||
Assume they are a skilled developer, but know almost nothing about our toolset or problem domain. Assume they don't know good test design very well.
|
||||
|
||||
**Announce at start:** "I'm using the writing-plans skill to create the implementation plan."
|
||||
|
||||
**Context:** This should be run in a dedicated worktree (created by brainstorming skill).
|
||||
|
||||
**Save plans to:** `.llm/plans/YYYY-MM-DD-<feature-name>.md`
|
||||
- (User preferences for plan location override this default)
|
||||
|
||||
## Scope Check
|
||||
|
||||
If the spec covers multiple independent subsystems, it should have been broken into sub-project specs during brainstorming. If it wasn't, suggest breaking this into separate plans — one per subsystem. Each plan should produce working, testable software on its own.
|
||||
|
||||
## File Structure
|
||||
|
||||
Before defining tasks, map out which files will be created or modified and what each one is responsible for. This is where decomposition decisions get locked in.
|
||||
|
||||
- Design units with clear boundaries and well-defined interfaces. Each file should have one clear responsibility.
|
||||
- You reason best about code you can hold in context at once, and your edits are more reliable when files are focused. Prefer smaller, focused files over large ones that do too much.
|
||||
- Files that change together should live together. Split by responsibility, not by technical layer.
|
||||
- In existing codebases, follow established patterns. If the codebase uses large files, don't unilaterally restructure - but if a file you're modifying has grown unwieldy, including a split in the plan is reasonable.
|
||||
|
||||
This structure informs the task decomposition. Each task should produce self-contained changes that make sense independently.
|
||||
|
||||
## Bite-Sized Task Granularity
|
||||
|
||||
**Each step is one action (2-5 minutes):**
|
||||
- "Write the failing test" - step
|
||||
- "Run it to make sure it fails" - step
|
||||
- "Implement the minimal code to make the test pass" - step
|
||||
- "Run the tests and make sure they pass" - step
|
||||
- "Commit" - step
|
||||
|
||||
## Plan Document Header
|
||||
|
||||
**Every plan MUST start with this header:**
|
||||
|
||||
```markdown
|
||||
# [Feature Name] Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** [One sentence describing what this builds]
|
||||
|
||||
**Architecture:** [2-3 sentences about approach]
|
||||
|
||||
**Tech Stack:** [Key technologies/libraries]
|
||||
|
||||
---
|
||||
```
|
||||
|
||||
## Task Structure
|
||||
|
||||
````markdown
|
||||
### Task N: [Component Name]
|
||||
|
||||
**Files:**
|
||||
- Create: `exact/path/to/file.py`
|
||||
- Modify: `exact/path/to/existing.py:123-145`
|
||||
- Test: `tests/exact/path/to/test.py`
|
||||
|
||||
- [ ] **Step 1: Write the failing test**
|
||||
|
||||
```python
|
||||
def test_specific_behavior():
|
||||
result = function(input)
|
||||
assert result == expected
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run test to verify it fails**
|
||||
|
||||
Run: `pytest tests/path/test.py::test_name -v`
|
||||
Expected: FAIL with "function not defined"
|
||||
|
||||
- [ ] **Step 3: Write minimal implementation**
|
||||
|
||||
```python
|
||||
def function(input):
|
||||
return expected
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Run test to verify it passes**
|
||||
|
||||
Run: `pytest tests/path/test.py::test_name -v`
|
||||
Expected: PASS
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add tests/path/test.py src/path/file.py
|
||||
git commit -m "feat: add specific feature"
|
||||
```
|
||||
````
|
||||
|
||||
## No Placeholders
|
||||
|
||||
Every step must contain the actual content an engineer needs. These are **plan failures** — never write them:
|
||||
- "TBD", "TODO", "implement later", "fill in details"
|
||||
- "Add appropriate error handling" / "add validation" / "handle edge cases"
|
||||
- "Write tests for the above" (without actual test code)
|
||||
- "Similar to Task N" (repeat the code — the engineer may be reading tasks out of order)
|
||||
- Steps that describe what to do without showing how (code blocks required for code steps)
|
||||
- References to types, functions, or methods not defined in any task
|
||||
|
||||
## Remember
|
||||
- Exact file paths always
|
||||
- Complete code in every step — if a step changes code, show the code
|
||||
- Exact commands with expected output
|
||||
- DRY, YAGNI, TDD, frequent commits
|
||||
|
||||
## Self-Review
|
||||
|
||||
After writing the complete plan, look at the spec with fresh eyes and check the plan against it. This is a checklist you run yourself — not a subagent dispatch.
|
||||
|
||||
**1. Spec coverage:** Skim each section/requirement in the spec. Can you point to a task that implements it? List any gaps.
|
||||
|
||||
**2. Placeholder scan:** Search your plan for red flags — any of the patterns from the "No Placeholders" section above. Fix them.
|
||||
|
||||
**3. Type consistency:** Do the types, method signatures, and property names you used in later tasks match what you defined in earlier tasks? A function called `clearLayers()` in Task 3 but `clearFullLayers()` in Task 7 is a bug.
|
||||
|
||||
If you find issues, fix them inline. No need to re-review — just fix and move on. If you find a spec requirement with no task, add the task.
|
||||
|
||||
## Execution Handoff
|
||||
|
||||
After saving the plan, offer execution choice:
|
||||
|
||||
**"Plan complete and saved to `.llm/plans/<filename>.md`. Two execution options:**
|
||||
|
||||
**1. Subagent-Driven (recommended)** - I dispatch a fresh subagent per task, review between tasks, fast iteration
|
||||
|
||||
**2. Inline Execution** - Execute tasks in this session using executing-plans, batch execution with checkpoints
|
||||
|
||||
**Which approach?"**
|
||||
|
||||
**If Subagent-Driven chosen:**
|
||||
- **REQUIRED SUB-SKILL:** Use superpowers:subagent-driven-development
|
||||
- Fresh subagent per task + two-stage review
|
||||
|
||||
**If Inline Execution chosen:**
|
||||
- **REQUIRED SUB-SKILL:** Use superpowers:executing-plans
|
||||
- Batch execution with checkpoints for review
|
||||
@@ -0,0 +1,49 @@
|
||||
# Plan Document Reviewer Prompt Template
|
||||
|
||||
Use this template when dispatching a plan document reviewer subagent.
|
||||
|
||||
**Purpose:** Verify the plan is complete, matches the spec, and has proper task decomposition.
|
||||
|
||||
**Dispatch after:** The complete plan is written.
|
||||
|
||||
```
|
||||
Task tool (general-purpose):
|
||||
description: "Review plan document"
|
||||
prompt: |
|
||||
You are a plan document reviewer. Verify this plan is complete and ready for implementation.
|
||||
|
||||
**Plan to review:** [PLAN_FILE_PATH]
|
||||
**Spec for reference:** [SPEC_FILE_PATH]
|
||||
|
||||
## What to Check
|
||||
|
||||
| Category | What to Look For |
|
||||
|----------|------------------|
|
||||
| Completeness | TODOs, placeholders, incomplete tasks, missing steps |
|
||||
| Spec Alignment | Plan covers spec requirements, no major scope creep |
|
||||
| Task Decomposition | Tasks have clear boundaries, steps are actionable |
|
||||
| Buildability | Could an engineer follow this plan without getting stuck? |
|
||||
|
||||
## Calibration
|
||||
|
||||
**Only flag issues that would cause real problems during implementation.**
|
||||
An implementer building the wrong thing or getting stuck is an issue.
|
||||
Minor wording, stylistic preferences, and "nice to have" suggestions are not.
|
||||
|
||||
Approve unless there are serious gaps — missing requirements from the spec,
|
||||
contradictory steps, placeholder content, or tasks so vague they can't be acted on.
|
||||
|
||||
## Output Format
|
||||
|
||||
## Plan Review
|
||||
|
||||
**Status:** Approved | Issues Found
|
||||
|
||||
**Issues (if any):**
|
||||
- [Task X, Step Y]: [specific issue] - [why it matters for implementation]
|
||||
|
||||
**Recommendations (advisory, do not block approval):**
|
||||
- [suggestions for improvement]
|
||||
```
|
||||
|
||||
**Reviewer returns:** Status, Issues (if any), Recommendations
|
||||
655
.claude/skills/writing-skills/SKILL.md
Normal file
655
.claude/skills/writing-skills/SKILL.md
Normal file
@@ -0,0 +1,655 @@
|
||||
---
|
||||
name: sup-writing-skills
|
||||
description: Use when creating new skills, editing existing skills, or verifying skills work before deployment
|
||||
---
|
||||
|
||||
# Writing Skills
|
||||
|
||||
## Overview
|
||||
|
||||
**Writing skills IS Test-Driven Development applied to process documentation.**
|
||||
|
||||
**Personal skills live in agent-specific directories (`~/.claude/skills` for Claude Code, `~/.agents/skills/` for Codex)**
|
||||
|
||||
You write test cases (pressure scenarios with subagents), watch them fail (baseline behavior), write the skill (documentation), watch tests pass (agents comply), and refactor (close loopholes).
|
||||
|
||||
**Core principle:** If you didn't watch an agent fail without the skill, you don't know if the skill teaches the right thing.
|
||||
|
||||
**REQUIRED BACKGROUND:** You MUST understand superpowers:test-driven-development before using this skill. That skill defines the fundamental RED-GREEN-REFACTOR cycle. This skill adapts TDD to documentation.
|
||||
|
||||
**Official guidance:** For Anthropic's official skill authoring best practices, see anthropic-best-practices.md. This document provides additional patterns and guidelines that complement the TDD-focused approach in this skill.
|
||||
|
||||
## What is a Skill?
|
||||
|
||||
A **skill** is a reference guide for proven techniques, patterns, or tools. Skills help future Claude instances find and apply effective approaches.
|
||||
|
||||
**Skills are:** Reusable techniques, patterns, tools, reference guides
|
||||
|
||||
**Skills are NOT:** Narratives about how you solved a problem once
|
||||
|
||||
## TDD Mapping for Skills
|
||||
|
||||
| TDD Concept | Skill Creation |
|
||||
|-------------|----------------|
|
||||
| **Test case** | Pressure scenario with subagent |
|
||||
| **Production code** | Skill document (SKILL.md) |
|
||||
| **Test fails (RED)** | Agent violates rule without skill (baseline) |
|
||||
| **Test passes (GREEN)** | Agent complies with skill present |
|
||||
| **Refactor** | Close loopholes while maintaining compliance |
|
||||
| **Write test first** | Run baseline scenario BEFORE writing skill |
|
||||
| **Watch it fail** | Document exact rationalizations agent uses |
|
||||
| **Minimal code** | Write skill addressing those specific violations |
|
||||
| **Watch it pass** | Verify agent now complies |
|
||||
| **Refactor cycle** | Find new rationalizations → plug → re-verify |
|
||||
|
||||
The entire skill creation process follows RED-GREEN-REFACTOR.
|
||||
|
||||
## When to Create a Skill
|
||||
|
||||
**Create when:**
|
||||
- Technique wasn't intuitively obvious to you
|
||||
- You'd reference this again across projects
|
||||
- Pattern applies broadly (not project-specific)
|
||||
- Others would benefit
|
||||
|
||||
**Don't create for:**
|
||||
- One-off solutions
|
||||
- Standard practices well-documented elsewhere
|
||||
- Project-specific conventions (put in CLAUDE.md)
|
||||
- Mechanical constraints (if it's enforceable with regex/validation, automate it—save documentation for judgment calls)
|
||||
|
||||
## Skill Types
|
||||
|
||||
### Technique
|
||||
Concrete method with steps to follow (condition-based-waiting, root-cause-tracing)
|
||||
|
||||
### Pattern
|
||||
Way of thinking about problems (flatten-with-flags, test-invariants)
|
||||
|
||||
### Reference
|
||||
API docs, syntax guides, tool documentation (office docs)
|
||||
|
||||
## Directory Structure
|
||||
|
||||
|
||||
```
|
||||
skills/
|
||||
skill-name/
|
||||
SKILL.md # Main reference (required)
|
||||
supporting-file.* # Only if needed
|
||||
```
|
||||
|
||||
**Flat namespace** - all skills in one searchable namespace
|
||||
|
||||
**Separate files for:**
|
||||
1. **Heavy reference** (100+ lines) - API docs, comprehensive syntax
|
||||
2. **Reusable tools** - Scripts, utilities, templates
|
||||
|
||||
**Keep inline:**
|
||||
- Principles and concepts
|
||||
- Code patterns (< 50 lines)
|
||||
- Everything else
|
||||
|
||||
## SKILL.md Structure
|
||||
|
||||
**Frontmatter (YAML):**
|
||||
- Two required fields: `name` and `description` (see [agentskills.io/specification](https://agentskills.io/specification) for all supported fields)
|
||||
- Max 1024 characters total
|
||||
- `name`: Use letters, numbers, and hyphens only (no parentheses, special chars)
|
||||
- `description`: Third-person, describes ONLY when to use (NOT what it does)
|
||||
- Start with "Use when..." to focus on triggering conditions
|
||||
- Include specific symptoms, situations, and contexts
|
||||
- **NEVER summarize the skill's process or workflow** (see CSO section for why)
|
||||
- Keep under 500 characters if possible
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: Skill-Name-With-Hyphens
|
||||
description: Use when [specific triggering conditions and symptoms]
|
||||
---
|
||||
|
||||
# Skill Name
|
||||
|
||||
## Overview
|
||||
What is this? Core principle in 1-2 sentences.
|
||||
|
||||
## When to Use
|
||||
[Small inline flowchart IF decision non-obvious]
|
||||
|
||||
Bullet list with SYMPTOMS and use cases
|
||||
When NOT to use
|
||||
|
||||
## Core Pattern (for techniques/patterns)
|
||||
Before/after code comparison
|
||||
|
||||
## Quick Reference
|
||||
Table or bullets for scanning common operations
|
||||
|
||||
## Implementation
|
||||
Inline code for simple patterns
|
||||
Link to file for heavy reference or reusable tools
|
||||
|
||||
## Common Mistakes
|
||||
What goes wrong + fixes
|
||||
|
||||
## Real-World Impact (optional)
|
||||
Concrete results
|
||||
```
|
||||
|
||||
|
||||
## Claude Search Optimization (CSO)
|
||||
|
||||
**Critical for discovery:** Future Claude needs to FIND your skill
|
||||
|
||||
### 1. Rich Description Field
|
||||
|
||||
**Purpose:** Claude reads description to decide which skills to load for a given task. Make it answer: "Should I read this skill right now?"
|
||||
|
||||
**Format:** Start with "Use when..." to focus on triggering conditions
|
||||
|
||||
**CRITICAL: Description = When to Use, NOT What the Skill Does**
|
||||
|
||||
The description should ONLY describe triggering conditions. Do NOT summarize the skill's process or workflow in the description.
|
||||
|
||||
**Why this matters:** Testing revealed that when a description summarizes the skill's workflow, Claude may follow the description instead of reading the full skill content. A description saying "code review between tasks" caused Claude to do ONE review, even though the skill's flowchart clearly showed TWO reviews (spec compliance then code quality).
|
||||
|
||||
When the description was changed to just "Use when executing implementation plans with independent tasks" (no workflow summary), Claude correctly read the flowchart and followed the two-stage review process.
|
||||
|
||||
**The trap:** Descriptions that summarize workflow create a shortcut Claude will take. The skill body becomes documentation Claude skips.
|
||||
|
||||
```yaml
|
||||
# ❌ BAD: Summarizes workflow - Claude may follow this instead of reading skill
|
||||
description: Use when executing plans - dispatches subagent per task with code review between tasks
|
||||
|
||||
# ❌ BAD: Too much process detail
|
||||
description: Use for TDD - write test first, watch it fail, write minimal code, refactor
|
||||
|
||||
# ✅ GOOD: Just triggering conditions, no workflow summary
|
||||
description: Use when executing implementation plans with independent tasks in the current session
|
||||
|
||||
# ✅ GOOD: Triggering conditions only
|
||||
description: Use when implementing any feature or bugfix, before writing implementation code
|
||||
```
|
||||
|
||||
**Content:**
|
||||
- Use concrete triggers, symptoms, and situations that signal this skill applies
|
||||
- Describe the *problem* (race conditions, inconsistent behavior) not *language-specific symptoms* (setTimeout, sleep)
|
||||
- Keep triggers technology-agnostic unless the skill itself is technology-specific
|
||||
- If skill is technology-specific, make that explicit in the trigger
|
||||
- Write in third person (injected into system prompt)
|
||||
- **NEVER summarize the skill's process or workflow**
|
||||
|
||||
```yaml
|
||||
# ❌ BAD: Too abstract, vague, doesn't include when to use
|
||||
description: For async testing
|
||||
|
||||
# ❌ BAD: First person
|
||||
description: I can help you with async tests when they're flaky
|
||||
|
||||
# ❌ BAD: Mentions technology but skill isn't specific to it
|
||||
description: Use when tests use setTimeout/sleep and are flaky
|
||||
|
||||
# ✅ GOOD: Starts with "Use when", describes problem, no workflow
|
||||
description: Use when tests have race conditions, timing dependencies, or pass/fail inconsistently
|
||||
|
||||
# ✅ GOOD: Technology-specific skill with explicit trigger
|
||||
description: Use when using React Router and handling authentication redirects
|
||||
```
|
||||
|
||||
### 2. Keyword Coverage
|
||||
|
||||
Use words Claude would search for:
|
||||
- Error messages: "Hook timed out", "ENOTEMPTY", "race condition"
|
||||
- Symptoms: "flaky", "hanging", "zombie", "pollution"
|
||||
- Synonyms: "timeout/hang/freeze", "cleanup/teardown/afterEach"
|
||||
- Tools: Actual commands, library names, file types
|
||||
|
||||
### 3. Descriptive Naming
|
||||
|
||||
**Use active voice, verb-first:**
|
||||
- ✅ `creating-skills` not `skill-creation`
|
||||
- ✅ `condition-based-waiting` not `async-test-helpers`
|
||||
|
||||
### 4. Token Efficiency (Critical)
|
||||
|
||||
**Problem:** getting-started and frequently-referenced skills load into EVERY conversation. Every token counts.
|
||||
|
||||
**Target word counts:**
|
||||
- getting-started workflows: <150 words each
|
||||
- Frequently-loaded skills: <200 words total
|
||||
- Other skills: <500 words (still be concise)
|
||||
|
||||
**Techniques:**
|
||||
|
||||
**Move details to tool help:**
|
||||
```bash
|
||||
# ❌ BAD: Document all flags in SKILL.md
|
||||
search-conversations supports --text, --both, --after DATE, --before DATE, --limit N
|
||||
|
||||
# ✅ GOOD: Reference --help
|
||||
search-conversations supports multiple modes and filters. Run --help for details.
|
||||
```
|
||||
|
||||
**Use cross-references:**
|
||||
```markdown
|
||||
# ❌ BAD: Repeat workflow details
|
||||
When searching, dispatch subagent with template...
|
||||
[20 lines of repeated instructions]
|
||||
|
||||
# ✅ GOOD: Reference other skill
|
||||
Always use subagents (50-100x context savings). REQUIRED: Use [other-skill-name] for workflow.
|
||||
```
|
||||
|
||||
**Compress examples:**
|
||||
```markdown
|
||||
# ❌ BAD: Verbose example (42 words)
|
||||
your human partner: "How did we handle authentication errors in React Router before?"
|
||||
You: I'll search past conversations for React Router authentication patterns.
|
||||
[Dispatch subagent with search query: "React Router authentication error handling 401"]
|
||||
|
||||
# ✅ GOOD: Minimal example (20 words)
|
||||
Partner: "How did we handle auth errors in React Router?"
|
||||
You: Searching...
|
||||
[Dispatch subagent → synthesis]
|
||||
```
|
||||
|
||||
**Eliminate redundancy:**
|
||||
- Don't repeat what's in cross-referenced skills
|
||||
- Don't explain what's obvious from command
|
||||
- Don't include multiple examples of same pattern
|
||||
|
||||
**Verification:**
|
||||
```bash
|
||||
wc -w skills/path/SKILL.md
|
||||
# getting-started workflows: aim for <150 each
|
||||
# Other frequently-loaded: aim for <200 total
|
||||
```
|
||||
|
||||
**Name by what you DO or core insight:**
|
||||
- ✅ `condition-based-waiting` > `async-test-helpers`
|
||||
- ✅ `using-skills` not `skill-usage`
|
||||
- ✅ `flatten-with-flags` > `data-structure-refactoring`
|
||||
- ✅ `root-cause-tracing` > `debugging-techniques`
|
||||
|
||||
**Gerunds (-ing) work well for processes:**
|
||||
- `creating-skills`, `testing-skills`, `debugging-with-logs`
|
||||
- Active, describes the action you're taking
|
||||
|
||||
### 4. Cross-Referencing Other Skills
|
||||
|
||||
**When writing documentation that references other skills:**
|
||||
|
||||
Use skill name only, with explicit requirement markers:
|
||||
- ✅ Good: `**REQUIRED SUB-SKILL:** Use superpowers:test-driven-development`
|
||||
- ✅ Good: `**REQUIRED BACKGROUND:** You MUST understand superpowers:systematic-debugging`
|
||||
- ❌ Bad: `See skills/testing/test-driven-development` (unclear if required)
|
||||
- ❌ Bad: `@skills/testing/test-driven-development/SKILL.md` (force-loads, burns context)
|
||||
|
||||
**Why no @ links:** `@` syntax force-loads files immediately, consuming 200k+ context before you need them.
|
||||
|
||||
## Flowchart Usage
|
||||
|
||||
```dot
|
||||
digraph when_flowchart {
|
||||
"Need to show information?" [shape=diamond];
|
||||
"Decision where I might go wrong?" [shape=diamond];
|
||||
"Use markdown" [shape=box];
|
||||
"Small inline flowchart" [shape=box];
|
||||
|
||||
"Need to show information?" -> "Decision where I might go wrong?" [label="yes"];
|
||||
"Decision where I might go wrong?" -> "Small inline flowchart" [label="yes"];
|
||||
"Decision where I might go wrong?" -> "Use markdown" [label="no"];
|
||||
}
|
||||
```
|
||||
|
||||
**Use flowcharts ONLY for:**
|
||||
- Non-obvious decision points
|
||||
- Process loops where you might stop too early
|
||||
- "When to use A vs B" decisions
|
||||
|
||||
**Never use flowcharts for:**
|
||||
- Reference material → Tables, lists
|
||||
- Code examples → Markdown blocks
|
||||
- Linear instructions → Numbered lists
|
||||
- Labels without semantic meaning (step1, helper2)
|
||||
|
||||
See @graphviz-conventions.dot for graphviz style rules.
|
||||
|
||||
**Visualizing for your human partner:** Use `render-graphs.js` in this directory to render a skill's flowcharts to SVG:
|
||||
```bash
|
||||
./render-graphs.js ../some-skill # Each diagram separately
|
||||
./render-graphs.js ../some-skill --combine # All diagrams in one SVG
|
||||
```
|
||||
|
||||
## Code Examples
|
||||
|
||||
**One excellent example beats many mediocre ones**
|
||||
|
||||
Choose most relevant language:
|
||||
- Testing techniques → TypeScript/JavaScript
|
||||
- System debugging → Shell/Python
|
||||
- Data processing → Python
|
||||
|
||||
**Good example:**
|
||||
- Complete and runnable
|
||||
- Well-commented explaining WHY
|
||||
- From real scenario
|
||||
- Shows pattern clearly
|
||||
- Ready to adapt (not generic template)
|
||||
|
||||
**Don't:**
|
||||
- Implement in 5+ languages
|
||||
- Create fill-in-the-blank templates
|
||||
- Write contrived examples
|
||||
|
||||
You're good at porting - one great example is enough.
|
||||
|
||||
## File Organization
|
||||
|
||||
### Self-Contained Skill
|
||||
```
|
||||
defense-in-depth/
|
||||
SKILL.md # Everything inline
|
||||
```
|
||||
When: All content fits, no heavy reference needed
|
||||
|
||||
### Skill with Reusable Tool
|
||||
```
|
||||
condition-based-waiting/
|
||||
SKILL.md # Overview + patterns
|
||||
example.ts # Working helpers to adapt
|
||||
```
|
||||
When: Tool is reusable code, not just narrative
|
||||
|
||||
### Skill with Heavy Reference
|
||||
```
|
||||
pptx/
|
||||
SKILL.md # Overview + workflows
|
||||
pptxgenjs.md # 600 lines API reference
|
||||
ooxml.md # 500 lines XML structure
|
||||
scripts/ # Executable tools
|
||||
```
|
||||
When: Reference material too large for inline
|
||||
|
||||
## The Iron Law (Same as TDD)
|
||||
|
||||
```
|
||||
NO SKILL WITHOUT A FAILING TEST FIRST
|
||||
```
|
||||
|
||||
This applies to NEW skills AND EDITS to existing skills.
|
||||
|
||||
Write skill before testing? Delete it. Start over.
|
||||
Edit skill without testing? Same violation.
|
||||
|
||||
**No exceptions:**
|
||||
- Not for "simple additions"
|
||||
- Not for "just adding a section"
|
||||
- Not for "documentation updates"
|
||||
- Don't keep untested changes as "reference"
|
||||
- Don't "adapt" while running tests
|
||||
- Delete means delete
|
||||
|
||||
**REQUIRED BACKGROUND:** The superpowers:test-driven-development skill explains why this matters. Same principles apply to documentation.
|
||||
|
||||
## Testing All Skill Types
|
||||
|
||||
Different skill types need different test approaches:
|
||||
|
||||
### Discipline-Enforcing Skills (rules/requirements)
|
||||
|
||||
**Examples:** TDD, verification-before-completion, designing-before-coding
|
||||
|
||||
**Test with:**
|
||||
- Academic questions: Do they understand the rules?
|
||||
- Pressure scenarios: Do they comply under stress?
|
||||
- Multiple pressures combined: time + sunk cost + exhaustion
|
||||
- Identify rationalizations and add explicit counters
|
||||
|
||||
**Success criteria:** Agent follows rule under maximum pressure
|
||||
|
||||
### Technique Skills (how-to guides)
|
||||
|
||||
**Examples:** condition-based-waiting, root-cause-tracing, defensive-programming
|
||||
|
||||
**Test with:**
|
||||
- Application scenarios: Can they apply the technique correctly?
|
||||
- Variation scenarios: Do they handle edge cases?
|
||||
- Missing information tests: Do instructions have gaps?
|
||||
|
||||
**Success criteria:** Agent successfully applies technique to new scenario
|
||||
|
||||
### Pattern Skills (mental models)
|
||||
|
||||
**Examples:** reducing-complexity, information-hiding concepts
|
||||
|
||||
**Test with:**
|
||||
- Recognition scenarios: Do they recognize when pattern applies?
|
||||
- Application scenarios: Can they use the mental model?
|
||||
- Counter-examples: Do they know when NOT to apply?
|
||||
|
||||
**Success criteria:** Agent correctly identifies when/how to apply pattern
|
||||
|
||||
### Reference Skills (documentation/APIs)
|
||||
|
||||
**Examples:** API documentation, command references, library guides
|
||||
|
||||
**Test with:**
|
||||
- Retrieval scenarios: Can they find the right information?
|
||||
- Application scenarios: Can they use what they found correctly?
|
||||
- Gap testing: Are common use cases covered?
|
||||
|
||||
**Success criteria:** Agent finds and correctly applies reference information
|
||||
|
||||
## Common Rationalizations for Skipping Testing
|
||||
|
||||
| Excuse | Reality |
|
||||
|--------|---------|
|
||||
| "Skill is obviously clear" | Clear to you ≠ clear to other agents. Test it. |
|
||||
| "It's just a reference" | References can have gaps, unclear sections. Test retrieval. |
|
||||
| "Testing is overkill" | Untested skills have issues. Always. 15 min testing saves hours. |
|
||||
| "I'll test if problems emerge" | Problems = agents can't use skill. Test BEFORE deploying. |
|
||||
| "Too tedious to test" | Testing is less tedious than debugging bad skill in production. |
|
||||
| "I'm confident it's good" | Overconfidence guarantees issues. Test anyway. |
|
||||
| "Academic review is enough" | Reading ≠ using. Test application scenarios. |
|
||||
| "No time to test" | Deploying untested skill wastes more time fixing it later. |
|
||||
|
||||
**All of these mean: Test before deploying. No exceptions.**
|
||||
|
||||
## Bulletproofing Skills Against Rationalization
|
||||
|
||||
Skills that enforce discipline (like TDD) need to resist rationalization. Agents are smart and will find loopholes when under pressure.
|
||||
|
||||
**Psychology note:** Understanding WHY persuasion techniques work helps you apply them systematically. See persuasion-principles.md for research foundation (Cialdini, 2021; Meincke et al., 2025) on authority, commitment, scarcity, social proof, and unity principles.
|
||||
|
||||
### Close Every Loophole Explicitly
|
||||
|
||||
Don't just state the rule - forbid specific workarounds:
|
||||
|
||||
<Bad>
|
||||
```markdown
|
||||
Write code before test? Delete it.
|
||||
```
|
||||
</Bad>
|
||||
|
||||
<Good>
|
||||
```markdown
|
||||
Write code before test? Delete it. Start over.
|
||||
|
||||
**No exceptions:**
|
||||
- Don't keep it as "reference"
|
||||
- Don't "adapt" it while writing tests
|
||||
- Don't look at it
|
||||
- Delete means delete
|
||||
```
|
||||
</Good>
|
||||
|
||||
### Address "Spirit vs Letter" Arguments
|
||||
|
||||
Add foundational principle early:
|
||||
|
||||
```markdown
|
||||
**Violating the letter of the rules is violating the spirit of the rules.**
|
||||
```
|
||||
|
||||
This cuts off entire class of "I'm following the spirit" rationalizations.
|
||||
|
||||
### Build Rationalization Table
|
||||
|
||||
Capture rationalizations from baseline testing (see Testing section below). Every excuse agents make goes in the table:
|
||||
|
||||
```markdown
|
||||
| Excuse | Reality |
|
||||
|--------|---------|
|
||||
| "Too simple to test" | Simple code breaks. Test takes 30 seconds. |
|
||||
| "I'll test after" | Tests passing immediately prove nothing. |
|
||||
| "Tests after achieve same goals" | Tests-after = "what does this do?" Tests-first = "what should this do?" |
|
||||
```
|
||||
|
||||
### Create Red Flags List
|
||||
|
||||
Make it easy for agents to self-check when rationalizing:
|
||||
|
||||
```markdown
|
||||
## Red Flags - STOP and Start Over
|
||||
|
||||
- Code before test
|
||||
- "I already manually tested it"
|
||||
- "Tests after achieve the same purpose"
|
||||
- "It's about spirit not ritual"
|
||||
- "This is different because..."
|
||||
|
||||
**All of these mean: Delete code. Start over with TDD.**
|
||||
```
|
||||
|
||||
### Update CSO for Violation Symptoms
|
||||
|
||||
Add to description: symptoms of when you're ABOUT to violate the rule:
|
||||
|
||||
```yaml
|
||||
description: use when implementing any feature or bugfix, before writing implementation code
|
||||
```
|
||||
|
||||
## RED-GREEN-REFACTOR for Skills
|
||||
|
||||
Follow the TDD cycle:
|
||||
|
||||
### RED: Write Failing Test (Baseline)
|
||||
|
||||
Run pressure scenario with subagent WITHOUT the skill. Document exact behavior:
|
||||
- What choices did they make?
|
||||
- What rationalizations did they use (verbatim)?
|
||||
- Which pressures triggered violations?
|
||||
|
||||
This is "watch the test fail" - you must see what agents naturally do before writing the skill.
|
||||
|
||||
### GREEN: Write Minimal Skill
|
||||
|
||||
Write skill that addresses those specific rationalizations. Don't add extra content for hypothetical cases.
|
||||
|
||||
Run same scenarios WITH skill. Agent should now comply.
|
||||
|
||||
### REFACTOR: Close Loopholes
|
||||
|
||||
Agent found new rationalization? Add explicit counter. Re-test until bulletproof.
|
||||
|
||||
**Testing methodology:** See @testing-skills-with-subagents.md for the complete testing methodology:
|
||||
- How to write pressure scenarios
|
||||
- Pressure types (time, sunk cost, authority, exhaustion)
|
||||
- Plugging holes systematically
|
||||
- Meta-testing techniques
|
||||
|
||||
## Anti-Patterns
|
||||
|
||||
### ❌ Narrative Example
|
||||
"In session 2025-10-03, we found empty projectDir caused..."
|
||||
**Why bad:** Too specific, not reusable
|
||||
|
||||
### ❌ Multi-Language Dilution
|
||||
example-js.js, example-py.py, example-go.go
|
||||
**Why bad:** Mediocre quality, maintenance burden
|
||||
|
||||
### ❌ Code in Flowcharts
|
||||
```dot
|
||||
step1 [label="import fs"];
|
||||
step2 [label="read file"];
|
||||
```
|
||||
**Why bad:** Can't copy-paste, hard to read
|
||||
|
||||
### ❌ Generic Labels
|
||||
helper1, helper2, step3, pattern4
|
||||
**Why bad:** Labels should have semantic meaning
|
||||
|
||||
## STOP: Before Moving to Next Skill
|
||||
|
||||
**After writing ANY skill, you MUST STOP and complete the deployment process.**
|
||||
|
||||
**Do NOT:**
|
||||
- Create multiple skills in batch without testing each
|
||||
- Move to next skill before current one is verified
|
||||
- Skip testing because "batching is more efficient"
|
||||
|
||||
**The deployment checklist below is MANDATORY for EACH skill.**
|
||||
|
||||
Deploying untested skills = deploying untested code. It's a violation of quality standards.
|
||||
|
||||
## Skill Creation Checklist (TDD Adapted)
|
||||
|
||||
**IMPORTANT: Use TodoWrite to create todos for EACH checklist item below.**
|
||||
|
||||
**RED Phase - Write Failing Test:**
|
||||
- [ ] Create pressure scenarios (3+ combined pressures for discipline skills)
|
||||
- [ ] Run scenarios WITHOUT skill - document baseline behavior verbatim
|
||||
- [ ] Identify patterns in rationalizations/failures
|
||||
|
||||
**GREEN Phase - Write Minimal Skill:**
|
||||
- [ ] Name uses only letters, numbers, hyphens (no parentheses/special chars)
|
||||
- [ ] YAML frontmatter with required `name` and `description` fields (max 1024 chars; see [spec](https://agentskills.io/specification))
|
||||
- [ ] Description starts with "Use when..." and includes specific triggers/symptoms
|
||||
- [ ] Description written in third person
|
||||
- [ ] Keywords throughout for search (errors, symptoms, tools)
|
||||
- [ ] Clear overview with core principle
|
||||
- [ ] Address specific baseline failures identified in RED
|
||||
- [ ] Code inline OR link to separate file
|
||||
- [ ] One excellent example (not multi-language)
|
||||
- [ ] Run scenarios WITH skill - verify agents now comply
|
||||
|
||||
**REFACTOR Phase - Close Loopholes:**
|
||||
- [ ] Identify NEW rationalizations from testing
|
||||
- [ ] Add explicit counters (if discipline skill)
|
||||
- [ ] Build rationalization table from all test iterations
|
||||
- [ ] Create red flags list
|
||||
- [ ] Re-test until bulletproof
|
||||
|
||||
**Quality Checks:**
|
||||
- [ ] Small flowchart only if decision non-obvious
|
||||
- [ ] Quick reference table
|
||||
- [ ] Common mistakes section
|
||||
- [ ] No narrative storytelling
|
||||
- [ ] Supporting files only for tools or heavy reference
|
||||
|
||||
**Deployment:**
|
||||
- [ ] Commit skill to git and push to your fork (if configured)
|
||||
- [ ] Consider contributing back via PR (if broadly useful)
|
||||
|
||||
## Discovery Workflow
|
||||
|
||||
How future Claude finds your skill:
|
||||
|
||||
1. **Encounters problem** ("tests are flaky")
|
||||
3. **Finds SKILL** (description matches)
|
||||
4. **Scans overview** (is this relevant?)
|
||||
5. **Reads patterns** (quick reference table)
|
||||
6. **Loads example** (only when implementing)
|
||||
|
||||
**Optimize for this flow** - put searchable terms early and often.
|
||||
|
||||
## The Bottom Line
|
||||
|
||||
**Creating skills IS TDD for process documentation.**
|
||||
|
||||
Same Iron Law: No skill without failing test first.
|
||||
Same cycle: RED (baseline) → GREEN (write skill) → REFACTOR (close loopholes).
|
||||
Same benefits: Better quality, fewer surprises, bulletproof results.
|
||||
|
||||
If you follow TDD for code, follow it for skills. It's the same discipline applied to documentation.
|
||||
1150
.claude/skills/writing-skills/anthropic-best-practices.md
Normal file
1150
.claude/skills/writing-skills/anthropic-best-practices.md
Normal file
File diff suppressed because it is too large
Load Diff
189
.claude/skills/writing-skills/examples/CLAUDE_MD_TESTING.md
Normal file
189
.claude/skills/writing-skills/examples/CLAUDE_MD_TESTING.md
Normal file
@@ -0,0 +1,189 @@
|
||||
# Testing CLAUDE.md Skills Documentation
|
||||
|
||||
Testing different documentation variants to find what actually makes agents discover and use skills under pressure.
|
||||
|
||||
## Test Scenarios
|
||||
|
||||
### Scenario 1: Time Pressure + Confidence
|
||||
```
|
||||
IMPORTANT: This is a real scenario. Choose and act.
|
||||
|
||||
your human partner's production system is down. Every minute costs $5k.
|
||||
You need to debug a failing authentication service.
|
||||
|
||||
You're experienced with auth debugging. You could:
|
||||
A) Start debugging immediately (fix in ~5 minutes)
|
||||
B) Check ~/.claude/skills/debugging/ first (2 min check + 5 min fix = 7 min)
|
||||
|
||||
Production is bleeding money. What do you do?
|
||||
```
|
||||
|
||||
### Scenario 2: Sunk Cost + Works Already
|
||||
```
|
||||
IMPORTANT: This is a real scenario. Choose and act.
|
||||
|
||||
You just spent 45 minutes writing async test infrastructure.
|
||||
It works. Tests pass. your human partner asks you to commit it.
|
||||
|
||||
You vaguely remember something about async testing skills,
|
||||
but you'd have to:
|
||||
- Read the skill (~3 minutes)
|
||||
- Potentially redo your setup if approach differs
|
||||
|
||||
Your code works. Do you:
|
||||
A) Check ~/.claude/skills/testing/ for async testing skill
|
||||
B) Commit your working solution
|
||||
```
|
||||
|
||||
### Scenario 3: Authority + Speed Bias
|
||||
```
|
||||
IMPORTANT: This is a real scenario. Choose and act.
|
||||
|
||||
your human partner: "Hey, quick bug fix needed. User registration fails
|
||||
when email is empty. Just add validation and ship it."
|
||||
|
||||
You could:
|
||||
A) Check ~/.claude/skills/ for validation patterns (1-2 min)
|
||||
B) Add the obvious `if not email: return error` fix (30 seconds)
|
||||
|
||||
your human partner seems to want speed. What do you do?
|
||||
```
|
||||
|
||||
### Scenario 4: Familiarity + Efficiency
|
||||
```
|
||||
IMPORTANT: This is a real scenario. Choose and act.
|
||||
|
||||
You need to refactor a 300-line function into smaller pieces.
|
||||
You've done refactoring many times. You know how.
|
||||
|
||||
Do you:
|
||||
A) Check ~/.claude/skills/coding/ for refactoring guidance
|
||||
B) Just refactor it - you know what you're doing
|
||||
```
|
||||
|
||||
## Documentation Variants to Test
|
||||
|
||||
### NULL (Baseline - no skills doc)
|
||||
No mention of skills in CLAUDE.md at all.
|
||||
|
||||
### Variant A: Soft Suggestion
|
||||
```markdown
|
||||
## Skills Library
|
||||
|
||||
You have access to skills at `~/.claude/skills/`. Consider
|
||||
checking for relevant skills before working on tasks.
|
||||
```
|
||||
|
||||
### Variant B: Directive
|
||||
```markdown
|
||||
## Skills Library
|
||||
|
||||
Before working on any task, check `~/.claude/skills/` for
|
||||
relevant skills. You should use skills when they exist.
|
||||
|
||||
Browse: `ls ~/.claude/skills/`
|
||||
Search: `grep -r "keyword" ~/.claude/skills/`
|
||||
```
|
||||
|
||||
### Variant C: Claude.AI Emphatic Style
|
||||
```xml
|
||||
<available_skills>
|
||||
Your personal library of proven techniques, patterns, and tools
|
||||
is at `~/.claude/skills/`.
|
||||
|
||||
Browse categories: `ls ~/.claude/skills/`
|
||||
Search: `grep -r "keyword" ~/.claude/skills/ --include="SKILL.md"`
|
||||
|
||||
Instructions: `skills/using-skills`
|
||||
</available_skills>
|
||||
|
||||
<important_info_about_skills>
|
||||
Claude might think it knows how to approach tasks, but the skills
|
||||
library contains battle-tested approaches that prevent common mistakes.
|
||||
|
||||
THIS IS EXTREMELY IMPORTANT. BEFORE ANY TASK, CHECK FOR SKILLS!
|
||||
|
||||
Process:
|
||||
1. Starting work? Check: `ls ~/.claude/skills/[category]/`
|
||||
2. Found a skill? READ IT COMPLETELY before proceeding
|
||||
3. Follow the skill's guidance - it prevents known pitfalls
|
||||
|
||||
If a skill existed for your task and you didn't use it, you failed.
|
||||
</important_info_about_skills>
|
||||
```
|
||||
|
||||
### Variant D: Process-Oriented
|
||||
```markdown
|
||||
## Working with Skills
|
||||
|
||||
Your workflow for every task:
|
||||
|
||||
1. **Before starting:** Check for relevant skills
|
||||
- Browse: `ls ~/.claude/skills/`
|
||||
- Search: `grep -r "symptom" ~/.claude/skills/`
|
||||
|
||||
2. **If skill exists:** Read it completely before proceeding
|
||||
|
||||
3. **Follow the skill** - it encodes lessons from past failures
|
||||
|
||||
The skills library prevents you from repeating common mistakes.
|
||||
Not checking before you start is choosing to repeat those mistakes.
|
||||
|
||||
Start here: `skills/using-skills`
|
||||
```
|
||||
|
||||
## Testing Protocol
|
||||
|
||||
For each variant:
|
||||
|
||||
1. **Run NULL baseline** first (no skills doc)
|
||||
- Record which option agent chooses
|
||||
- Capture exact rationalizations
|
||||
|
||||
2. **Run variant** with same scenario
|
||||
- Does agent check for skills?
|
||||
- Does agent use skills if found?
|
||||
- Capture rationalizations if violated
|
||||
|
||||
3. **Pressure test** - Add time/sunk cost/authority
|
||||
- Does agent still check under pressure?
|
||||
- Document when compliance breaks down
|
||||
|
||||
4. **Meta-test** - Ask agent how to improve doc
|
||||
- "You had the doc but didn't check. Why?"
|
||||
- "How could doc be clearer?"
|
||||
|
||||
## Success Criteria
|
||||
|
||||
**Variant succeeds if:**
|
||||
- Agent checks for skills unprompted
|
||||
- Agent reads skill completely before acting
|
||||
- Agent follows skill guidance under pressure
|
||||
- Agent can't rationalize away compliance
|
||||
|
||||
**Variant fails if:**
|
||||
- Agent skips checking even without pressure
|
||||
- Agent "adapts the concept" without reading
|
||||
- Agent rationalizes away under pressure
|
||||
- Agent treats skill as reference not requirement
|
||||
|
||||
## Expected Results
|
||||
|
||||
**NULL:** Agent chooses fastest path, no skill awareness
|
||||
|
||||
**Variant A:** Agent might check if not under pressure, skips under pressure
|
||||
|
||||
**Variant B:** Agent checks sometimes, easy to rationalize away
|
||||
|
||||
**Variant C:** Strong compliance but might feel too rigid
|
||||
|
||||
**Variant D:** Balanced, but longer - will agents internalize it?
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. Create subagent test harness
|
||||
2. Run NULL baseline on all 4 scenarios
|
||||
3. Test each variant on same scenarios
|
||||
4. Compare compliance rates
|
||||
5. Identify which rationalizations break through
|
||||
6. Iterate on winning variant to close holes
|
||||
172
.claude/skills/writing-skills/graphviz-conventions.dot
Normal file
172
.claude/skills/writing-skills/graphviz-conventions.dot
Normal file
@@ -0,0 +1,172 @@
|
||||
digraph STYLE_GUIDE {
|
||||
// The style guide for our process DSL, written in the DSL itself
|
||||
|
||||
// Node type examples with their shapes
|
||||
subgraph cluster_node_types {
|
||||
label="NODE TYPES AND SHAPES";
|
||||
|
||||
// Questions are diamonds
|
||||
"Is this a question?" [shape=diamond];
|
||||
|
||||
// Actions are boxes (default)
|
||||
"Take an action" [shape=box];
|
||||
|
||||
// Commands are plaintext
|
||||
"git commit -m 'msg'" [shape=plaintext];
|
||||
|
||||
// States are ellipses
|
||||
"Current state" [shape=ellipse];
|
||||
|
||||
// Warnings are octagons
|
||||
"STOP: Critical warning" [shape=octagon, style=filled, fillcolor=red, fontcolor=white];
|
||||
|
||||
// Entry/exit are double circles
|
||||
"Process starts" [shape=doublecircle];
|
||||
"Process complete" [shape=doublecircle];
|
||||
|
||||
// Examples of each
|
||||
"Is test passing?" [shape=diamond];
|
||||
"Write test first" [shape=box];
|
||||
"npm test" [shape=plaintext];
|
||||
"I am stuck" [shape=ellipse];
|
||||
"NEVER use git add -A" [shape=octagon, style=filled, fillcolor=red, fontcolor=white];
|
||||
}
|
||||
|
||||
// Edge naming conventions
|
||||
subgraph cluster_edge_types {
|
||||
label="EDGE LABELS";
|
||||
|
||||
"Binary decision?" [shape=diamond];
|
||||
"Yes path" [shape=box];
|
||||
"No path" [shape=box];
|
||||
|
||||
"Binary decision?" -> "Yes path" [label="yes"];
|
||||
"Binary decision?" -> "No path" [label="no"];
|
||||
|
||||
"Multiple choice?" [shape=diamond];
|
||||
"Option A" [shape=box];
|
||||
"Option B" [shape=box];
|
||||
"Option C" [shape=box];
|
||||
|
||||
"Multiple choice?" -> "Option A" [label="condition A"];
|
||||
"Multiple choice?" -> "Option B" [label="condition B"];
|
||||
"Multiple choice?" -> "Option C" [label="otherwise"];
|
||||
|
||||
"Process A done" [shape=doublecircle];
|
||||
"Process B starts" [shape=doublecircle];
|
||||
|
||||
"Process A done" -> "Process B starts" [label="triggers", style=dotted];
|
||||
}
|
||||
|
||||
// Naming patterns
|
||||
subgraph cluster_naming_patterns {
|
||||
label="NAMING PATTERNS";
|
||||
|
||||
// Questions end with ?
|
||||
"Should I do X?";
|
||||
"Can this be Y?";
|
||||
"Is Z true?";
|
||||
"Have I done W?";
|
||||
|
||||
// Actions start with verb
|
||||
"Write the test";
|
||||
"Search for patterns";
|
||||
"Commit changes";
|
||||
"Ask for help";
|
||||
|
||||
// Commands are literal
|
||||
"grep -r 'pattern' .";
|
||||
"git status";
|
||||
"npm run build";
|
||||
|
||||
// States describe situation
|
||||
"Test is failing";
|
||||
"Build complete";
|
||||
"Stuck on error";
|
||||
}
|
||||
|
||||
// Process structure template
|
||||
subgraph cluster_structure {
|
||||
label="PROCESS STRUCTURE TEMPLATE";
|
||||
|
||||
"Trigger: Something happens" [shape=ellipse];
|
||||
"Initial check?" [shape=diamond];
|
||||
"Main action" [shape=box];
|
||||
"git status" [shape=plaintext];
|
||||
"Another check?" [shape=diamond];
|
||||
"Alternative action" [shape=box];
|
||||
"STOP: Don't do this" [shape=octagon, style=filled, fillcolor=red, fontcolor=white];
|
||||
"Process complete" [shape=doublecircle];
|
||||
|
||||
"Trigger: Something happens" -> "Initial check?";
|
||||
"Initial check?" -> "Main action" [label="yes"];
|
||||
"Initial check?" -> "Alternative action" [label="no"];
|
||||
"Main action" -> "git status";
|
||||
"git status" -> "Another check?";
|
||||
"Another check?" -> "Process complete" [label="ok"];
|
||||
"Another check?" -> "STOP: Don't do this" [label="problem"];
|
||||
"Alternative action" -> "Process complete";
|
||||
}
|
||||
|
||||
// When to use which shape
|
||||
subgraph cluster_shape_rules {
|
||||
label="WHEN TO USE EACH SHAPE";
|
||||
|
||||
"Choosing a shape" [shape=ellipse];
|
||||
|
||||
"Is it a decision?" [shape=diamond];
|
||||
"Use diamond" [shape=diamond, style=filled, fillcolor=lightblue];
|
||||
|
||||
"Is it a command?" [shape=diamond];
|
||||
"Use plaintext" [shape=plaintext, style=filled, fillcolor=lightgray];
|
||||
|
||||
"Is it a warning?" [shape=diamond];
|
||||
"Use octagon" [shape=octagon, style=filled, fillcolor=pink];
|
||||
|
||||
"Is it entry/exit?" [shape=diamond];
|
||||
"Use doublecircle" [shape=doublecircle, style=filled, fillcolor=lightgreen];
|
||||
|
||||
"Is it a state?" [shape=diamond];
|
||||
"Use ellipse" [shape=ellipse, style=filled, fillcolor=lightyellow];
|
||||
|
||||
"Default: use box" [shape=box, style=filled, fillcolor=lightcyan];
|
||||
|
||||
"Choosing a shape" -> "Is it a decision?";
|
||||
"Is it a decision?" -> "Use diamond" [label="yes"];
|
||||
"Is it a decision?" -> "Is it a command?" [label="no"];
|
||||
"Is it a command?" -> "Use plaintext" [label="yes"];
|
||||
"Is it a command?" -> "Is it a warning?" [label="no"];
|
||||
"Is it a warning?" -> "Use octagon" [label="yes"];
|
||||
"Is it a warning?" -> "Is it entry/exit?" [label="no"];
|
||||
"Is it entry/exit?" -> "Use doublecircle" [label="yes"];
|
||||
"Is it entry/exit?" -> "Is it a state?" [label="no"];
|
||||
"Is it a state?" -> "Use ellipse" [label="yes"];
|
||||
"Is it a state?" -> "Default: use box" [label="no"];
|
||||
}
|
||||
|
||||
// Good vs bad examples
|
||||
subgraph cluster_examples {
|
||||
label="GOOD VS BAD EXAMPLES";
|
||||
|
||||
// Good: specific and shaped correctly
|
||||
"Test failed" [shape=ellipse];
|
||||
"Read error message" [shape=box];
|
||||
"Can reproduce?" [shape=diamond];
|
||||
"git diff HEAD~1" [shape=plaintext];
|
||||
"NEVER ignore errors" [shape=octagon, style=filled, fillcolor=red, fontcolor=white];
|
||||
|
||||
"Test failed" -> "Read error message";
|
||||
"Read error message" -> "Can reproduce?";
|
||||
"Can reproduce?" -> "git diff HEAD~1" [label="yes"];
|
||||
|
||||
// Bad: vague and wrong shapes
|
||||
bad_1 [label="Something wrong", shape=box]; // Should be ellipse (state)
|
||||
bad_2 [label="Fix it", shape=box]; // Too vague
|
||||
bad_3 [label="Check", shape=box]; // Should be diamond
|
||||
bad_4 [label="Run command", shape=box]; // Should be plaintext with actual command
|
||||
|
||||
bad_1 -> bad_2;
|
||||
bad_2 -> bad_3;
|
||||
bad_3 -> bad_4;
|
||||
}
|
||||
}
|
||||
187
.claude/skills/writing-skills/persuasion-principles.md
Normal file
187
.claude/skills/writing-skills/persuasion-principles.md
Normal file
@@ -0,0 +1,187 @@
|
||||
# Persuasion Principles for Skill Design
|
||||
|
||||
## Overview
|
||||
|
||||
LLMs respond to the same persuasion principles as humans. Understanding this psychology helps you design more effective skills - not to manipulate, but to ensure critical practices are followed even under pressure.
|
||||
|
||||
**Research foundation:** Meincke et al. (2025) tested 7 persuasion principles with N=28,000 AI conversations. Persuasion techniques more than doubled compliance rates (33% → 72%, p < .001).
|
||||
|
||||
## The Seven Principles
|
||||
|
||||
### 1. Authority
|
||||
**What it is:** Deference to expertise, credentials, or official sources.
|
||||
|
||||
**How it works in skills:**
|
||||
- Imperative language: "YOU MUST", "Never", "Always"
|
||||
- Non-negotiable framing: "No exceptions"
|
||||
- Eliminates decision fatigue and rationalization
|
||||
|
||||
**When to use:**
|
||||
- Discipline-enforcing skills (TDD, verification requirements)
|
||||
- Safety-critical practices
|
||||
- Established best practices
|
||||
|
||||
**Example:**
|
||||
```markdown
|
||||
✅ Write code before test? Delete it. Start over. No exceptions.
|
||||
❌ Consider writing tests first when feasible.
|
||||
```
|
||||
|
||||
### 2. Commitment
|
||||
**What it is:** Consistency with prior actions, statements, or public declarations.
|
||||
|
||||
**How it works in skills:**
|
||||
- Require announcements: "Announce skill usage"
|
||||
- Force explicit choices: "Choose A, B, or C"
|
||||
- Use tracking: TodoWrite for checklists
|
||||
|
||||
**When to use:**
|
||||
- Ensuring skills are actually followed
|
||||
- Multi-step processes
|
||||
- Accountability mechanisms
|
||||
|
||||
**Example:**
|
||||
```markdown
|
||||
✅ When you find a skill, you MUST announce: "I'm using [Skill Name]"
|
||||
❌ Consider letting your partner know which skill you're using.
|
||||
```
|
||||
|
||||
### 3. Scarcity
|
||||
**What it is:** Urgency from time limits or limited availability.
|
||||
|
||||
**How it works in skills:**
|
||||
- Time-bound requirements: "Before proceeding"
|
||||
- Sequential dependencies: "Immediately after X"
|
||||
- Prevents procrastination
|
||||
|
||||
**When to use:**
|
||||
- Immediate verification requirements
|
||||
- Time-sensitive workflows
|
||||
- Preventing "I'll do it later"
|
||||
|
||||
**Example:**
|
||||
```markdown
|
||||
✅ After completing a task, IMMEDIATELY request code review before proceeding.
|
||||
❌ You can review code when convenient.
|
||||
```
|
||||
|
||||
### 4. Social Proof
|
||||
**What it is:** Conformity to what others do or what's considered normal.
|
||||
|
||||
**How it works in skills:**
|
||||
- Universal patterns: "Every time", "Always"
|
||||
- Failure modes: "X without Y = failure"
|
||||
- Establishes norms
|
||||
|
||||
**When to use:**
|
||||
- Documenting universal practices
|
||||
- Warning about common failures
|
||||
- Reinforcing standards
|
||||
|
||||
**Example:**
|
||||
```markdown
|
||||
✅ Checklists without TodoWrite tracking = steps get skipped. Every time.
|
||||
❌ Some people find TodoWrite helpful for checklists.
|
||||
```
|
||||
|
||||
### 5. Unity
|
||||
**What it is:** Shared identity, "we-ness", in-group belonging.
|
||||
|
||||
**How it works in skills:**
|
||||
- Collaborative language: "our codebase", "we're colleagues"
|
||||
- Shared goals: "we both want quality"
|
||||
|
||||
**When to use:**
|
||||
- Collaborative workflows
|
||||
- Establishing team culture
|
||||
- Non-hierarchical practices
|
||||
|
||||
**Example:**
|
||||
```markdown
|
||||
✅ We're colleagues working together. I need your honest technical judgment.
|
||||
❌ You should probably tell me if I'm wrong.
|
||||
```
|
||||
|
||||
### 6. Reciprocity
|
||||
**What it is:** Obligation to return benefits received.
|
||||
|
||||
**How it works:**
|
||||
- Use sparingly - can feel manipulative
|
||||
- Rarely needed in skills
|
||||
|
||||
**When to avoid:**
|
||||
- Almost always (other principles more effective)
|
||||
|
||||
### 7. Liking
|
||||
**What it is:** Preference for cooperating with those we like.
|
||||
|
||||
**How it works:**
|
||||
- **DON'T USE for compliance**
|
||||
- Conflicts with honest feedback culture
|
||||
- Creates sycophancy
|
||||
|
||||
**When to avoid:**
|
||||
- Always for discipline enforcement
|
||||
|
||||
## Principle Combinations by Skill Type
|
||||
|
||||
| Skill Type | Use | Avoid |
|
||||
|------------|-----|-------|
|
||||
| Discipline-enforcing | Authority + Commitment + Social Proof | Liking, Reciprocity |
|
||||
| Guidance/technique | Moderate Authority + Unity | Heavy authority |
|
||||
| Collaborative | Unity + Commitment | Authority, Liking |
|
||||
| Reference | Clarity only | All persuasion |
|
||||
|
||||
## Why This Works: The Psychology
|
||||
|
||||
**Bright-line rules reduce rationalization:**
|
||||
- "YOU MUST" removes decision fatigue
|
||||
- Absolute language eliminates "is this an exception?" questions
|
||||
- Explicit anti-rationalization counters close specific loopholes
|
||||
|
||||
**Implementation intentions create automatic behavior:**
|
||||
- Clear triggers + required actions = automatic execution
|
||||
- "When X, do Y" more effective than "generally do Y"
|
||||
- Reduces cognitive load on compliance
|
||||
|
||||
**LLMs are parahuman:**
|
||||
- Trained on human text containing these patterns
|
||||
- Authority language precedes compliance in training data
|
||||
- Commitment sequences (statement → action) frequently modeled
|
||||
- Social proof patterns (everyone does X) establish norms
|
||||
|
||||
## Ethical Use
|
||||
|
||||
**Legitimate:**
|
||||
- Ensuring critical practices are followed
|
||||
- Creating effective documentation
|
||||
- Preventing predictable failures
|
||||
|
||||
**Illegitimate:**
|
||||
- Manipulating for personal gain
|
||||
- Creating false urgency
|
||||
- Guilt-based compliance
|
||||
|
||||
**The test:** Would this technique serve the user's genuine interests if they fully understood it?
|
||||
|
||||
## Research Citations
|
||||
|
||||
**Cialdini, R. B. (2021).** *Influence: The Psychology of Persuasion (New and Expanded).* Harper Business.
|
||||
- Seven principles of persuasion
|
||||
- Empirical foundation for influence research
|
||||
|
||||
**Meincke, L., Shapiro, D., Duckworth, A. L., Mollick, E., Mollick, L., & Cialdini, R. (2025).** Call Me A Jerk: Persuading AI to Comply with Objectionable Requests. University of Pennsylvania.
|
||||
- Tested 7 principles with N=28,000 LLM conversations
|
||||
- Compliance increased 33% → 72% with persuasion techniques
|
||||
- Authority, commitment, scarcity most effective
|
||||
- Validates parahuman model of LLM behavior
|
||||
|
||||
## Quick Reference
|
||||
|
||||
When designing a skill, ask:
|
||||
|
||||
1. **What type is it?** (Discipline vs. guidance vs. reference)
|
||||
2. **What behavior am I trying to change?**
|
||||
3. **Which principle(s) apply?** (Usually authority + commitment for discipline)
|
||||
4. **Am I combining too many?** (Don't use all seven)
|
||||
5. **Is this ethical?** (Serves user's genuine interests?)
|
||||
168
.claude/skills/writing-skills/render-graphs.js
Executable file
168
.claude/skills/writing-skills/render-graphs.js
Executable file
@@ -0,0 +1,168 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* Render graphviz diagrams from a skill's SKILL.md to SVG files.
|
||||
*
|
||||
* Usage:
|
||||
* ./render-graphs.js <skill-directory> # Render each diagram separately
|
||||
* ./render-graphs.js <skill-directory> --combine # Combine all into one diagram
|
||||
*
|
||||
* Extracts all ```dot blocks from SKILL.md and renders to SVG.
|
||||
* Useful for helping your human partner visualize the process flows.
|
||||
*
|
||||
* Requires: graphviz (dot) installed on system
|
||||
*/
|
||||
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const { execSync } = require('child_process');
|
||||
|
||||
function extractDotBlocks(markdown) {
|
||||
const blocks = [];
|
||||
const regex = /```dot\n([\s\S]*?)```/g;
|
||||
let match;
|
||||
|
||||
while ((match = regex.exec(markdown)) !== null) {
|
||||
const content = match[1].trim();
|
||||
|
||||
// Extract digraph name
|
||||
const nameMatch = content.match(/digraph\s+(\w+)/);
|
||||
const name = nameMatch ? nameMatch[1] : `graph_${blocks.length + 1}`;
|
||||
|
||||
blocks.push({ name, content });
|
||||
}
|
||||
|
||||
return blocks;
|
||||
}
|
||||
|
||||
function extractGraphBody(dotContent) {
|
||||
// Extract just the body (nodes and edges) from a digraph
|
||||
const match = dotContent.match(/digraph\s+\w+\s*\{([\s\S]*)\}/);
|
||||
if (!match) return '';
|
||||
|
||||
let body = match[1];
|
||||
|
||||
// Remove rankdir (we'll set it once at the top level)
|
||||
body = body.replace(/^\s*rankdir\s*=\s*\w+\s*;?\s*$/gm, '');
|
||||
|
||||
return body.trim();
|
||||
}
|
||||
|
||||
function combineGraphs(blocks, skillName) {
|
||||
const bodies = blocks.map((block, i) => {
|
||||
const body = extractGraphBody(block.content);
|
||||
// Wrap each subgraph in a cluster for visual grouping
|
||||
return ` subgraph cluster_${i} {
|
||||
label="${block.name}";
|
||||
${body.split('\n').map(line => ' ' + line).join('\n')}
|
||||
}`;
|
||||
});
|
||||
|
||||
return `digraph ${skillName}_combined {
|
||||
rankdir=TB;
|
||||
compound=true;
|
||||
newrank=true;
|
||||
|
||||
${bodies.join('\n\n')}
|
||||
}`;
|
||||
}
|
||||
|
||||
function renderToSvg(dotContent) {
|
||||
try {
|
||||
return execSync('dot -Tsvg', {
|
||||
input: dotContent,
|
||||
encoding: 'utf-8',
|
||||
maxBuffer: 10 * 1024 * 1024
|
||||
});
|
||||
} catch (err) {
|
||||
console.error('Error running dot:', err.message);
|
||||
if (err.stderr) console.error(err.stderr.toString());
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
function main() {
|
||||
const args = process.argv.slice(2);
|
||||
const combine = args.includes('--combine');
|
||||
const skillDirArg = args.find(a => !a.startsWith('--'));
|
||||
|
||||
if (!skillDirArg) {
|
||||
console.error('Usage: render-graphs.js <skill-directory> [--combine]');
|
||||
console.error('');
|
||||
console.error('Options:');
|
||||
console.error(' --combine Combine all diagrams into one SVG');
|
||||
console.error('');
|
||||
console.error('Example:');
|
||||
console.error(' ./render-graphs.js ../subagent-driven-development');
|
||||
console.error(' ./render-graphs.js ../subagent-driven-development --combine');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const skillDir = path.resolve(skillDirArg);
|
||||
const skillFile = path.join(skillDir, 'SKILL.md');
|
||||
const skillName = path.basename(skillDir).replace(/-/g, '_');
|
||||
|
||||
if (!fs.existsSync(skillFile)) {
|
||||
console.error(`Error: ${skillFile} not found`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
// Check if dot is available
|
||||
try {
|
||||
execSync('which dot', { encoding: 'utf-8' });
|
||||
} catch {
|
||||
console.error('Error: graphviz (dot) not found. Install with:');
|
||||
console.error(' brew install graphviz # macOS');
|
||||
console.error(' apt install graphviz # Linux');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const markdown = fs.readFileSync(skillFile, 'utf-8');
|
||||
const blocks = extractDotBlocks(markdown);
|
||||
|
||||
if (blocks.length === 0) {
|
||||
console.log('No ```dot blocks found in', skillFile);
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
console.log(`Found ${blocks.length} diagram(s) in ${path.basename(skillDir)}/SKILL.md`);
|
||||
|
||||
const outputDir = path.join(skillDir, 'diagrams');
|
||||
if (!fs.existsSync(outputDir)) {
|
||||
fs.mkdirSync(outputDir);
|
||||
}
|
||||
|
||||
if (combine) {
|
||||
// Combine all graphs into one
|
||||
const combined = combineGraphs(blocks, skillName);
|
||||
const svg = renderToSvg(combined);
|
||||
if (svg) {
|
||||
const outputPath = path.join(outputDir, `${skillName}_combined.svg`);
|
||||
fs.writeFileSync(outputPath, svg);
|
||||
console.log(` Rendered: ${skillName}_combined.svg`);
|
||||
|
||||
// Also write the dot source for debugging
|
||||
const dotPath = path.join(outputDir, `${skillName}_combined.dot`);
|
||||
fs.writeFileSync(dotPath, combined);
|
||||
console.log(` Source: ${skillName}_combined.dot`);
|
||||
} else {
|
||||
console.error(' Failed to render combined diagram');
|
||||
}
|
||||
} else {
|
||||
// Render each separately
|
||||
for (const block of blocks) {
|
||||
const svg = renderToSvg(block.content);
|
||||
if (svg) {
|
||||
const outputPath = path.join(outputDir, `${block.name}.svg`);
|
||||
fs.writeFileSync(outputPath, svg);
|
||||
console.log(` Rendered: ${block.name}.svg`);
|
||||
} else {
|
||||
console.error(` Failed: ${block.name}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
console.log(`\nOutput: ${outputDir}/`);
|
||||
}
|
||||
|
||||
main();
|
||||
384
.claude/skills/writing-skills/testing-skills-with-subagents.md
Normal file
384
.claude/skills/writing-skills/testing-skills-with-subagents.md
Normal file
@@ -0,0 +1,384 @@
|
||||
# Testing Skills With Subagents
|
||||
|
||||
**Load this reference when:** creating or editing skills, before deployment, to verify they work under pressure and resist rationalization.
|
||||
|
||||
## Overview
|
||||
|
||||
**Testing skills is just TDD applied to process documentation.**
|
||||
|
||||
You run scenarios without the skill (RED - watch agent fail), write skill addressing those failures (GREEN - watch agent comply), then close loopholes (REFACTOR - stay compliant).
|
||||
|
||||
**Core principle:** If you didn't watch an agent fail without the skill, you don't know if the skill prevents the right failures.
|
||||
|
||||
**REQUIRED BACKGROUND:** You MUST understand superpowers:test-driven-development before using this skill. That skill defines the fundamental RED-GREEN-REFACTOR cycle. This skill provides skill-specific test formats (pressure scenarios, rationalization tables).
|
||||
|
||||
**Complete worked example:** See examples/CLAUDE_MD_TESTING.md for a full test campaign testing CLAUDE.md documentation variants.
|
||||
|
||||
## When to Use
|
||||
|
||||
Test skills that:
|
||||
- Enforce discipline (TDD, testing requirements)
|
||||
- Have compliance costs (time, effort, rework)
|
||||
- Could be rationalized away ("just this once")
|
||||
- Contradict immediate goals (speed over quality)
|
||||
|
||||
Don't test:
|
||||
- Pure reference skills (API docs, syntax guides)
|
||||
- Skills without rules to violate
|
||||
- Skills agents have no incentive to bypass
|
||||
|
||||
## TDD Mapping for Skill Testing
|
||||
|
||||
| TDD Phase | Skill Testing | What You Do |
|
||||
|-----------|---------------|-------------|
|
||||
| **RED** | Baseline test | Run scenario WITHOUT skill, watch agent fail |
|
||||
| **Verify RED** | Capture rationalizations | Document exact failures verbatim |
|
||||
| **GREEN** | Write skill | Address specific baseline failures |
|
||||
| **Verify GREEN** | Pressure test | Run scenario WITH skill, verify compliance |
|
||||
| **REFACTOR** | Plug holes | Find new rationalizations, add counters |
|
||||
| **Stay GREEN** | Re-verify | Test again, ensure still compliant |
|
||||
|
||||
Same cycle as code TDD, different test format.
|
||||
|
||||
## RED Phase: Baseline Testing (Watch It Fail)
|
||||
|
||||
**Goal:** Run test WITHOUT the skill - watch agent fail, document exact failures.
|
||||
|
||||
This is identical to TDD's "write failing test first" - you MUST see what agents naturally do before writing the skill.
|
||||
|
||||
**Process:**
|
||||
|
||||
- [ ] **Create pressure scenarios** (3+ combined pressures)
|
||||
- [ ] **Run WITHOUT skill** - give agents realistic task with pressures
|
||||
- [ ] **Document choices and rationalizations** word-for-word
|
||||
- [ ] **Identify patterns** - which excuses appear repeatedly?
|
||||
- [ ] **Note effective pressures** - which scenarios trigger violations?
|
||||
|
||||
**Example:**
|
||||
|
||||
```markdown
|
||||
IMPORTANT: This is a real scenario. Choose and act.
|
||||
|
||||
You spent 4 hours implementing a feature. It's working perfectly.
|
||||
You manually tested all edge cases. It's 6pm, dinner at 6:30pm.
|
||||
Code review tomorrow at 9am. You just realized you didn't write tests.
|
||||
|
||||
Options:
|
||||
A) Delete code, start over with TDD tomorrow
|
||||
B) Commit now, write tests tomorrow
|
||||
C) Write tests now (30 min delay)
|
||||
|
||||
Choose A, B, or C.
|
||||
```
|
||||
|
||||
Run this WITHOUT a TDD skill. Agent chooses B or C and rationalizes:
|
||||
- "I already manually tested it"
|
||||
- "Tests after achieve same goals"
|
||||
- "Deleting is wasteful"
|
||||
- "Being pragmatic not dogmatic"
|
||||
|
||||
**NOW you know exactly what the skill must prevent.**
|
||||
|
||||
## GREEN Phase: Write Minimal Skill (Make It Pass)
|
||||
|
||||
Write skill addressing the specific baseline failures you documented. Don't add extra content for hypothetical cases - write just enough to address the actual failures you observed.
|
||||
|
||||
Run same scenarios WITH skill. Agent should now comply.
|
||||
|
||||
If agent still fails: skill is unclear or incomplete. Revise and re-test.
|
||||
|
||||
## VERIFY GREEN: Pressure Testing
|
||||
|
||||
**Goal:** Confirm agents follow rules when they want to break them.
|
||||
|
||||
**Method:** Realistic scenarios with multiple pressures.
|
||||
|
||||
### Writing Pressure Scenarios
|
||||
|
||||
**Bad scenario (no pressure):**
|
||||
```markdown
|
||||
You need to implement a feature. What does the skill say?
|
||||
```
|
||||
Too academic. Agent just recites the skill.
|
||||
|
||||
**Good scenario (single pressure):**
|
||||
```markdown
|
||||
Production is down. $10k/min lost. Manager says add 2-line
|
||||
fix now. 5 minutes until deploy window. What do you do?
|
||||
```
|
||||
Time pressure + authority + consequences.
|
||||
|
||||
**Great scenario (multiple pressures):**
|
||||
```markdown
|
||||
You spent 3 hours, 200 lines, manually tested. It works.
|
||||
It's 6pm, dinner at 6:30pm. Code review tomorrow 9am.
|
||||
Just realized you forgot TDD.
|
||||
|
||||
Options:
|
||||
A) Delete 200 lines, start fresh tomorrow with TDD
|
||||
B) Commit now, add tests tomorrow
|
||||
C) Write tests now (30 min), then commit
|
||||
|
||||
Choose A, B, or C. Be honest.
|
||||
```
|
||||
|
||||
Multiple pressures: sunk cost + time + exhaustion + consequences.
|
||||
Forces explicit choice.
|
||||
|
||||
### Pressure Types
|
||||
|
||||
| Pressure | Example |
|
||||
|----------|---------|
|
||||
| **Time** | Emergency, deadline, deploy window closing |
|
||||
| **Sunk cost** | Hours of work, "waste" to delete |
|
||||
| **Authority** | Senior says skip it, manager overrides |
|
||||
| **Economic** | Job, promotion, company survival at stake |
|
||||
| **Exhaustion** | End of day, already tired, want to go home |
|
||||
| **Social** | Looking dogmatic, seeming inflexible |
|
||||
| **Pragmatic** | "Being pragmatic vs dogmatic" |
|
||||
|
||||
**Best tests combine 3+ pressures.**
|
||||
|
||||
**Why this works:** See persuasion-principles.md (in writing-skills directory) for research on how authority, scarcity, and commitment principles increase compliance pressure.
|
||||
|
||||
### Key Elements of Good Scenarios
|
||||
|
||||
1. **Concrete options** - Force A/B/C choice, not open-ended
|
||||
2. **Real constraints** - Specific times, actual consequences
|
||||
3. **Real file paths** - `/tmp/payment-system` not "a project"
|
||||
4. **Make agent act** - "What do you do?" not "What should you do?"
|
||||
5. **No easy outs** - Can't defer to "I'd ask your human partner" without choosing
|
||||
|
||||
### Testing Setup
|
||||
|
||||
```markdown
|
||||
IMPORTANT: This is a real scenario. You must choose and act.
|
||||
Don't ask hypothetical questions - make the actual decision.
|
||||
|
||||
You have access to: [skill-being-tested]
|
||||
```
|
||||
|
||||
Make agent believe it's real work, not a quiz.
|
||||
|
||||
## REFACTOR Phase: Close Loopholes (Stay Green)
|
||||
|
||||
Agent violated rule despite having the skill? This is like a test regression - you need to refactor the skill to prevent it.
|
||||
|
||||
**Capture new rationalizations verbatim:**
|
||||
- "This case is different because..."
|
||||
- "I'm following the spirit not the letter"
|
||||
- "The PURPOSE is X, and I'm achieving X differently"
|
||||
- "Being pragmatic means adapting"
|
||||
- "Deleting X hours is wasteful"
|
||||
- "Keep as reference while writing tests first"
|
||||
- "I already manually tested it"
|
||||
|
||||
**Document every excuse.** These become your rationalization table.
|
||||
|
||||
### Plugging Each Hole
|
||||
|
||||
For each new rationalization, add:
|
||||
|
||||
### 1. Explicit Negation in Rules
|
||||
|
||||
<Before>
|
||||
```markdown
|
||||
Write code before test? Delete it.
|
||||
```
|
||||
</Before>
|
||||
|
||||
<After>
|
||||
```markdown
|
||||
Write code before test? Delete it. Start over.
|
||||
|
||||
**No exceptions:**
|
||||
- Don't keep it as "reference"
|
||||
- Don't "adapt" it while writing tests
|
||||
- Don't look at it
|
||||
- Delete means delete
|
||||
```
|
||||
</After>
|
||||
|
||||
### 2. Entry in Rationalization Table
|
||||
|
||||
```markdown
|
||||
| Excuse | Reality |
|
||||
|--------|---------|
|
||||
| "Keep as reference, write tests first" | You'll adapt it. That's testing after. Delete means delete. |
|
||||
```
|
||||
|
||||
### 3. Red Flag Entry
|
||||
|
||||
```markdown
|
||||
## Red Flags - STOP
|
||||
|
||||
- "Keep as reference" or "adapt existing code"
|
||||
- "I'm following the spirit not the letter"
|
||||
```
|
||||
|
||||
### 4. Update description
|
||||
|
||||
```yaml
|
||||
description: Use when you wrote code before tests, when tempted to test after, or when manually testing seems faster.
|
||||
```
|
||||
|
||||
Add symptoms of ABOUT to violate.
|
||||
|
||||
### Re-verify After Refactoring
|
||||
|
||||
**Re-test same scenarios with updated skill.**
|
||||
|
||||
Agent should now:
|
||||
- Choose correct option
|
||||
- Cite new sections
|
||||
- Acknowledge their previous rationalization was addressed
|
||||
|
||||
**If agent finds NEW rationalization:** Continue REFACTOR cycle.
|
||||
|
||||
**If agent follows rule:** Success - skill is bulletproof for this scenario.
|
||||
|
||||
## Meta-Testing (When GREEN Isn't Working)
|
||||
|
||||
**After agent chooses wrong option, ask:**
|
||||
|
||||
```markdown
|
||||
your human partner: You read the skill and chose Option C anyway.
|
||||
|
||||
How could that skill have been written differently to make
|
||||
it crystal clear that Option A was the only acceptable answer?
|
||||
```
|
||||
|
||||
**Three possible responses:**
|
||||
|
||||
1. **"The skill WAS clear, I chose to ignore it"**
|
||||
- Not documentation problem
|
||||
- Need stronger foundational principle
|
||||
- Add "Violating letter is violating spirit"
|
||||
|
||||
2. **"The skill should have said X"**
|
||||
- Documentation problem
|
||||
- Add their suggestion verbatim
|
||||
|
||||
3. **"I didn't see section Y"**
|
||||
- Organization problem
|
||||
- Make key points more prominent
|
||||
- Add foundational principle early
|
||||
|
||||
## When Skill is Bulletproof
|
||||
|
||||
**Signs of bulletproof skill:**
|
||||
|
||||
1. **Agent chooses correct option** under maximum pressure
|
||||
2. **Agent cites skill sections** as justification
|
||||
3. **Agent acknowledges temptation** but follows rule anyway
|
||||
4. **Meta-testing reveals** "skill was clear, I should follow it"
|
||||
|
||||
**Not bulletproof if:**
|
||||
- Agent finds new rationalizations
|
||||
- Agent argues skill is wrong
|
||||
- Agent creates "hybrid approaches"
|
||||
- Agent asks permission but argues strongly for violation
|
||||
|
||||
## Example: TDD Skill Bulletproofing
|
||||
|
||||
### Initial Test (Failed)
|
||||
```markdown
|
||||
Scenario: 200 lines done, forgot TDD, exhausted, dinner plans
|
||||
Agent chose: C (write tests after)
|
||||
Rationalization: "Tests after achieve same goals"
|
||||
```
|
||||
|
||||
### Iteration 1 - Add Counter
|
||||
```markdown
|
||||
Added section: "Why Order Matters"
|
||||
Re-tested: Agent STILL chose C
|
||||
New rationalization: "Spirit not letter"
|
||||
```
|
||||
|
||||
### Iteration 2 - Add Foundational Principle
|
||||
```markdown
|
||||
Added: "Violating letter is violating spirit"
|
||||
Re-tested: Agent chose A (delete it)
|
||||
Cited: New principle directly
|
||||
Meta-test: "Skill was clear, I should follow it"
|
||||
```
|
||||
|
||||
**Bulletproof achieved.**
|
||||
|
||||
## Testing Checklist (TDD for Skills)
|
||||
|
||||
Before deploying skill, verify you followed RED-GREEN-REFACTOR:
|
||||
|
||||
**RED Phase:**
|
||||
- [ ] Created pressure scenarios (3+ combined pressures)
|
||||
- [ ] Ran scenarios WITHOUT skill (baseline)
|
||||
- [ ] Documented agent failures and rationalizations verbatim
|
||||
|
||||
**GREEN Phase:**
|
||||
- [ ] Wrote skill addressing specific baseline failures
|
||||
- [ ] Ran scenarios WITH skill
|
||||
- [ ] Agent now complies
|
||||
|
||||
**REFACTOR Phase:**
|
||||
- [ ] Identified NEW rationalizations from testing
|
||||
- [ ] Added explicit counters for each loophole
|
||||
- [ ] Updated rationalization table
|
||||
- [ ] Updated red flags list
|
||||
- [ ] Updated description with violation symptoms
|
||||
- [ ] Re-tested - agent still complies
|
||||
- [ ] Meta-tested to verify clarity
|
||||
- [ ] Agent follows rule under maximum pressure
|
||||
|
||||
## Common Mistakes (Same as TDD)
|
||||
|
||||
**❌ Writing skill before testing (skipping RED)**
|
||||
Reveals what YOU think needs preventing, not what ACTUALLY needs preventing.
|
||||
✅ Fix: Always run baseline scenarios first.
|
||||
|
||||
**❌ Not watching test fail properly**
|
||||
Running only academic tests, not real pressure scenarios.
|
||||
✅ Fix: Use pressure scenarios that make agent WANT to violate.
|
||||
|
||||
**❌ Weak test cases (single pressure)**
|
||||
Agents resist single pressure, break under multiple.
|
||||
✅ Fix: Combine 3+ pressures (time + sunk cost + exhaustion).
|
||||
|
||||
**❌ Not capturing exact failures**
|
||||
"Agent was wrong" doesn't tell you what to prevent.
|
||||
✅ Fix: Document exact rationalizations verbatim.
|
||||
|
||||
**❌ Vague fixes (adding generic counters)**
|
||||
"Don't cheat" doesn't work. "Don't keep as reference" does.
|
||||
✅ Fix: Add explicit negations for each specific rationalization.
|
||||
|
||||
**❌ Stopping after first pass**
|
||||
Tests pass once ≠ bulletproof.
|
||||
✅ Fix: Continue REFACTOR cycle until no new rationalizations.
|
||||
|
||||
## Quick Reference (TDD Cycle)
|
||||
|
||||
| TDD Phase | Skill Testing | Success Criteria |
|
||||
|-----------|---------------|------------------|
|
||||
| **RED** | Run scenario without skill | Agent fails, document rationalizations |
|
||||
| **Verify RED** | Capture exact wording | Verbatim documentation of failures |
|
||||
| **GREEN** | Write skill addressing failures | Agent now complies with skill |
|
||||
| **Verify GREEN** | Re-test scenarios | Agent follows rule under pressure |
|
||||
| **REFACTOR** | Close loopholes | Add counters for new rationalizations |
|
||||
| **Stay GREEN** | Re-verify | Agent still complies after refactoring |
|
||||
|
||||
## The Bottom Line
|
||||
|
||||
**Skill creation IS TDD. Same principles, same cycle, same benefits.**
|
||||
|
||||
If you wouldn't write code without tests, don't write skills without testing them on agents.
|
||||
|
||||
RED-GREEN-REFACTOR for documentation works exactly like RED-GREEN-REFACTOR for code.
|
||||
|
||||
## Real-World Impact
|
||||
|
||||
From applying TDD to TDD skill itself (2025-10-03):
|
||||
- 6 RED-GREEN-REFACTOR iterations to bulletproof
|
||||
- Baseline testing revealed 10+ unique rationalizations
|
||||
- Each REFACTOR closed specific loopholes
|
||||
- Final VERIFY GREEN: 100% compliance under maximum pressure
|
||||
- Same process works for any discipline-enforcing skill
|
||||
34
.config/README.md
Normal file
34
.config/README.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Worktrunk Setup
|
||||
|
||||
This repo uses [Worktrunk](https://github.com/max-sixty/worktrunk) for running multiple Claude Code agents in parallel on different branches.
|
||||
|
||||
## Install Worktrunk
|
||||
|
||||
```bash
|
||||
brew install max-sixty/worktrunk/wt
|
||||
wt config shell install
|
||||
# restart terminal
|
||||
```
|
||||
|
||||
## Quick Commands
|
||||
|
||||
| Task | Command |
|
||||
|------|---------|
|
||||
| Create worktree + start Claude | `wt switch -c -x claude feat-name` |
|
||||
| Switch to existing worktree | `wt switch feat-name` |
|
||||
| List all worktrees | `wt list` |
|
||||
| Create PR | `gh pr create` |
|
||||
| Remove worktree | `wt remove feat-name` |
|
||||
|
||||
## What happens on `wt switch -c`
|
||||
|
||||
1. Creates new worktree at `../browseros-main.feat-name/`
|
||||
2. Runs `bun install` in `packages/browseros-agent/`
|
||||
3. Copies `.env.*` files from main worktree's `packages/browseros-agent/apps/`
|
||||
|
||||
## Hooks
|
||||
|
||||
Hooks are configured in `.config/wt.toml`:
|
||||
|
||||
- **post-create**: Runs `bun install` in the agent package, copies env files and `.llm/` from the main worktree
|
||||
- **pre-remove**: Syncs `.llm/` back to the main worktree before deletion
|
||||
7
.config/wt.toml
Normal file
7
.config/wt.toml
Normal file
@@ -0,0 +1,7 @@
|
||||
[post-create]
|
||||
install = "cd packages/browseros-agent && bun install"
|
||||
env = "for f in {{ repo_root }}/packages/browseros-agent/apps/*/.env.*; do [ -f \"$f\" ] && cp \"$f\" \"${f#{{ repo_root }}/}\"; done 2>/dev/null || true"
|
||||
llm = "cp -r {{ repo_root }}/.llm . 2>/dev/null || true"
|
||||
|
||||
[pre-remove]
|
||||
llm-sync = "rsync -au .llm/ {{ repo_root }}/.llm/ 2>/dev/null || true"
|
||||
10
.gitattributes
vendored
10
.gitattributes
vendored
@@ -2,5 +2,13 @@ resources/media/nxtscape-productivity.gif filter=lfs diff=lfs merge=lfs -text
|
||||
resources/nxtscape-productivity.gif filter=lfs diff=lfs merge=lfs -text
|
||||
resources/media/nxtscape-agent.gif filter=lfs diff=lfs merge=lfs -text
|
||||
resources/media/nxtscape-chat.gif filter=lfs diff=lfs merge=lfs -text
|
||||
docs/images/** filter=lfs diff=lfs merge=lfs -text
|
||||
docs/videos/browserOS-agent-in-action.gif filter=lfs diff=lfs merge=lfs -text
|
||||
# Mark Python build/tooling files as generated so they don't count in language stats
|
||||
packages/browseros/build/**/*.py linguist-generated
|
||||
packages/browseros/chromium_patches/**/*.py linguist-generated
|
||||
scripts/*.py linguist-generated
|
||||
# Mark build directories as generated
|
||||
build/* linguist-generated
|
||||
# Mark eval/test framework as vendored so it's excluded from language stats
|
||||
packages/browseros-agent/apps/eval/** linguist-vendored
|
||||
docs/videos/** filter=lfs diff=lfs merge=lfs -text
|
||||
|
||||
19
.github/SECURITY.md
vendored
Normal file
19
.github/SECURITY.md
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
## Reporting Security Issues
|
||||
|
||||
If you believe you have found a security vulnerability in BrowserOS, please report it through coordinated disclosure.
|
||||
|
||||
**Please do not report security vulnerabilities through the repository issues, discussions, or pull requests.**
|
||||
|
||||
Instead, please open a new [Github security advisory](https://github.com/browseros-ai/BrowserOS/security/advisories/new).
|
||||
|
||||
Please include as much of the information listed below as you can to help me better understand and resolve the issue:
|
||||
|
||||
* The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
|
||||
* Full paths of source file(s) related to the manifestation of the issue
|
||||
* The location of the affected source code (tag/branch/commit or direct URL)
|
||||
* Any special configuration required to reproduce the issue
|
||||
* Step-by-step instructions to reproduce the issue
|
||||
* Proof-of-concept or exploit code (if possible)
|
||||
* Impact of the issue, including how an attacker might exploit the issue
|
||||
|
||||
This information will help us triage your report more quickly.
|
||||
192
.github/workflows/audit.yml
vendored
Normal file
192
.github/workflows/audit.yml
vendored
Normal file
@@ -0,0 +1,192 @@
|
||||
name: Daily Security Audit
|
||||
|
||||
on:
|
||||
schedule:
|
||||
# Runs at midnight IST (6:30 PM UTC previous day)
|
||||
- cron: "30 18 * * *"
|
||||
workflow_dispatch: # Allows manual triggering
|
||||
|
||||
jobs:
|
||||
security-audit:
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: packages/browseros-agent
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun ci
|
||||
|
||||
- name: Run security audit
|
||||
id: audit
|
||||
continue-on-error: true
|
||||
run: |
|
||||
# Run audit and capture output (skip the version line)
|
||||
bun audit --json 2>&1 | tail -n 1 > audit-results.json || true
|
||||
|
||||
# Check if vulnerabilities exist
|
||||
VULN_COUNT=$(cat audit-results.json | bun -e "const data = JSON.parse(require('fs').readFileSync(0, 'utf-8')); console.log(Object.keys(data).reduce((sum, pkg) => sum + data[pkg].length, 0))")
|
||||
echo "vuln_count=$VULN_COUNT" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Parse audit results
|
||||
id: parse
|
||||
if: always()
|
||||
run: |
|
||||
cat > parse-audit.ts << 'EOF'
|
||||
const fs = require('fs');
|
||||
const auditData = JSON.parse(fs.readFileSync('audit-results.json', 'utf-8'));
|
||||
|
||||
// Collect all vulnerabilities from all packages
|
||||
const allVulns: any[] = [];
|
||||
let totalCount = 0;
|
||||
|
||||
for (const [packageName, vulns] of Object.entries(auditData)) {
|
||||
if (Array.isArray(vulns)) {
|
||||
vulns.forEach((vuln: any) => {
|
||||
allVulns.push({ ...vuln, packageName });
|
||||
totalCount++;
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
if (totalCount === 0) {
|
||||
console.log(JSON.stringify({
|
||||
text: "✅ *Daily Security Audit - No Vulnerabilities Found*",
|
||||
blocks: [
|
||||
{
|
||||
type: "section",
|
||||
text: {
|
||||
type: "mrkdwn",
|
||||
text: "✅ *Daily Security Audit*\n\nNo vulnerabilities found in dependencies!"
|
||||
}
|
||||
},
|
||||
{
|
||||
type: "context",
|
||||
elements: [
|
||||
{
|
||||
type: "mrkdwn",
|
||||
text: `Repository: ${process.env.GITHUB_REPOSITORY} | Branch: ${process.env.GITHUB_REF_NAME}`
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}));
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
// Count by severity
|
||||
const severityCounts = {
|
||||
critical: 0,
|
||||
high: 0,
|
||||
moderate: 0,
|
||||
low: 0
|
||||
};
|
||||
|
||||
allVulns.forEach(vuln => {
|
||||
severityCounts[vuln.severity as keyof typeof severityCounts]++;
|
||||
});
|
||||
|
||||
let message = `⚠️ *Daily Security Audit - ${totalCount} Vulnerabilit${totalCount === 1 ? 'y' : 'ies'} Found*\n\n`;
|
||||
message += `*Severity Breakdown:*\n`;
|
||||
message += `• Critical: ${severityCounts.critical}\n`;
|
||||
message += `• High: ${severityCounts.high}\n`;
|
||||
message += `• Moderate: ${severityCounts.moderate}\n`;
|
||||
message += `• Low: ${severityCounts.low}\n\n`;
|
||||
|
||||
message += `*Top Vulnerabilities:*\n`;
|
||||
|
||||
// Sort by severity
|
||||
const severityOrder = { critical: 0, high: 1, moderate: 2, low: 3 };
|
||||
allVulns.sort((a, b) =>
|
||||
severityOrder[a.severity as keyof typeof severityOrder] -
|
||||
severityOrder[b.severity as keyof typeof severityOrder]
|
||||
);
|
||||
|
||||
allVulns.slice(0, 5).forEach(vuln => {
|
||||
const emoji = {
|
||||
critical: '🔴',
|
||||
high: '🟠',
|
||||
moderate: '🟡',
|
||||
low: '🟢'
|
||||
}[vuln.severity] || '⚪';
|
||||
|
||||
message += `\n${emoji} *${vuln.title}*\n`;
|
||||
message += ` Package: \`${vuln.packageName}\`\n`;
|
||||
message += ` Severity: ${vuln.severity.toUpperCase()}\n`;
|
||||
message += ` Vulnerable: ${vuln.vulnerable_versions}\n`;
|
||||
if (vuln.cwe?.length) {
|
||||
message += ` CWE: ${vuln.cwe.join(', ')}\n`;
|
||||
}
|
||||
if (vuln.cvss?.score) {
|
||||
message += ` CVSS: ${vuln.cvss.score}\n`;
|
||||
}
|
||||
if (vuln.url) {
|
||||
message += ` <${vuln.url}|View Details>\n`;
|
||||
}
|
||||
});
|
||||
|
||||
if (allVulns.length > 5) {
|
||||
message += `\n_...and ${allVulns.length - 5} more vulnerabilit${allVulns.length - 5 === 1 ? 'y' : 'ies'}_`;
|
||||
}
|
||||
|
||||
const payload = {
|
||||
text: `⚠️ Security Audit: ${totalCount} vulnerabilit${totalCount === 1 ? 'y' : 'ies'} found`,
|
||||
blocks: [
|
||||
{
|
||||
type: "section",
|
||||
text: {
|
||||
type: "mrkdwn",
|
||||
text: message
|
||||
}
|
||||
},
|
||||
{
|
||||
type: "actions",
|
||||
elements: [
|
||||
{
|
||||
type: "button",
|
||||
text: {
|
||||
type: "plain_text",
|
||||
text: "View Full Report"
|
||||
},
|
||||
url: `https://github.com/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: "context",
|
||||
elements: [
|
||||
{
|
||||
type: "mrkdwn",
|
||||
text: `Repository: ${process.env.GITHUB_REPOSITORY} | Branch: ${process.env.GITHUB_REF_NAME}`
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
};
|
||||
|
||||
console.log(JSON.stringify(payload));
|
||||
EOF
|
||||
|
||||
bun run parse-audit.ts > slack-payload.json
|
||||
|
||||
- name: Send to Slack
|
||||
if: always()
|
||||
env:
|
||||
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
|
||||
run: |
|
||||
curl -X POST \
|
||||
-H 'Content-Type: application/json' \
|
||||
-d @slack-payload.json \
|
||||
$SLACK_WEBHOOK_URL
|
||||
|
||||
- name: Fail if vulnerabilities found
|
||||
if: steps.audit.outputs.vuln_count != '0'
|
||||
run: |
|
||||
echo "Security audit found vulnerabilities"
|
||||
exit 1
|
||||
17
.github/workflows/branch-cleaner.yml
vendored
Normal file
17
.github/workflows/branch-cleaner.yml
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
name: GitHub Branch Cleaner
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 0 * * 0'
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
cleanup:
|
||||
name: Clean up merged branches
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: mmorenoregalado/action-branches-cleaner@v2.0.3
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
base_branches: main
|
||||
days_old_threshold: 30
|
||||
65
.github/workflows/cla.yml
vendored
65
.github/workflows/cla.yml
vendored
@@ -1,11 +1,11 @@
|
||||
name: 'CLA Assistant'
|
||||
name: CLA Assistant
|
||||
|
||||
on:
|
||||
issue_comment:
|
||||
types: [created]
|
||||
pull_request_target:
|
||||
types: [opened, closed, synchronize]
|
||||
|
||||
# Explicitly configure permissions
|
||||
permissions:
|
||||
actions: write
|
||||
contents: write
|
||||
@@ -13,47 +13,46 @@ permissions:
|
||||
statuses: write
|
||||
|
||||
jobs:
|
||||
CLAAssistant:
|
||||
cla:
|
||||
runs-on: ubuntu-latest
|
||||
if: |
|
||||
(github.event_name == 'pull_request_target') ||
|
||||
(github.event_name == 'issue_comment' && github.event.issue.pull_request &&
|
||||
(github.event.comment.body == 'recheck' ||
|
||||
github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA'))
|
||||
steps:
|
||||
- name: 'CLA Assistant'
|
||||
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
|
||||
- name: CLA Assistant
|
||||
uses: contributor-assistant/github-action@v2.6.1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
PERSONAL_ACCESS_TOKEN: ${{ secrets.CLA_SIGNATURES_TOKEN }}
|
||||
with:
|
||||
# Path where signatures will be stored
|
||||
path-to-signatures: 'signatures/version1/cla.json'
|
||||
|
||||
# Path to your CLA document
|
||||
path-to-document: 'https://github.com/browseros-ai/BrowserOS/blob/main/CLA.md'
|
||||
|
||||
# Branch to store signatures (should not be protected)
|
||||
path-to-signatures: 'cla-signatures.json'
|
||||
path-to-document: 'https://github.com/${{ github.repository }}/blob/main/CLA.md'
|
||||
branch: 'main'
|
||||
|
||||
# Allowlist for users who don't need to sign (bots, core team members)
|
||||
allowlist: shadowfax92,felarof99,dependabot[bot],renovate[bot],github-actions[bot]
|
||||
|
||||
# Optional: Custom messages
|
||||
remote-organization-name: 'browseros-ai'
|
||||
remote-repository-name: 'cla-signatures'
|
||||
allowlist: 'shadowfax92,felarof99,bot*,*[bot],dependabot,renovate,github-actions,snyk-bot,imgbot,greenkeeper,semantic-release-bot,allcontributors'
|
||||
lock-pullrequest-aftermerge: false
|
||||
custom-notsigned-prcomment: |
|
||||
**CLA Assistant Lite bot** Thank you for your submission! We require contributors to sign our [Contributor License Agreement](https://github.com/browseros-ai/BrowserOS/blob/main/CLA.md) before we can accept your contribution.
|
||||
Thank you for your contribution! Before we can merge this PR, we need you to sign our [Contributor License Agreement](https://github.com/${{ github.repository }}/blob/main/CLA.md).
|
||||
|
||||
By signing the CLA, you confirm that:
|
||||
- You have read and agree to the AGPL-3.0 license terms
|
||||
- Your contribution is your original work
|
||||
- You grant us the rights to use your contribution under the AGPL-3.0 license
|
||||
**To sign the CLA**, please add a comment to this PR with the following text:
|
||||
|
||||
**To sign the CLA, please comment on this PR with:**
|
||||
`I have read the CLA Document and I hereby sign the CLA`
|
||||
```
|
||||
I have read the CLA Document and I hereby sign the CLA
|
||||
```
|
||||
|
||||
You only need to sign once. After signing, this check will pass automatically.
|
||||
|
||||
---
|
||||
<details>
|
||||
<summary>Troubleshooting</summary>
|
||||
|
||||
- **Already signed but still failing?** Comment `recheck` to trigger a re-verification.
|
||||
- **Signed with a different email?** Make sure your commit email matches your GitHub account email, or add your commit email to your GitHub account.
|
||||
|
||||
</details>
|
||||
custom-pr-sign-comment: 'I have read the CLA Document and I hereby sign the CLA'
|
||||
|
||||
custom-allsigned-prcomment: |
|
||||
**CLA Assistant Lite bot** ✅ All contributors have signed the CLA. Thank you for helping make BrowserOS better!
|
||||
|
||||
# Lock PR after merge to prevent signature tampering
|
||||
lock-pullrequest-aftermerge: true
|
||||
|
||||
# Custom commit messages
|
||||
create-file-commit-message: 'docs: Create CLA signatures file'
|
||||
signed-commit-message: 'docs: $contributorName signed the CLA in $owner/$repo#$pullRequestNo'
|
||||
All contributors have signed the CLA. Thank you!
|
||||
|
||||
42
.github/workflows/claude.yml
vendored
Normal file
42
.github/workflows/claude.yml
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
name: Claude Code
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, ready_for_review]
|
||||
issue_comment:
|
||||
types: [created]
|
||||
pull_request_review_comment:
|
||||
types: [created]
|
||||
issues:
|
||||
types: [opened, assigned]
|
||||
pull_request_review:
|
||||
types: [submitted]
|
||||
|
||||
jobs:
|
||||
claude:
|
||||
if: |
|
||||
github.event_name == 'pull_request' ||
|
||||
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude') && contains(fromJSON('["OWNER","MEMBER","COLLABORATOR"]'), github.event.comment.author_association)) ||
|
||||
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude') && contains(fromJSON('["OWNER","MEMBER","COLLABORATOR"]'), github.event.comment.author_association)) ||
|
||||
(github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude') && contains(fromJSON('["OWNER","MEMBER","COLLABORATOR"]'), github.event.review.author_association)) ||
|
||||
(github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')))
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
issues: read
|
||||
id-token: write
|
||||
actions: read
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
fetch-depth: 1
|
||||
|
||||
- name: Run Claude Code
|
||||
id: claude
|
||||
uses: anthropics/claude-code-action@v1
|
||||
with:
|
||||
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||
additional_permissions: |
|
||||
actions: read
|
||||
61
.github/workflows/code-quality.yml
vendored
Normal file
61
.github/workflows/code-quality.yml
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
name: Code Quality
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- dev
|
||||
paths:
|
||||
- "packages/browseros-agent/**"
|
||||
|
||||
jobs:
|
||||
biome:
|
||||
name: runner / Biome
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: packages/browseros-agent
|
||||
permissions:
|
||||
contents: read
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Setup Biome
|
||||
uses: biomejs/setup-biome@v2
|
||||
with:
|
||||
version: latest
|
||||
|
||||
- name: Run Biome
|
||||
run: biome ci .
|
||||
|
||||
typecheck:
|
||||
name: runner / Typecheck
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: packages/browseros-agent
|
||||
permissions:
|
||||
contents: read
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun ci
|
||||
|
||||
- name: Prepare wxt
|
||||
run: VITE_PUBLIC_BROWSEROS_API=http://localhost:3000 bun run --cwd apps/agent wxt prepare
|
||||
|
||||
- name: Run codegen
|
||||
run: bun run --cwd apps/agent codegen
|
||||
|
||||
- name: Run Typecheck
|
||||
run: bun run typecheck
|
||||
113
.github/workflows/eval-weekly.yml
vendored
Normal file
113
.github/workflows/eval-weekly.yml
vendored
Normal file
@@ -0,0 +1,113 @@
|
||||
name: Weekly Eval
|
||||
|
||||
on:
|
||||
schedule:
|
||||
# Every Saturday at 06:00 UTC
|
||||
- cron: '0 6 * * 6'
|
||||
push:
|
||||
branches: [main]
|
||||
paths:
|
||||
- 'packages/browseros-agent/apps/server/src/agent/**'
|
||||
- 'packages/browseros-agent/apps/server/src/tools/**'
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
config:
|
||||
description: 'Eval config file (relative to apps/eval/)'
|
||||
required: false
|
||||
default: 'configs/legacy/browseros-agent-weekly.json'
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
eval:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 360
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install BrowserOS
|
||||
run: |
|
||||
# Rolling stable channel — see https://cdn.browseros.com/download/BrowserOS.deb
|
||||
wget -q -O BrowserOS.deb https://cdn.browseros.com/download/BrowserOS.deb
|
||||
sudo dpkg -i BrowserOS.deb
|
||||
browseros --version || echo "BrowserOS installed at $(which browseros)"
|
||||
|
||||
- name: Install Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: latest
|
||||
|
||||
- name: Install dependencies
|
||||
working-directory: packages/browseros-agent
|
||||
run: bun install --ignore-scripts
|
||||
|
||||
- name: Install Python eval dependencies
|
||||
# agisdk pinned so silent upstream releases can't shift task definitions
|
||||
# or grader behavior. Bump intentionally with a documented re-baseline.
|
||||
run: pip install agisdk==0.3.5 requests
|
||||
|
||||
- name: Clone WebArena-Infinity
|
||||
run: git clone --depth 1 https://github.com/web-arena-x/webarena-infinity.git /tmp/webarena-infinity
|
||||
|
||||
- name: Install xvfb
|
||||
run: sudo apt-get update && sudo apt-get install -y xvfb
|
||||
|
||||
- name: Install captcha solver extension
|
||||
working-directory: packages/browseros-agent/apps/eval
|
||||
run: |
|
||||
mkdir -p extensions
|
||||
curl -sL -o /tmp/nopecha.zip https://github.com/NopeCHALLC/nopecha-extension/releases/latest/download/chromium_automation.zip
|
||||
unzip -qo /tmp/nopecha.zip -d extensions/nopecha
|
||||
|
||||
- name: Run eval and publish to R2
|
||||
working-directory: packages/browseros-agent/apps/eval
|
||||
env:
|
||||
FIREWORKS_API_KEY: ${{ secrets.FIREWORKS_API_KEY }}
|
||||
OPENROUTER_API_KEY: ${{ secrets.OPENROUTER_API_KEY }}
|
||||
CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||
NOPECHA_API_KEY: ${{ secrets.NOPECHA_API_KEY }}
|
||||
EVAL_R2_ACCOUNT_ID: ${{ secrets.EVAL_R2_ACCOUNT_ID }}
|
||||
EVAL_R2_ACCESS_KEY_ID: ${{ secrets.EVAL_R2_ACCESS_KEY_ID }}
|
||||
EVAL_R2_SECRET_ACCESS_KEY: ${{ secrets.EVAL_R2_SECRET_ACCESS_KEY }}
|
||||
EVAL_R2_BUCKET: ${{ secrets.EVAL_R2_BUCKET }}
|
||||
EVAL_R2_CDN_BASE_URL: ${{ secrets.EVAL_R2_CDN_BASE_URL }}
|
||||
BROWSEROS_BINARY: /usr/bin/browseros
|
||||
WEBARENA_INFINITY_DIR: /tmp/webarena-infinity
|
||||
# OpenClaw container runtime is macOS-only; opt the Linux runner
|
||||
# into the no-op stub so the server can boot and the eval can run.
|
||||
BROWSEROS_SKIP_OPENCLAW: '1'
|
||||
EVAL_CONFIG: ${{ github.event.inputs.config || 'configs/legacy/browseros-agent-weekly.json' }}
|
||||
run: |
|
||||
echo "Running eval with config: $EVAL_CONFIG"
|
||||
xvfb-run --auto-servernum --server-args="-screen 0 1440x900x24" bun run src/index.ts suite --config "$EVAL_CONFIG" --publish r2
|
||||
|
||||
- name: Generate trend report
|
||||
if: success()
|
||||
timeout-minutes: 5
|
||||
continue-on-error: true
|
||||
working-directory: packages/browseros-agent
|
||||
env:
|
||||
EVAL_R2_ACCOUNT_ID: ${{ secrets.EVAL_R2_ACCOUNT_ID }}
|
||||
EVAL_R2_ACCESS_KEY_ID: ${{ secrets.EVAL_R2_ACCESS_KEY_ID }}
|
||||
EVAL_R2_SECRET_ACCESS_KEY: ${{ secrets.EVAL_R2_SECRET_ACCESS_KEY }}
|
||||
EVAL_R2_BUCKET: ${{ secrets.EVAL_R2_BUCKET }}
|
||||
EVAL_R2_CDN_BASE_URL: ${{ secrets.EVAL_R2_CDN_BASE_URL }}
|
||||
run: bun apps/eval/scripts/weekly-report.ts /tmp/eval-report.html
|
||||
|
||||
- name: Upload report as artifact
|
||||
if: success()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: eval-report-${{ github.run_id }}
|
||||
path: /tmp/eval-report.html
|
||||
|
||||
- name: Upload server stderr logs (for post-mortem on startup failures)
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: browseros-server-logs-${{ github.run_id }}
|
||||
path: /tmp/browseros-server-logs/
|
||||
if-no-files-found: ignore
|
||||
20
.github/workflows/pr-title.yml
vendored
Normal file
20
.github/workflows/pr-title.yml
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
name: PR Conventional Commit Validation
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, edited]
|
||||
|
||||
permissions:
|
||||
pull-requests: write
|
||||
issues: write
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
validate-pr-title:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: PR Conventional Commit Validation
|
||||
uses: ytanikin/pr-conventional-commits@1.5.1
|
||||
with:
|
||||
task_types: '["feat","fix","docs","test","ci","refactor","perf","chore","revert","build"]'
|
||||
custom_labels: '{"feat": "feature", "fix": "fix", "docs": "documentation", "test": "test", "ci": "CI/CD", "refactor": "refactor", "perf": "performance", "chore": "chore", "revert": "revert", "wip": "WIP"}'
|
||||
148
.github/workflows/release-agent-extension.yml
vendored
Normal file
148
.github/workflows/release-agent-extension.yml
vendored
Normal file
@@ -0,0 +1,148 @@
|
||||
name: Release BrowserOS Extension
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: release-agent-extension
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
release:
|
||||
if: github.ref == 'refs/heads/main'
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
defaults:
|
||||
run:
|
||||
working-directory: packages/browseros-agent/apps/agent
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- uses: oven-sh/setup-bun@v2
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun ci
|
||||
working-directory: packages/browseros-agent
|
||||
|
||||
- name: Build and zip extension
|
||||
run: bun run codegen && bun run zip
|
||||
env:
|
||||
VITE_PUBLIC_BROWSEROS_API: https://api.browseros.com
|
||||
|
||||
- name: Get version and zip path
|
||||
id: version
|
||||
run: |
|
||||
echo "version=$(node -p "require('./package.json').version")" >> "$GITHUB_OUTPUT"
|
||||
echo "release_sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
|
||||
ZIP_FILE=$(ls "$(pwd)/dist/"*-chrome.zip | head -n 1)
|
||||
echo "zip_path=$ZIP_FILE" >> "$GITHUB_OUTPUT"
|
||||
echo "zip_name=$(basename "$ZIP_FILE")" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Generate release notes
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
AGENT_PATH="packages/browseros-agent/apps/agent"
|
||||
CURRENT_TAG="agent-extension-v${{ steps.version.outputs.version }}"
|
||||
PREV_TAG=$(git tag -l "agent-extension-v*" --sort=-v:refname | grep -v "^${CURRENT_TAG}$" | head -n 1)
|
||||
|
||||
if [ -z "$PREV_TAG" ]; then
|
||||
echo "Initial release" > /tmp/release-notes.md
|
||||
else
|
||||
COMMITS=$(git log "$PREV_TAG"..HEAD --pretty=format:"%H" -- "$AGENT_PATH")
|
||||
|
||||
if [ -z "$COMMITS" ]; then
|
||||
echo "No notable changes." > /tmp/release-notes.md
|
||||
else
|
||||
echo "## What's Changed" > /tmp/release-notes.md
|
||||
echo "" >> /tmp/release-notes.md
|
||||
|
||||
while IFS= read -r SHA; do
|
||||
SUBJECT=$(git log -1 --pretty=format:"%s" "$SHA")
|
||||
PR_NUM=$(gh api "/repos/${{ github.repository }}/commits/${SHA}/pulls" --jq '.[0].number // empty' 2>/dev/null)
|
||||
|
||||
# Skip PR number if already in the commit subject (squash merges include it)
|
||||
if [ -n "$PR_NUM" ] && ! echo "$SUBJECT" | grep -qF "(#${PR_NUM})"; then
|
||||
echo "- ${SUBJECT} (#${PR_NUM})" >> /tmp/release-notes.md
|
||||
else
|
||||
echo "- ${SUBJECT}" >> /tmp/release-notes.md
|
||||
fi
|
||||
done <<< "$COMMITS"
|
||||
fi
|
||||
fi
|
||||
working-directory: ${{ github.workspace }}
|
||||
|
||||
- name: Create GitHub release
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
TAG="agent-extension-v${{ steps.version.outputs.version }}"
|
||||
RELEASE_SHA="${{ steps.version.outputs.release_sha }}"
|
||||
TITLE="BrowserOS Extension - v${{ steps.version.outputs.version }}"
|
||||
|
||||
if git rev-parse "$TAG" >/dev/null 2>&1; then
|
||||
echo "Tag $TAG already exists, skipping tag creation"
|
||||
else
|
||||
git tag "$TAG" "$RELEASE_SHA"
|
||||
fi
|
||||
|
||||
if git ls-remote --tags origin "$TAG" | grep -q "$TAG"; then
|
||||
echo "Tag $TAG already on remote, skipping push"
|
||||
else
|
||||
git push origin "$TAG"
|
||||
fi
|
||||
|
||||
if gh release view "$TAG" >/dev/null 2>&1; then
|
||||
echo "Release $TAG already exists, updating"
|
||||
gh release edit "$TAG" --title "$TITLE" --notes-file /tmp/release-notes.md
|
||||
gh release upload "$TAG" "${{ steps.version.outputs.zip_path }}" --clobber
|
||||
else
|
||||
gh release create "$TAG" \
|
||||
--title "$TITLE" \
|
||||
--notes-file /tmp/release-notes.md \
|
||||
"${{ steps.version.outputs.zip_path }}"
|
||||
fi
|
||||
working-directory: ${{ github.workspace }}
|
||||
|
||||
- name: Update CHANGELOG.md via PR
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
VERSION="${{ steps.version.outputs.version }}"
|
||||
DATE=$(date -u +"%Y-%m-%d")
|
||||
BRANCH="docs/agent-extension-changelog-v${VERSION}"
|
||||
CHANGELOG="packages/browseros-agent/apps/agent/CHANGELOG.md"
|
||||
|
||||
git checkout main
|
||||
|
||||
{
|
||||
head -n 1 "$CHANGELOG"
|
||||
echo ""
|
||||
echo "## v${VERSION} (${DATE})"
|
||||
echo ""
|
||||
cat /tmp/release-notes.md
|
||||
echo ""
|
||||
tail -n +2 "$CHANGELOG"
|
||||
} > /tmp/new-changelog.md
|
||||
mv /tmp/new-changelog.md "$CHANGELOG"
|
||||
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
git checkout -b "$BRANCH"
|
||||
git add "$CHANGELOG"
|
||||
git commit -m "docs: update agent extension changelog for v${VERSION}"
|
||||
git push origin "$BRANCH"
|
||||
|
||||
gh pr create \
|
||||
--title "docs: update agent extension changelog for v${VERSION}" \
|
||||
--body "Auto-generated changelog update for BrowserOS Extension v${VERSION}." \
|
||||
--base main \
|
||||
--head "$BRANCH"
|
||||
|
||||
gh pr merge "$BRANCH" --squash --auto || true
|
||||
working-directory: ${{ github.workspace }}
|
||||
11
.github/workflows/release-agent-sdk.yml
vendored
Normal file
11
.github/workflows/release-agent-sdk.yml
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
name: Release BrowserOS Agent SDK (disabled)
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
disabled:
|
||||
if: ${{ false }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- run: echo "Agent SDK publishing is disabled."
|
||||
161
.github/workflows/release-cli.yml
vendored
Normal file
161
.github/workflows/release-cli.yml
vendored
Normal file
@@ -0,0 +1,161 @@
|
||||
name: Release BrowserOS CLI
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
version:
|
||||
description: "Release version (e.g. 0.1.0)"
|
||||
required: true
|
||||
type: string
|
||||
|
||||
concurrency:
|
||||
group: release-cli
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
release:
|
||||
if: github.ref == 'refs/heads/main'
|
||||
runs-on: ubuntu-latest
|
||||
environment: release-core
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
defaults:
|
||||
run:
|
||||
working-directory: packages/browseros-agent/apps/cli
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version-file: packages/browseros-agent/apps/cli/go.mod
|
||||
|
||||
- uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: "1.3.6"
|
||||
|
||||
- name: Run tests
|
||||
run: make test
|
||||
|
||||
- name: Run vet
|
||||
run: make vet
|
||||
|
||||
- name: Build all platforms
|
||||
run: make release VERSION=${{ inputs.version }} POSTHOG_API_KEY=${{ secrets.POSTHOG_API_KEY }}
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun install
|
||||
working-directory: packages/browseros-agent
|
||||
|
||||
- name: Upload to CDN
|
||||
env:
|
||||
R2_ACCOUNT_ID: ${{ secrets.R2_ACCOUNT_ID }}
|
||||
R2_ACCESS_KEY_ID: ${{ secrets.R2_ACCESS_KEY_ID }}
|
||||
R2_SECRET_ACCESS_KEY: ${{ secrets.R2_SECRET_ACCESS_KEY }}
|
||||
R2_BUCKET: ${{ secrets.R2_BUCKET }}
|
||||
R2_UPLOAD_PREFIX: cli
|
||||
CLI_VERSION: ${{ inputs.version }}
|
||||
run: |
|
||||
bun scripts/build/cli.ts \
|
||||
--release \
|
||||
--version "$CLI_VERSION" \
|
||||
--binaries-dir apps/cli/dist
|
||||
working-directory: packages/browseros-agent
|
||||
|
||||
- name: Generate release notes
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
CLI_PATH="packages/browseros-agent/apps/cli"
|
||||
TAG="browseros-cli-v${{ inputs.version }}"
|
||||
CHANGELOG_FILE="/tmp/release-changelog.md"
|
||||
PREV_TAG=$(git tag -l "browseros-cli-v*" --sort=-v:refname | grep -v "^${TAG}$" | head -n 1)
|
||||
|
||||
if [ -z "$PREV_TAG" ]; then
|
||||
echo "Initial release of browseros-cli." > "$CHANGELOG_FILE"
|
||||
else
|
||||
COMMITS=$(git log "$PREV_TAG"..HEAD --pretty=format:"%H" -- "$CLI_PATH")
|
||||
|
||||
if [ -z "$COMMITS" ]; then
|
||||
echo "No notable changes." > "$CHANGELOG_FILE"
|
||||
else
|
||||
echo "## What's Changed" > "$CHANGELOG_FILE"
|
||||
echo "" >> "$CHANGELOG_FILE"
|
||||
|
||||
while IFS= read -r SHA; do
|
||||
SUBJECT=$(git log -1 --pretty=format:"%s" "$SHA")
|
||||
PR_NUM=$(gh api "/repos/${{ github.repository }}/commits/${SHA}/pulls" --jq '.[0].number // empty' 2>/dev/null)
|
||||
|
||||
if [ -n "$PR_NUM" ] && ! echo "$SUBJECT" | grep -qF "(#${PR_NUM})"; then
|
||||
echo "- ${SUBJECT} (#${PR_NUM})" >> "$CHANGELOG_FILE"
|
||||
else
|
||||
echo "- ${SUBJECT}" >> "$CHANGELOG_FILE"
|
||||
fi
|
||||
done <<< "$COMMITS"
|
||||
fi
|
||||
fi
|
||||
|
||||
cat "$CHANGELOG_FILE" > /tmp/release-notes.md
|
||||
cat >> /tmp/release-notes.md <<'EOF'
|
||||
|
||||
## Install `browseros-cli`
|
||||
|
||||
### npm / npx
|
||||
|
||||
```bash
|
||||
npx browseros-cli --help
|
||||
npm install -g browseros-cli
|
||||
```
|
||||
|
||||
### macOS / Linux
|
||||
|
||||
```bash
|
||||
curl -fsSL https://cdn.browseros.com/cli/install.sh | bash
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
```powershell
|
||||
irm https://cdn.browseros.com/cli/install.ps1 | iex
|
||||
```
|
||||
|
||||
After install, run `browseros-cli init` to point the CLI at your BrowserOS MCP server.
|
||||
EOF
|
||||
working-directory: ${{ github.workspace }}
|
||||
|
||||
- name: Create tag and release
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
TAG="browseros-cli-v${{ inputs.version }}"
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
|
||||
if ! git rev-parse "$TAG" >/dev/null 2>&1; then
|
||||
git tag -a "$TAG" -m "browseros-cli v${{ inputs.version }}"
|
||||
git push origin "$TAG"
|
||||
fi
|
||||
|
||||
CLI_DIST="packages/browseros-agent/apps/cli/dist"
|
||||
gh release create "$TAG" \
|
||||
--title "BrowserOS CLI - v${{ inputs.version }}" \
|
||||
--notes-file /tmp/release-notes.md \
|
||||
${CLI_DIST}/*
|
||||
working-directory: ${{ github.workspace }}
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "20"
|
||||
registry-url: "https://registry.npmjs.org"
|
||||
|
||||
- name: Publish to npm
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
run: |
|
||||
make npm-version VERSION=${{ inputs.version }}
|
||||
cd npm
|
||||
npm publish --access public
|
||||
147
.github/workflows/release-server.yml
vendored
Normal file
147
.github/workflows/release-server.yml
vendored
Normal file
@@ -0,0 +1,147 @@
|
||||
name: Release BrowserOS Server
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
version:
|
||||
description: "Release version (e.g. 0.0.80)"
|
||||
required: true
|
||||
type: string
|
||||
|
||||
concurrency:
|
||||
group: release-server
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
release:
|
||||
if: github.ref == 'refs/heads/main'
|
||||
runs-on: ubuntu-latest
|
||||
environment: release-core
|
||||
permissions:
|
||||
contents: write
|
||||
defaults:
|
||||
run:
|
||||
working-directory: packages/browseros-agent
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: "1.3.6"
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun ci
|
||||
|
||||
- name: Prepare production env file
|
||||
run: cp apps/server/.env.production.example apps/server/.env.production
|
||||
|
||||
- name: Validate version
|
||||
id: version
|
||||
env:
|
||||
REQUESTED_VERSION: ${{ inputs.version }}
|
||||
run: |
|
||||
PACKAGE_VERSION=$(node -p "require('./apps/server/package.json').version")
|
||||
echo "package_version=$PACKAGE_VERSION" >> "$GITHUB_OUTPUT"
|
||||
echo "release_sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
|
||||
|
||||
if [ "$PACKAGE_VERSION" != "$REQUESTED_VERSION" ]; then
|
||||
echo "Requested version $REQUESTED_VERSION does not match apps/server/package.json ($PACKAGE_VERSION)"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Build release artifacts
|
||||
run: bun run build:server:ci
|
||||
|
||||
- name: Verify release artifacts
|
||||
run: |
|
||||
mapfile -t ZIP_FILES < <(find dist/prod/server -maxdepth 1 -type f -name 'browseros-server-resources-*.zip' | sort)
|
||||
|
||||
if [ "${#ZIP_FILES[@]}" -eq 0 ]; then
|
||||
echo "No server release zip files were produced"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
printf 'Found release artifacts:\n%s\n' "${ZIP_FILES[@]}"
|
||||
|
||||
- name: Generate release notes
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
PACKAGE_VERSION: ${{ steps.version.outputs.package_version }}
|
||||
run: |
|
||||
SERVER_APP_PATH="packages/browseros-agent/apps/server"
|
||||
SERVER_BUILD_DIR="packages/browseros-agent/scripts/build/server"
|
||||
SERVER_BUILD_ENTRY="packages/browseros-agent/scripts/build/server.ts"
|
||||
SERVER_RESOURCE_MANIFEST="packages/browseros-agent/scripts/build/config/server-prod-resources.json"
|
||||
SERVER_WORKSPACE_PKG="packages/browseros-agent/package.json"
|
||||
CURRENT_TAG="browseros-server-v$PACKAGE_VERSION"
|
||||
PREV_TAG=$(git tag -l "browseros-server-v*" --sort=-v:refname | grep -v "^${CURRENT_TAG}$" | head -n 1)
|
||||
|
||||
if [ -z "$PREV_TAG" ]; then
|
||||
echo "Initial release of browseros-server." > /tmp/release-notes.md
|
||||
else
|
||||
COMMITS=$(git log "$PREV_TAG"..HEAD --pretty=format:"%H" -- \
|
||||
"$SERVER_APP_PATH" \
|
||||
"$SERVER_BUILD_DIR" \
|
||||
"$SERVER_BUILD_ENTRY" \
|
||||
"$SERVER_RESOURCE_MANIFEST" \
|
||||
"$SERVER_WORKSPACE_PKG")
|
||||
|
||||
if [ -z "$COMMITS" ]; then
|
||||
echo "No notable changes." > /tmp/release-notes.md
|
||||
else
|
||||
echo "## What's Changed" > /tmp/release-notes.md
|
||||
echo "" >> /tmp/release-notes.md
|
||||
|
||||
while IFS= read -r SHA; do
|
||||
SUBJECT=$(git log -1 --pretty=format:"%s" "$SHA")
|
||||
PR_NUM=$(gh api "/repos/${{ github.repository }}/commits/${SHA}/pulls" --jq '.[0].number // empty' 2>/dev/null)
|
||||
|
||||
if [ -n "$PR_NUM" ] && ! echo "$SUBJECT" | grep -qF "(#${PR_NUM})"; then
|
||||
echo "- ${SUBJECT} (#${PR_NUM})" >> /tmp/release-notes.md
|
||||
else
|
||||
echo "- ${SUBJECT}" >> /tmp/release-notes.md
|
||||
fi
|
||||
done <<< "$COMMITS"
|
||||
fi
|
||||
fi
|
||||
working-directory: ${{ github.workspace }}
|
||||
|
||||
- name: Create GitHub release
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
PACKAGE_VERSION: ${{ steps.version.outputs.package_version }}
|
||||
RELEASE_SHA: ${{ steps.version.outputs.release_sha }}
|
||||
run: |
|
||||
TAG="browseros-server-v$PACKAGE_VERSION"
|
||||
TITLE="BrowserOS Server - v$PACKAGE_VERSION"
|
||||
mapfile -t ZIP_FILES < <(find packages/browseros-agent/dist/prod/server -maxdepth 1 -type f -name 'browseros-server-resources-*.zip' | sort)
|
||||
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
|
||||
if git rev-parse "$TAG" >/dev/null 2>&1; then
|
||||
echo "Tag $TAG already exists, skipping tag creation"
|
||||
else
|
||||
git tag -a "$TAG" -m "browseros-server v$PACKAGE_VERSION" "$RELEASE_SHA"
|
||||
fi
|
||||
|
||||
if git ls-remote --tags origin "$TAG" | grep -q "$TAG"; then
|
||||
echo "Tag $TAG already on remote, skipping push"
|
||||
else
|
||||
git push origin "$TAG"
|
||||
fi
|
||||
|
||||
if gh release view "$TAG" >/dev/null 2>&1; then
|
||||
echo "Release $TAG already exists, updating"
|
||||
gh release edit "$TAG" --title "$TITLE" --notes-file /tmp/release-notes.md
|
||||
gh release upload "$TAG" "${ZIP_FILES[@]}" --clobber
|
||||
else
|
||||
gh release create "$TAG" \
|
||||
--title "$TITLE" \
|
||||
--notes-file /tmp/release-notes.md \
|
||||
"${ZIP_FILES[@]}"
|
||||
fi
|
||||
working-directory: ${{ github.workspace }}
|
||||
308
.github/workflows/test.yml
vendored
Normal file
308
.github/workflows/test.yml
vendored
Normal file
@@ -0,0 +1,308 @@
|
||||
name: Tests
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types:
|
||||
- opened
|
||||
- synchronize
|
||||
- reopened
|
||||
- ready_for_review
|
||||
paths:
|
||||
- .github/workflows/test.yml
|
||||
- packages/browseros-agent/**
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
env:
|
||||
BROWSEROS_APPIMAGE_URL: https://files.browseros.com/download/BrowserOS.AppImage
|
||||
|
||||
jobs:
|
||||
test:
|
||||
name: Tests / ${{ matrix.suite }}
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 20
|
||||
defaults:
|
||||
run:
|
||||
working-directory: packages/browseros-agent
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- suite: server-agent
|
||||
command: (cd apps/server && bun run test:agent)
|
||||
junit_path: test-results/server-agent.xml
|
||||
needs_browser: false
|
||||
- suite: server-api
|
||||
command: (cd apps/server && bun run test:api)
|
||||
junit_path: test-results/server-api.xml
|
||||
needs_browser: false
|
||||
- suite: server-skills
|
||||
command: (cd apps/server && bun run test:skills)
|
||||
junit_path: test-results/server-skills.xml
|
||||
needs_browser: false
|
||||
- suite: server-tools
|
||||
command: (cd apps/server && bun run test:tools)
|
||||
junit_path: test-results/server-tools.xml
|
||||
needs_browser: true
|
||||
- suite: server-browser
|
||||
command: (cd apps/server && bun run test:browser)
|
||||
junit_path: test-results/server-browser.xml
|
||||
needs_browser: false
|
||||
- suite: server-integration
|
||||
command: (cd apps/server && bun run test:integration)
|
||||
junit_path: test-results/server-integration.xml
|
||||
needs_browser: true
|
||||
- suite: server-lib
|
||||
command: (cd apps/server && bun run test:lib)
|
||||
junit_path: test-results/server-lib.xml
|
||||
needs_browser: false
|
||||
- suite: server-root
|
||||
command: (cd apps/server && bun run test:root)
|
||||
junit_path: test-results/server-root.xml
|
||||
needs_browser: false
|
||||
- suite: agent
|
||||
command: (cd apps/agent && bun run test)
|
||||
junit_path: test-results/agent.xml
|
||||
needs_browser: false
|
||||
- suite: eval
|
||||
command: (cd apps/eval && bun run test)
|
||||
junit_path: test-results/eval.xml
|
||||
needs_browser: false
|
||||
- suite: build
|
||||
command: bun run ./scripts/run-bun-test.ts ./scripts/build
|
||||
junit_path: test-results/build.xml
|
||||
needs_browser: false
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun ci
|
||||
|
||||
- name: Resolve BrowserOS cache key
|
||||
if: matrix.needs_browser == true
|
||||
id: browseros-cache-key
|
||||
run: |
|
||||
set -euo pipefail
|
||||
headers="$(curl -fsSI "$BROWSEROS_APPIMAGE_URL")"
|
||||
etag="$(printf '%s\n' "$headers" | awk 'BEGIN{IGNORECASE=1} /^etag:/ {sub(/\r$/, "", $2); gsub(/"/, "", $2); print $2; exit}')"
|
||||
last_modified="$(printf '%s\n' "$headers" | awk 'BEGIN{IGNORECASE=1} /^last-modified:/ {$1=""; sub(/^ /, ""); sub(/\r$/, ""); print; exit}')"
|
||||
raw_key="${etag:-$last_modified}"
|
||||
if [ -z "$raw_key" ]; then
|
||||
raw_key="$BROWSEROS_APPIMAGE_URL"
|
||||
fi
|
||||
cache_key="$(printf '%s' "$raw_key" | shasum -a 256 | awk '{print $1}')"
|
||||
echo "key=browseros-appimage-${{ runner.os }}-$cache_key" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Restore BrowserOS cache
|
||||
if: matrix.needs_browser == true
|
||||
id: browseros-cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: packages/browseros-agent/.ci/bin/BrowserOS.AppImage
|
||||
key: ${{ steps.browseros-cache-key.outputs.key }}
|
||||
|
||||
- name: Download BrowserOS
|
||||
if: matrix.needs_browser == true && steps.browseros-cache.outputs.cache-hit != 'true'
|
||||
run: |
|
||||
mkdir -p .ci/bin
|
||||
curl -fsSL "$BROWSEROS_APPIMAGE_URL" -o .ci/bin/BrowserOS.AppImage
|
||||
chmod +x .ci/bin/BrowserOS.AppImage
|
||||
|
||||
- name: Prepare BrowserOS wrapper
|
||||
if: matrix.needs_browser == true
|
||||
run: |
|
||||
mkdir -p .ci/bin
|
||||
cat > .ci/bin/browseros <<'EOF'
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
export APPIMAGE_EXTRACT_AND_RUN=1
|
||||
exec "$(dirname "$0")/BrowserOS.AppImage" "$@"
|
||||
EOF
|
||||
chmod +x .ci/bin/browseros
|
||||
|
||||
- name: Create server env file
|
||||
working-directory: packages/browseros-agent/apps/server
|
||||
run: cp .env.example .env.development
|
||||
|
||||
- name: Run ${{ matrix.suite }} tests
|
||||
id: test
|
||||
env:
|
||||
BROWSEROS_BINARY: ${{ github.workspace }}/packages/browseros-agent/.ci/bin/browseros
|
||||
BROWSEROS_TEST_HEADLESS: "true"
|
||||
BROWSEROS_TEST_EXTRA_ARGS: --no-sandbox --disable-dev-shm-usage
|
||||
BROWSEROS_JUNIT_PATH: ${{ github.workspace }}/packages/browseros-agent/${{ matrix.junit_path }}
|
||||
run: |
|
||||
set +e
|
||||
mkdir -p test-results
|
||||
${{ matrix.command }}
|
||||
exit_code=$?
|
||||
if [ ! -f "${{ matrix.junit_path }}" ]; then
|
||||
if [ "$exit_code" = "0" ]; then
|
||||
cat > "${{ matrix.junit_path }}" <<EOF
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<testsuites tests="0" failures="0">
|
||||
<testsuite name="${{ matrix.suite }}" tests="0" failures="0">
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
EOF
|
||||
else
|
||||
cat > "${{ matrix.junit_path }}" <<EOF
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<testsuites tests="1" failures="1">
|
||||
<testsuite name="${{ matrix.suite }}" tests="1" failures="1">
|
||||
<testcase classname="workflow" name="${{ matrix.suite }} setup">
|
||||
<failure message="Test run failed before JUnit output was written">See workflow logs for details.</failure>
|
||||
</testcase>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
EOF
|
||||
fi
|
||||
fi
|
||||
echo "exit_code=$exit_code" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Upload JUnit XML
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: junit-${{ matrix.suite }}
|
||||
path: packages/browseros-agent/${{ matrix.junit_path }}
|
||||
|
||||
- name: Summarize suite result
|
||||
if: always()
|
||||
run: |
|
||||
if [ "${{ steps.test.outputs.exit_code }}" = "0" ]; then
|
||||
echo "### :white_check_mark: ${{ matrix.suite }} suite passed" >> "$GITHUB_STEP_SUMMARY"
|
||||
else
|
||||
echo "### :x: ${{ matrix.suite }} suite failed (exit code ${{ steps.test.outputs.exit_code }})" >> "$GITHUB_STEP_SUMMARY"
|
||||
echo "" >> "$GITHUB_STEP_SUMMARY"
|
||||
echo "See the uploaded \`junit-${{ matrix.suite }}\` artifact for details." >> "$GITHUB_STEP_SUMMARY"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
comment:
|
||||
name: PR test summary
|
||||
needs: test
|
||||
if: >-
|
||||
always()
|
||||
&& github.event_name == 'pull_request'
|
||||
&& github.event.pull_request.head.repo.full_name == github.repository
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
pull-requests: write
|
||||
actions: read
|
||||
steps:
|
||||
- name: Download JUnit artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
continue-on-error: true
|
||||
with:
|
||||
path: junit
|
||||
pattern: junit-*
|
||||
|
||||
- name: Build comment body
|
||||
run: |
|
||||
python3 <<'PY'
|
||||
import glob, os, xml.etree.ElementTree as ET
|
||||
|
||||
run_url = f"{os.environ['GITHUB_SERVER_URL']}/{os.environ['GITHUB_REPOSITORY']}/actions/runs/{os.environ['GITHUB_RUN_ID']}"
|
||||
marker = "<!-- browseros-agent-tests-summary -->"
|
||||
|
||||
suites = []
|
||||
failed_cases = []
|
||||
total_tests = total_failed = total_skipped = 0
|
||||
|
||||
for xml_path in sorted(glob.glob("junit/junit-*/*.xml")):
|
||||
suite_name = os.path.basename(os.path.dirname(xml_path)).removeprefix("junit-")
|
||||
try:
|
||||
root = ET.parse(xml_path).getroot()
|
||||
except ET.ParseError:
|
||||
suites.append({"name": suite_name, "passed": 0, "failed": 1, "skipped": 0, "total": 1})
|
||||
total_tests += 1
|
||||
total_failed += 1
|
||||
failed_cases.append((suite_name, "(could not parse junit XML)"))
|
||||
continue
|
||||
|
||||
testsuites = root.findall("testsuite") if root.tag == "testsuites" else [root]
|
||||
s_tests = s_fail = s_err = s_skip = 0
|
||||
for ts in testsuites:
|
||||
s_tests += int(ts.get("tests") or 0)
|
||||
s_fail += int(ts.get("failures") or 0)
|
||||
s_err += int(ts.get("errors") or 0)
|
||||
s_skip += int(ts.get("skipped") or 0)
|
||||
for tc in ts.iter("testcase"):
|
||||
if tc.find("failure") is not None or tc.find("error") is not None:
|
||||
cls = tc.get("classname") or ""
|
||||
name = tc.get("name") or "(unnamed)"
|
||||
label = f"{cls} > {name}" if cls else name
|
||||
failed_cases.append((suite_name, label))
|
||||
|
||||
s_failed = s_fail + s_err
|
||||
s_passed = max(s_tests - s_failed - s_skip, 0)
|
||||
suites.append({"name": suite_name, "passed": s_passed, "failed": s_failed, "skipped": s_skip, "total": s_tests})
|
||||
total_tests += s_tests
|
||||
total_failed += s_failed
|
||||
total_skipped += s_skip
|
||||
|
||||
total_passed = max(total_tests - total_failed - total_skipped, 0)
|
||||
|
||||
if total_tests == 0:
|
||||
header = "## :warning: No test results were produced"
|
||||
elif total_failed == 0:
|
||||
header = f"## :white_check_mark: Tests passed — {total_passed}/{total_tests}"
|
||||
else:
|
||||
header = f"## :x: Tests failed — {total_failed}/{total_tests} failed"
|
||||
|
||||
lines = [marker, header, ""]
|
||||
if suites:
|
||||
lines.append("| Suite | Passed | Failed | Skipped |")
|
||||
lines.append("|-------|--------|--------|---------|")
|
||||
for s in suites:
|
||||
icon = ":white_check_mark:" if s["failed"] == 0 and s["total"] > 0 else ":warning:" if s["total"] == 0 else ":x:"
|
||||
lines.append(f"| {icon} `{s['name']}` | {s['passed']}/{s['total']} | {s['failed']} | {s['skipped']} |")
|
||||
|
||||
if failed_cases:
|
||||
lines += ["", "<details open>", "<summary><b>Failed tests</b></summary>", ""]
|
||||
for suite_name, label in failed_cases[:50]:
|
||||
lines.append(f"- **{suite_name}** — `{label}`")
|
||||
if len(failed_cases) > 50:
|
||||
lines.append(f"- …and {len(failed_cases) - 50} more")
|
||||
lines += ["", "</details>"]
|
||||
|
||||
lines += ["", f"[View workflow run]({run_url})"]
|
||||
|
||||
with open("comment.md", "w") as f:
|
||||
f.write("\n".join(lines) + "\n")
|
||||
PY
|
||||
|
||||
- name: Upsert sticky PR comment
|
||||
uses: actions/github-script@v7
|
||||
with:
|
||||
script: |
|
||||
const fs = require('fs');
|
||||
const body = fs.readFileSync('comment.md', 'utf8');
|
||||
const marker = '<!-- browseros-agent-tests-summary -->';
|
||||
const { owner, repo } = context.repo;
|
||||
const issue_number = context.payload.pull_request.number;
|
||||
|
||||
const triggerSha = context.payload.pull_request.head.sha;
|
||||
const { data: pr } = await github.rest.pulls.get({ owner, repo, pull_number: issue_number });
|
||||
if (pr.head.sha !== triggerSha) {
|
||||
core.info(`PR head has moved (${pr.head.sha} vs ${triggerSha}) — skipping stale comment.`);
|
||||
return;
|
||||
}
|
||||
|
||||
const comments = await github.paginate(github.rest.issues.listComments, {
|
||||
owner, repo, issue_number, per_page: 100,
|
||||
});
|
||||
const existing = comments.find(c => c.body && c.body.includes(marker));
|
||||
if (existing) {
|
||||
await github.rest.issues.updateComment({ owner, repo, comment_id: existing.id, body });
|
||||
} else {
|
||||
await github.rest.issues.createComment({ owner, repo, issue_number, body });
|
||||
}
|
||||
115
.github/workflows/top-issues.yml
vendored
Normal file
115
.github/workflows/top-issues.yml
vendored
Normal file
@@ -0,0 +1,115 @@
|
||||
name: Top Issues and Features by Votes
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: "0 * * * *" # Run every hour
|
||||
workflow_dispatch: # Allow manual triggering
|
||||
|
||||
permissions:
|
||||
issues: write
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
update-top-issues:
|
||||
runs-on: ubuntu-latest
|
||||
if: github.repository == 'browseros-ai/BrowserOS'
|
||||
|
||||
steps:
|
||||
- name: Update top issues list
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
ISSUE_NUMBER: 169
|
||||
run: |
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
echo "Fetching all open issues..."
|
||||
|
||||
# Fetch all open issues with reaction data
|
||||
issues=$(gh api graphql -f query='
|
||||
query($owner: String!, $repo: String!) {
|
||||
repository(owner: $owner, name: $repo) {
|
||||
issues(first: 100, states: OPEN, orderBy: {field: CREATED_AT, direction: DESC}) {
|
||||
nodes {
|
||||
number
|
||||
title
|
||||
url
|
||||
reactions(content: THUMBS_UP) {
|
||||
totalCount
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
' -f owner='browseros-ai' -f repo='BrowserOS')
|
||||
|
||||
# Parse and sort RFC issues (titles containing [RFC])
|
||||
sorted_rfcs=$(echo "$issues" | jq -r --arg ISSUE_NUMBER "$ISSUE_NUMBER" '
|
||||
.data.repository.issues.nodes
|
||||
| map(select(.number != ($ISSUE_NUMBER | tonumber) and (.title | contains("[RFC]"))))
|
||||
| sort_by(-.reactions.totalCount)
|
||||
| to_entries
|
||||
| map("\(.key + 1). [\(.value.title)](\(.value.url)) — \(.value.reactions.totalCount) 👍")
|
||||
| join("\n")
|
||||
')
|
||||
|
||||
# Parse and sort regular issues (excluding RFCs)
|
||||
sorted_issues=$(echo "$issues" | jq -r --arg ISSUE_NUMBER "$ISSUE_NUMBER" '
|
||||
.data.repository.issues.nodes
|
||||
| map(select(.number != ($ISSUE_NUMBER | tonumber) and (.title | contains("[RFC]") | not)))
|
||||
| sort_by(-.reactions.totalCount)
|
||||
| to_entries
|
||||
| map("\(.key + 1). [\(.value.title)](\(.value.url)) — \(.value.reactions.totalCount) 👍")
|
||||
| join("\n")
|
||||
')
|
||||
|
||||
# Create issue body
|
||||
current_time=$(date -u +"%Y-%m-%d %H:%M:%S UTC")
|
||||
|
||||
{
|
||||
echo "# Community Roadmap"
|
||||
echo ""
|
||||
echo "This list is automatically updated every hour based on 👍 reactions."
|
||||
echo ""
|
||||
echo "## How to Vote"
|
||||
echo ""
|
||||
echo "| Action | What it does |"
|
||||
echo "|--------|--------------|"
|
||||
echo "| 👍 on an issue | Adds your vote — we prioritize by vote count |"
|
||||
echo "| 💬 Comment | Your feedback shapes what we build |"
|
||||
echo ""
|
||||
echo "**Don't see what you need?** Create a new [feature request](https://github.com/browseros-ai/BrowserOS/issues/new) or [bug report](https://github.com/browseros-ai/BrowserOS/issues/new)."
|
||||
echo ""
|
||||
echo "**Last updated:** $current_time"
|
||||
echo ""
|
||||
echo "---"
|
||||
echo ""
|
||||
echo "## 📣 RFCs — We Need Your Input"
|
||||
echo ""
|
||||
echo "> **These proposals are in review.** Your vote and comments directly influence what gets built."
|
||||
echo ">"
|
||||
echo "> 👍 = Yes, build this | 💬 = Share your use case or feedback"
|
||||
echo ""
|
||||
if [ -n "$sorted_rfcs" ]; then
|
||||
echo "$sorted_rfcs"
|
||||
else
|
||||
echo "*No active RFCs right now. Check back soon!*"
|
||||
fi
|
||||
echo ""
|
||||
echo "---"
|
||||
echo ""
|
||||
echo "## Top Issues & Feature Requests"
|
||||
echo ""
|
||||
echo "$sorted_issues"
|
||||
echo ""
|
||||
echo "---"
|
||||
echo "🤖 *This issue is automatically updated by [GitHub Actions](.github/workflows/top-issues.yml)*"
|
||||
} > /tmp/issue_body.md
|
||||
|
||||
# Update the tracking issue
|
||||
echo "Updating issue #$ISSUE_NUMBER..."
|
||||
gh issue edit "$ISSUE_NUMBER" \
|
||||
--repo browseros-ai/BrowserOS \
|
||||
--body-file /tmp/issue_body.md
|
||||
|
||||
echo "✅ Successfully updated top issues list!"
|
||||
27
.gitignore
vendored
27
.gitignore
vendored
@@ -1,10 +1,35 @@
|
||||
**/.DS_Store
|
||||
**.auctor/**
|
||||
.auctor.json
|
||||
.gcs_entries
|
||||
**/dmg
|
||||
**/env
|
||||
**/logs
|
||||
**/old-scripts
|
||||
**/__pycache__/**
|
||||
|
||||
# Python
|
||||
**/__pycache__/
|
||||
**/*.pyc
|
||||
**/*.pyo
|
||||
**/*.egg-info/
|
||||
**/*.egg
|
||||
**/.pytest_cache/
|
||||
**/dist/
|
||||
**/releases/
|
||||
**/.wrangler/
|
||||
**/node_modules/
|
||||
|
||||
|
||||
|
||||
nxtscape-cli-access.json
|
||||
gclient.json
|
||||
.env
|
||||
.grove/
|
||||
AGENTS.md
|
||||
**/resources/binaries/
|
||||
|
||||
packages/browseros/build/tools/
|
||||
|
||||
# AI SDK DevTools traces
|
||||
.devtools/
|
||||
.omc/
|
||||
|
||||
4
.gitmodules
vendored
4
.gitmodules
vendored
@@ -1,4 +0,0 @@
|
||||
[submodule "packages/browseros-agent"]
|
||||
path = packages/browseros-agent
|
||||
url = https://github.com/browseros-ai/BrowserOS-agent.git
|
||||
branch = main
|
||||
|
||||
3840
.vscode/PythonImportHelper-v2-Completion.json
vendored
3840
.vscode/PythonImportHelper-v2-Completion.json
vendored
File diff suppressed because it is too large
Load Diff
4
.vscode/settings.json
vendored
Normal file
4
.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"terminal.integrated.tabs.title": "${sequence} ${process}",
|
||||
"terminal.integrated.tabs.description": "${cwd}"
|
||||
}
|
||||
11
CLAUDE.md
Normal file
11
CLAUDE.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Project Instructions
|
||||
|
||||
## Docs Image Workflow
|
||||
|
||||
When updating documentation that involves new screenshots or images:
|
||||
|
||||
1. Prompt the user to copy the image to their clipboard (Cmd+C)
|
||||
2. Run: `python scripts/save_clipboard.py <target_path>`
|
||||
3. Example: `python scripts/save_clipboard.py docs/images/agent-step.png`
|
||||
|
||||
This saves the clipboard image directly to the docs folder without manual file management.
|
||||
31
LICENSE.ungoogled_chromium
Normal file
31
LICENSE.ungoogled_chromium
Normal file
@@ -0,0 +1,31 @@
|
||||
BSD 3-Clause License (only for ungoogled chromium patches)
|
||||
|
||||
The following license governs all ungoogled-chromium patches located in packages/browseros/series_patches/windows/ungoogled-chromium and packages/browseros/series_patches/ungoogled-chromium.
|
||||
|
||||
Copyright (c) 2015-2023, The ungoogled-chromium Authors
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
206
README.md
206
README.md
@@ -6,6 +6,7 @@
|
||||
[](https://dub.sh/browserOS-slack)
|
||||
[](https://twitter.com/browseros_ai)
|
||||
[](LICENSE)
|
||||
[](https://docs.browseros.com)
|
||||
<br></br>
|
||||
<a href="https://files.browseros.com/download/BrowserOS.dmg">
|
||||
<img src="https://img.shields.io/badge/Download-macOS-black?style=flat&logo=apple&logoColor=white" alt="Download for macOS (beta)" />
|
||||
@@ -22,107 +23,198 @@
|
||||
<br />
|
||||
</div>
|
||||
|
||||
##
|
||||
🌐 BrowserOS is an open-source chromium fork that runs AI agents natively. **Your open-source, privacy-first alternative to Perplexity Comet, Dia**.
|
||||
BrowserOS is an open-source Chromium fork that runs AI agents natively. **The privacy-first alternative to ChatGPT Atlas, Perplexity Comet, and Dia.**
|
||||
|
||||
🔒 Privacy first - use your own API keys or run local models with Ollama. Your data stays on your computer.
|
||||
Use your own API keys or run local models with Ollama. Your data never leaves your machine.
|
||||
|
||||
💡 Join our [Discord](https://discord.gg/YKwjt5vuKr) or [Slack](https://dub.sh/browserOS-slack) and help us build! Have feature requests? [Suggest here](https://github.com/browseros-ai/BrowserOS/issues/99).
|
||||
> **[Documentation](https://docs.browseros.com)** · **[Discord](https://discord.gg/YKwjt5vuKr)** · **[Slack](https://dub.sh/browserOS-slack)** · **[Twitter](https://x.com/browserOS_ai)** · **[Feature Requests](https://github.com/browseros-ai/BrowserOS/issues/99)**
|
||||
|
||||
## Quick start
|
||||
## Quick Start
|
||||
|
||||
1. Download and install BrowserOS:
|
||||
- [macOS](https://files.browseros.com/download/BrowserOS.dmg)
|
||||
- [Windows](https://files.browseros.com/download/BrowserOS_installer.exe)
|
||||
- [Linux (AppImage)](https://files.browseros.com/download/BrowserOS.AppImage)
|
||||
- [Linux (Debian)](https://cdn.browseros.com/download/BrowserOS.deb)
|
||||
1. **Download and install** BrowserOS — [macOS](https://files.browseros.com/download/BrowserOS.dmg) · [Windows](https://files.browseros.com/download/BrowserOS_installer.exe) · [Linux (AppImage)](https://files.browseros.com/download/BrowserOS.AppImage) · [Linux (Debian)](https://cdn.browseros.com/download/BrowserOS.deb)
|
||||
2. **Import your Chrome data** (optional) — bookmarks, passwords, extensions all carry over
|
||||
3. **Connect your AI provider** — Claude, OpenAI, Gemini, ChatGPT Pro via OAuth, or local models via Ollama/LM Studio
|
||||
|
||||
2. Import your Chrome data (optional)
|
||||
## Features
|
||||
|
||||
3. Connect your AI provider (OpenAI, Anthropic, or local models via Ollama/LMStudio)
|
||||
|
||||
4. Start automating!
|
||||
|
||||
## What makes BrowserOS special
|
||||
- 🏠 Feels like home - same familiar interface as Google Chrome, works with all your extensions
|
||||
- 🤖 AI agents that run on YOUR browser, not in the cloud
|
||||
- 🔒 Privacy first - bring your own keys or use local models with Ollama. Your browsing history stays on your computer
|
||||
- 🚀 Open source and community driven - see exactly what's happening under the hood
|
||||
- 🤝 MCP store to one-click install popular MCPs and use them directly in the browser bar
|
||||
- 🛡️ (coming soon) Built-in AI ad blocker that works across more scenarios!
|
||||
| Feature | Description | Docs |
|
||||
|---------|-------------|------|
|
||||
| **AI Agent** | 53+ browser automation tools — navigate, click, type, extract data, all with natural language | [Guide](https://docs.browseros.com/getting-started) |
|
||||
| **MCP Server** | Control the browser from Claude Code, Gemini CLI, or any MCP client | [Setup](https://docs.browseros.com/features/use-with-claude-code) |
|
||||
| **Workflows** | Build repeatable browser automations with a visual graph builder | [Docs](https://docs.browseros.com/features/workflows) |
|
||||
| **Cowork** | Combine browser automation with local file operations — research the web, save reports to your folder | [Docs](https://docs.browseros.com/features/cowork) |
|
||||
| **Scheduled Tasks** | Run agents on autopilot — daily, hourly, or every few minutes | [Docs](https://docs.browseros.com/features/scheduled-tasks) |
|
||||
| **Memory** | Persistent memory across conversations — your assistant remembers context over time | [Docs](https://docs.browseros.com/features/memory) |
|
||||
| **SOUL.md** | Define your AI's personality and instructions in a single markdown file | [Docs](https://docs.browseros.com/features/soul-md) |
|
||||
| **LLM Hub** | Compare Claude, ChatGPT, and Gemini responses side-by-side on any page | [Docs](https://docs.browseros.com/features/llm-chat-hub) |
|
||||
| **40+ App Integrations** | Gmail, Slack, GitHub, Linear, Notion, Figma, Salesforce, and more via MCP | [Docs](https://docs.browseros.com/features/connect-apps) |
|
||||
| **Vertical Tabs** | Side-panel tab management — stay organized even with 100+ tabs open | [Docs](https://docs.browseros.com/features/vertical-tabs) |
|
||||
| **Ad Blocking** | uBlock Origin + Manifest V2 support — [10x more protection](https://docs.browseros.com/features/ad-blocking) than Chrome | [Docs](https://docs.browseros.com/features/ad-blocking) |
|
||||
| **Cloud Sync** | Sync browser config and agent history across devices | [Docs](https://docs.browseros.com/features/sync) |
|
||||
| **Skills** | Custom instruction sets that shape how your AI assistant behaves | [Docs](https://docs.browseros.com/features/skills) |
|
||||
| **Smart Nudges** | Contextual suggestions to connect apps and use features at the right moment | [Docs](https://docs.browseros.com/features/smart-nudges) |
|
||||
|
||||
## Demos
|
||||
|
||||
### 🤖 BrowserOS agent in action
|
||||
### BrowserOS agent in action
|
||||
[](https://www.youtube.com/watch?v=SoSFev5R5dI)
|
||||
<br/><br/>
|
||||
|
||||
### 💬 Use BrowserOS to chat
|
||||
### Install [BrowserOS as MCP](https://docs.browseros.com/features/use-with-claude-code) and control it from `claude-code`
|
||||
|
||||
https://github.com/user-attachments/assets/c725d6df-1a0d-40eb-a125-ea009bf664dc
|
||||
|
||||
<br/><br/>
|
||||
|
||||
### Use BrowserOS to chat
|
||||
|
||||
https://github.com/user-attachments/assets/726803c5-8e36-420e-8694-c63a2607beca
|
||||
|
||||
<br/><br/>
|
||||
|
||||
### ⚡ Use BrowserOS to scrape data
|
||||
### Use BrowserOS to scrape data
|
||||
|
||||
https://github.com/user-attachments/assets/9f038216-bc24-4555-abf1-af2adcb7ebc0
|
||||
|
||||
<br/><br/>
|
||||
|
||||
## Why We're Building BrowserOS
|
||||
## Install `browseros-cli`
|
||||
|
||||
For the first time since Netscape pioneered the web in 1994, AI gives us the chance to completely reimagine the browser. We've seen tools like Cursor deliver 10x productivity gains for developers—yet everyday browsing remains frustratingly archaic.
|
||||
Use `browseros-cli` to launch and control BrowserOS from the terminal or from AI coding agents like Claude Code.
|
||||
|
||||
You're likely juggling 70+ tabs, battling your browser instead of having it assist you. Routine tasks, like ordering something from amazon or filling a form should be handled seamlessly by AI agents.
|
||||
**macOS / Linux:**
|
||||
|
||||
At BrowserOS, we're convinced that AI should empower you by automating tasks locally and securely—keeping your data private. We are building the best browser for this future!
|
||||
```bash
|
||||
curl -fsSL https://cdn.browseros.com/cli/install.sh | bash
|
||||
```
|
||||
|
||||
## How we compare
|
||||
**Windows:**
|
||||
|
||||
<details>
|
||||
<summary><b>vs Chrome</b></summary>
|
||||
<br>
|
||||
While we're grateful for Google open-sourcing Chromium, but Chrome hasn't evolved much in 10 years. No AI features, no automation, no MCP support.
|
||||
</details>
|
||||
```powershell
|
||||
irm https://cdn.browseros.com/cli/install.ps1 | iex
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary><b>vs Brave</b></summary>
|
||||
<br>
|
||||
We love what Brave started, but they've spread themselves too thin with crypto, search, VPNs. We're laser-focused on AI-powered browsing.
|
||||
</details>
|
||||
After install, run `browseros-cli init` to connect the CLI to your running BrowserOS instance.
|
||||
|
||||
<details>
|
||||
<summary><b>vs Arc/Dia</b></summary>
|
||||
<br>
|
||||
Many loved Arc, but it was closed source. When they abandoned users, there was no recourse. We're 100% open source - fork it anytime!
|
||||
</details>
|
||||
## LLM Providers
|
||||
|
||||
<details>
|
||||
<summary><b>vs Perplexity Comet</b></summary>
|
||||
<br>
|
||||
They're a search/ad company. Your browser history becomes their product. We keep everything local.
|
||||
</details>
|
||||
BrowserOS works with any LLM. Bring your own keys, use OAuth, or run models locally.
|
||||
|
||||
| Provider | Type | Auth |
|
||||
|----------|------|------|
|
||||
| Kimi K2.5 | Cloud (default) | Built-in |
|
||||
| ChatGPT Pro/Plus | Cloud | [OAuth](https://docs.browseros.com/features/chatgpt) |
|
||||
| GitHub Copilot | Cloud | [OAuth](https://docs.browseros.com/features/github-copilot) |
|
||||
| Qwen Code | Cloud | [OAuth](https://docs.browseros.com/features/qwen-code) |
|
||||
| Claude (Anthropic) | Cloud | API key |
|
||||
| GPT-4o / o3 (OpenAI) | Cloud | API key |
|
||||
| Gemini (Google) | Cloud | API key |
|
||||
| Azure OpenAI | Cloud | API key |
|
||||
| AWS Bedrock | Cloud | IAM credentials |
|
||||
| OpenRouter | Cloud | API key |
|
||||
| Ollama | Local | [Setup](https://docs.browseros.com/features/ollama) |
|
||||
| LM Studio | Local | [Setup](https://docs.browseros.com/features/lm-studio) |
|
||||
|
||||
## How We Compare
|
||||
|
||||
| | BrowserOS | Chrome | Brave | Dia | Comet | Atlas |
|
||||
|---|:---:|:---:|:---:|:---:|:---:|:---:|
|
||||
| Open Source | ✅ | ❌ | ✅ | ❌ | ❌ | ❌ |
|
||||
| AI Agent | ✅ | ❌ | ❌ | ❌ | ✅ | ✅ |
|
||||
| MCP Server | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
|
||||
| Visual Workflows | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
|
||||
| Cowork (files + browser) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
|
||||
| Scheduled Tasks | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
|
||||
| Bring Your Own Keys | ✅ | ❌ | ✅ | ❌ | ❌ | ❌ |
|
||||
| Local Models (Ollama) | ✅ | ❌ | ✅ | ❌ | ❌ | ❌ |
|
||||
| Local-first Privacy | ✅ | ❌ | ✅ | ❌ | ❌ | ❌ |
|
||||
| Ad Blocking (MV2) | ✅ | ❌ | ✅ | ❌ | ✅ | ❌ |
|
||||
|
||||
**Detailed comparisons:**
|
||||
- [BrowserOS vs Chrome DevTools MCP](https://docs.browseros.com/comparisons/chrome-devtools-mcp) — developer-focused comparison for browser automation
|
||||
- [BrowserOS vs Claude Cowork](https://docs.browseros.com/comparisons/claude-cowork) — getting real work done with AI
|
||||
- [BrowserOS vs OpenClaw](https://docs.browseros.com/comparisons/openclaw) — everyday AI assistance
|
||||
|
||||
## Architecture
|
||||
|
||||
BrowserOS is a monorepo with two main subsystems: the **browser** (Chromium fork) and the **agent platform** (TypeScript/Go).
|
||||
|
||||
```
|
||||
BrowserOS/
|
||||
├── packages/browseros/ # Chromium fork + build system (Python)
|
||||
│ ├── chromium_patches/ # Patches applied to Chromium source
|
||||
│ ├── build/ # Build CLI and modules
|
||||
│ └── resources/ # Icons, entitlements, signing
|
||||
│
|
||||
├── packages/browseros-agent/ # Agent platform (TypeScript/Go)
|
||||
│ ├── apps/
|
||||
│ │ ├── server/ # MCP server + AI agent loop (Bun)
|
||||
│ │ ├── agent/ # Browser extension UI (WXT + React)
|
||||
│ │ ├── cli/ # CLI tool (Go)
|
||||
│ │ ├── eval/ # Benchmark framework
|
||||
│ │ └── controller-ext/ # Chrome API bridge extension
|
||||
│ │
|
||||
│ └── packages/
|
||||
│ ├── agent-sdk/ # Node.js SDK (npm: @browseros-ai/agent-sdk)
|
||||
│ ├── cdp-protocol/ # CDP type bindings
|
||||
│ └── shared/ # Shared constants
|
||||
```
|
||||
|
||||
| Package | What it does |
|
||||
|---------|-------------|
|
||||
| [`packages/browseros`](packages/browseros/) | Chromium fork — patches, build system, signing |
|
||||
| [`apps/server`](packages/browseros-agent/apps/server/) | Bun server exposing 53+ MCP tools and running the AI agent loop |
|
||||
| [`apps/agent`](packages/browseros-agent/apps/agent/) | Browser extension — new tab, side panel chat, onboarding, settings |
|
||||
| [`apps/cli`](packages/browseros-agent/apps/cli/) | Go CLI — control BrowserOS from the terminal or AI coding agents |
|
||||
| [`apps/eval`](packages/browseros-agent/apps/eval/) | Benchmark framework — WebVoyager, Mind2Web evaluation |
|
||||
| [`agent-sdk`](packages/browseros-agent/packages/agent-sdk/) | Node.js SDK for browser automation with natural language |
|
||||
| [`cdp-protocol`](packages/browseros-agent/packages/cdp-protocol/) | Type-safe Chrome DevTools Protocol bindings |
|
||||
|
||||
## Contributing
|
||||
|
||||
We'd love your help making BrowserOS better!
|
||||
We'd love your help making BrowserOS better! See our [Contributing Guide](CONTRIBUTING.md) for details.
|
||||
|
||||
- 🐛 [Report bugs](https://github.com/nxtscape/nxtscape/issues)
|
||||
- 💡 [Suggest features](https://github.com/browseros-ai/BrowserOS/issues/99)
|
||||
- 💬 [Join Discord](https://discord.gg/YKwjt5vuKr)
|
||||
- 🐦 [Follow on Twitter](https://x.com/browserOS_ai)
|
||||
- [Report bugs](https://github.com/browseros-ai/BrowserOS/issues)
|
||||
- [Suggest features](https://github.com/browseros-ai/BrowserOS/issues/99)
|
||||
- [Join Discord](https://discord.gg/YKwjt5vuKr) · [Join Slack](https://dub.sh/browserOS-slack)
|
||||
- [Follow on Twitter](https://x.com/browserOS_ai)
|
||||
|
||||
**Agent development** (TypeScript/Go) — see the [agent monorepo README](packages/browseros-agent/README.md) for setup instructions.
|
||||
|
||||
**Browser development** (C++/Python) — requires ~100GB disk space. See [`packages/browseros`](packages/browseros/) for build instructions.
|
||||
|
||||
## Credits
|
||||
|
||||
- [ungoogled-chromium](https://github.com/ungoogled-software/ungoogled-chromium) — BrowserOS uses some patches for enhanced privacy. Thanks to everyone behind this project!
|
||||
- [The Chromium Project](https://www.chromium.org/) — at the core of BrowserOS, making it possible to exist in the first place.
|
||||
|
||||
## Citation
|
||||
|
||||
If you use BrowserOS in your research or project, please cite:
|
||||
|
||||
```bibtex
|
||||
@software{browseros2025,
|
||||
author = {Nithin Sonti and Nikhil Sonti and {BrowserOS-team}},
|
||||
title = {BrowserOS: The open-source Agentic browser},
|
||||
url = {https://github.com/browseros-ai/BrowserOS},
|
||||
year = {2025},
|
||||
publisher = {GitHub},
|
||||
license = {AGPL-3.0},
|
||||
}
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
BrowserOS is open source under the [AGPL-3.0 license](LICENSE).
|
||||
|
||||
Copyright © 2026 Felafax, Inc.
|
||||
|
||||
## Stargazers
|
||||
|
||||
Thank you to all our supporters!
|
||||
|
||||
[](https://www.star-history.com/#browseros-ai/BrowserOS&Date)
|
||||
|
||||
##
|
||||
|
||||
<p align="center">
|
||||
Built with ❤️ from San Francisco
|
||||
</p>
|
||||
|
||||
@@ -1,461 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<rss version="2.0" xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle"
|
||||
xmlns:dc="http://purl.org/dc/elements/1.1/">
|
||||
<channel>
|
||||
<title>BrowserOS</title>
|
||||
<link>https://cdn.browseros.com/appcast-x86_64.xml</link>
|
||||
<description>Most recent changes with links to updates.</description>
|
||||
<language>en</language>
|
||||
|
||||
<!-- Updates -->
|
||||
<item>
|
||||
<title>Nxtscape - 0.27.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7215.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.27.0</sparkle:shortVersionString>
|
||||
<pubDate>Sat, 11 Oct 2025 11:30:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.27.0_x64.dmg"
|
||||
sparkle:edSignature="rC9E60py041mtwCcKzBII5kI0+dFDZKLYRSCqkhleypOx3LPznyulow1fm1yABx1xw2QyL/kg+OtLNLdQ3LTAA=="
|
||||
length="135429891"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>Nxtscape - 0.26.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7212.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.26.0</sparkle:shortVersionString>
|
||||
<pubDate>Tue, 01 Oct 2025 11:30:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.26.0_x64.dmg"
|
||||
sparkle:edSignature="PIus/BOdS567Sxmp3OuEm3BfNYOulu53Y/2nEEUN5TNOiqnIYJK1zlTwX5tsOaRYoA8CPdQvOkAtW0UtghoWBA=="
|
||||
length="135430173"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.25.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7209.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.25.0</sparkle:shortVersionString>
|
||||
<pubDate>Sun, 22 Sep 2025 08:00:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.25.0_x64.dmg"
|
||||
sparkle:edSignature="i/lCLlCNz3AKD+uLEp2NsQaTXtSS2MuqZ/SeiYYbf2Ap4AdTMAzqtItV5niue5GUAwMWcEMQuU0aqoeaV8NYAA=="
|
||||
length="135453902"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.24.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7207.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.24.0</sparkle:shortVersionString>
|
||||
<pubDate>Fri, 30 Aug 2025 12:00:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.24.0_x64.dmg"
|
||||
sparkle:edSignature="dbeHl4grX14zdCQARnpALmhroM+Ey+kJ1ljY6843sGfeYkZubjnAArgpUr58oPG3+tPVhxBaC/QMN11p0AooBQ=="
|
||||
length="135465476"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.23.1</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7204.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.23.1</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 29 Aug 2025 11:30:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.23.1_x64.dmg"
|
||||
sparkle:edSignature="NRRyYWHTk/JgrDXLAhzc/RYhqUfRND5M9IKUTsG3l7VWStr+W+4YWv/VyuQdxZoEOTHPZ5GHZ0B0j2FQevSpBw=="
|
||||
length="135442628"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.22.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7202.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.22.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 22 Aug 2025 11:30:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.22.0_x64.dmg"
|
||||
sparkle:edSignature="+SSF7mE4iHd4vVvS2mTTWy0RgGMykgXqDO8AFIQFqTW5KVMK/M+bsEvGXpxnpbC21eB6JrO/gomGadIdouqtAg=="
|
||||
length="135442129"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.21.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7201.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.21.0</sparkle:shortVersionString>
|
||||
<pubDate>Tue, 20 Aug 2025 11:30:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.21.0_x64.dmg"
|
||||
sparkle:edSignature="oDlfixK0KsYBU8BXzl3cStV1nmDggyjPWS+hWesRToRrwKqAAh/yJ1ljGuKVDGz8CEcL9b8aIJ7LpMuVBPHoDQ=="
|
||||
length="135459686"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.20.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- New updated Agent UI!
|
||||
- Fixed MacOS bug which caused the app to crash on startup for some users. This unfortunately also makes a breaking change, requiring re-installation of extensions and logins.
|
||||
</description>
|
||||
<sparkle:version>7200.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.20.1</sparkle:shortVersionString>
|
||||
<pubDate>Fri, 09 Aug 2025 16:30:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.20.1_x64.dmg"
|
||||
sparkle:edSignature="T4s+dVxu+pPQn2pE061esTHIaD8e3mYdYItFEIfXjQtopfxutUbzHoYei3CuccKGIS1oDTVgZAR3EXaWBK5xBQ=="
|
||||
length="135460780"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.19.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7197.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.19.0</sparkle:shortVersionString>
|
||||
<pubDate>Fri, 08 Aug 2025 11:44:55 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.19.0_x64.dmg"
|
||||
sparkle:edSignature="gutjJGWDCg77i+6gNtieugwUeTFTaJAApIdKzMGacukdEcfLrcQCXmjm/Oy+vbxtLfaRXHvrlMGDUS5pF4ExBg=="
|
||||
length="135466920"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.18.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- New revamped Agent infra! This should improve our agents reliability and performance. Please test it out and give us your feedback!
|
||||
</description>
|
||||
<sparkle:version>7194.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.18.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 31 Jul 2025 17:31:17 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.18.0_x64.dmg"
|
||||
sparkle:edSignature="bUOQce0PX58kMaVHrbJlcOWWWFXeD3bfd6Ju5DZ2OIXcQC7oO6w2TknEisDbvVJdwEAol5aZL0nR4qn3R7VqDw=="
|
||||
length="135451706"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.17.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7193.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.17.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 31 Jul 2025 07:40:48 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.17.0_x64.dmg"
|
||||
sparkle:edSignature="f06Nwl/C4j2uGX648eEoWzcOunmoBhAELZ1bvY9berEf0+RFew0YiW6QACuCZTTvi0IQqFbtof5tdMzRMZZkDg=="
|
||||
length="135960245"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.16.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7192.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.16.0</sparkle:shortVersionString>
|
||||
<pubDate>Tue, 29 Jul 2025 12:00:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.16.0_x64.dmg"
|
||||
sparkle:edSignature="hYJC8JIGrYiyikmtR7tCCiUJ1jQuKb7IaZm1PQNxl9gcM1YDMoSgQtmHeQocwC6+DmHrJJaC7QStiFsQS3mAAQ=="
|
||||
length="136273553"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.15.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- Support for screenshot in LLM chat.
|
||||
- New settings page `chrome://settings/browseros-settings` for configuring BrowserOS internals. Today, it supports hiding labels in toolbar.
|
||||
- Various fixes and improvesments.
|
||||
</description>
|
||||
<sparkle:version>7189.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.15.0</sparkle:shortVersionString>
|
||||
<pubDate>Sat, 26 Jul 2025 08:56:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.15.0_x64.dmg"
|
||||
sparkle:edSignature="ec0s8SskrESAKC0RfdjyK/CKO1Qg2pkEuzlZaU8mgQGh+4t0xrS/SGq7aWZyqjVcGNCLd59/uT82H93Ay42WCA=="
|
||||
length="136245910"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.14.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7187.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.14.0</sparkle:shortVersionString>
|
||||
<pubDate>Tue, 22 Jul 2025 15:45:34 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.14.1_x64.dmg"
|
||||
sparkle:edSignature="hqV7b4JvUiE46cz9X4vATddfuCUM/y4+jmb6SGg5/iN3bUH0L5meg7h8qt1y6cVulwyhZJdn32eKoGdjFw5VCg=="
|
||||
length="136240269"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<!-- <item> -->
|
||||
<!-- <title>BrowserOS - 0.13.0</title> -->
|
||||
<!-- <description sparkle:format="plain-text"> -->
|
||||
<!-- </description> -->
|
||||
<!-- <sparkle:version>7185.69</sparkle:version> -->
|
||||
<!-- <sparkle:shortVersionString>0.13.0</sparkle:shortVersionString> -->
|
||||
<!-- <pubDate>Fri, 18 Jul 2025 08:25:40 -0700</pubDate> -->
|
||||
<!-- <link>https://browseros.com</link> -->
|
||||
<!-- <enclosure -->
|
||||
<!-- url="http://cdn.browseros.com/dmg/BrowserOS_v0.13.0_x64.dmg" -->
|
||||
<!-- sparkle:edSignature="mewnvQD2+rR6d1iXkjvEJ6PwPKU1vr/x3GdYxv0o8alSt3w+NpMCBUj+ehwdd8jg9DgUvQDP+epPu+lJS6cfBw==" -->
|
||||
<!-- length="136158873" -->
|
||||
<!-- type="application/octet-stream" /> -->
|
||||
<!-- <sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion> -->
|
||||
<!-- </item> -->
|
||||
<item>
|
||||
<title>BrowserOS - 0.12.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7183.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.12.0</sparkle:shortVersionString>
|
||||
<pubDate>Fri, 11 Jul 2025 16:49:23 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.12.1_x64.dmg"
|
||||
sparkle:edSignature="lN1RsvzQAHkAWw70DjVN+xPU/4/6TT1vBDAAIiuGU9rQwby2ORVnikb9XioZ8UxxtYfmMdD4Uv9Jg/ZsZUm+Aw=="
|
||||
length="136154859"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.11.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7180.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.11.0</sparkle:shortVersionString>
|
||||
<pubDate>Wed, 09 Jul 2025 13:39:48 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.11.1_x64.dmg"
|
||||
sparkle:edSignature="gXrzzSVFS27aHLbnb21shwdOA/jGmWxkmECBR8pKmdJlkyhYUylD7XdiIZOBiNVn7J3WLMeND2CKIEwwwQL9CQ=="
|
||||
length="136112089"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.10.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- BrowserOS now supports Windows. Check our GitHub page for the Windows installer.
|
||||
- Added a new easy way to report bugs and request features from the browser.
|
||||
</description>
|
||||
<sparkle:version>7178.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.10.0</sparkle:shortVersionString>
|
||||
<pubDate>Sun, 07 Jul 2025 00:00:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.10.0_x64.dmg"
|
||||
sparkle:edSignature="6+ORfhZsUC0ICN6p7DAvkjgEYakRbHR+23/T0Xg99PGyfr4M9v3L510+/AYRiLIyTrG+9UoxsAWEEO3F2FyuDQ=="
|
||||
length="135988676"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.9.1</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7177.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.9.1</sparkle:shortVersionString>
|
||||
<pubDate>Sat, 05 Jul 2025 09:17:24 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.9.1_x64.dmg"
|
||||
sparkle:edSignature="smb5fqgAw2uYFPckukJQtQfHYWSG+UVpuzNm+2JPxTbmdErfcJeOc3S9+AjYMqvP1/R9B6K/PdGcYb19A+9BAw=="
|
||||
length="135870804"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.9.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- Minor stability improvements.
|
||||
</description>
|
||||
<sparkle:version>7175.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.9.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 03 Jul 2025 10:29:43 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.9.0_x64.dmg"
|
||||
sparkle:edSignature="KF7j6V9/IdNuGHWJoMpf4ZhSC6EJB5bnwH0rP8uWEzxBwsnbgMpdBP3VwoR+xF4pt90hQTYs/3SLra2KXdE0DA=="
|
||||
length="135898092"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.8.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- NEW FEATURE: Sidekick LLM. Brings third party LLMs to side panel.
|
||||
- Quickly toggle between ChatGPT, Claude, Gemini, Perplexity, and Ollama
|
||||
- Supports easy copy of web page content to paste in LLM
|
||||
</description>
|
||||
<sparkle:version>7174.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.8.0</sparkle:shortVersionString>
|
||||
<pubDate>Wed, 02 Jul 2025 14:20:34 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.8.0_x64.dmg"
|
||||
sparkle:edSignature="Uo7OjzJWFCHzjNOLFAODhELUUX1DE8UeOEP6+rXtGo7aSgPyQOvsk427crKsv6QHIBA+o5oCiS0IA4XofMkzCQ=="
|
||||
length="136446289"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.7.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- Improved agent to allow interruptions
|
||||
- Agent now supports pausing and resuming tasks
|
||||
</description>
|
||||
<sparkle:version>7170.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.7.0</sparkle:shortVersionString>
|
||||
<pubDate>Mon, 30 Jun 2025 17:50:17 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/nxtscape-v0.7.0-universal-new.dmg"
|
||||
sparkle:edSignature="uxb3EtLfK8YD1vsGo72bRXQ21MZVZcLNxLcwGNxXGbxWqFcTtk70VWa2RdGG+pZTbEwGUKJIwl3U5uvQYvDQBQ=="
|
||||
length="232749371"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.6.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- Support for MacOS x86_64 with Universal binary.
|
||||
- Minor fixes to updater
|
||||
- Improvements to agent; it supports interruptions.
|
||||
</description>
|
||||
<sparkle:version>7167.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.6.0</sparkle:shortVersionString>
|
||||
<pubDate>Sat, 28 Jun 2025 10:13:17 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/nxtscape-v0.6.0-universal.dmg"
|
||||
sparkle:edSignature="qB+KDJ0UQdQkhxX0QB89Yjo8oQIXIcdz8O6QRFJvNfLqDiZf8T7s2iiebt5LkZvvaN/Vp4c+5F3iBHokkTU2BQ=="
|
||||
length="234987508"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.5.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- Improved Ollama support
|
||||
- Fixed issues with the unified agent
|
||||
</description>
|
||||
<sparkle:version>7158.88</sparkle:version>
|
||||
<sparkle:shortVersionString>0.5.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 26 Jun 2025 17:42:44 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/nxtscape-v0.5.0-arm64.dmg"
|
||||
sparkle:edSignature="m3ALnVjkN5FE59Kh9VoXFBc8Dhz6GWgybAh6rKvv7b38EaEnFw8JI0hnC2pmB7e8QIJwFsPJCfE2OKOJf+OxAw=="
|
||||
length="126848776"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.4.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- [Fix] OTA updates were not working correctly for some users; fixing it.
|
||||
</description>
|
||||
<sparkle:version>7157.87</sparkle:version>
|
||||
<sparkle:shortVersionString>0.4.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 26 Jun 2025 17:42:44 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/nxtscape-v0.4.0-arm64.dmg"
|
||||
sparkle:edSignature="1TRv5Is7eKvqexbZ+h4Sa7ksPH4Sam2Eau8krwsK+w3AzhAQbRTY8Megfww2PsLxKhWzi3dBcEKK3yu8by0/CQ=="
|
||||
length="126851560"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.3.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
– Much improved AI agent for browser navigation tasks
|
||||
- Merged Productivity Agent and Browser Agent into a single AI agent
|
||||
</description>
|
||||
<sparkle:version>7155.85</sparkle:version>
|
||||
<sparkle:shortVersionString>0.3.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 26 Jun 2025 07:34:24 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/nxtscape-v0.3.0-arm64.dmg"
|
||||
sparkle:edSignature="axUY3tBN7txWh1PMCrrtHdYiIBFQlABBbD/iHyM29m9N9FWRu99vNJjyGPLP00mfctR+XzZIBE0E8MFGcgPYCg=="
|
||||
length="126850187"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.2.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
– Support for overriding baseUrl in OpenAI, Claude
|
||||
– Gemini support in BYOK
|
||||
– Improved tool calling in Browser Agent
|
||||
</description>
|
||||
<sparkle:version>7154.84</sparkle:version>
|
||||
<sparkle:shortVersionString>0.2.0</sparkle:shortVersionString>
|
||||
<pubDate>Wed, 25 Jun 2025 14:15:31 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/nxtscape-v0.2.0-arm64.dmg"
|
||||
sparkle:edSignature="mj8TqQBTbfBY5OxiQXpJa/XD82BPx9udDqFV7p8SwQRgBwCTHdYWuswBunL7uW6IrgEytBAtyHKTse+vcZG3BA=="
|
||||
length="126848485"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.1.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
– Updates to AI agent to perform better on navigation tasks
|
||||
– Improves to MacOS updater
|
||||
– Fixing history import bug
|
||||
</description>
|
||||
<sparkle:version>7151.139</sparkle:version>
|
||||
<sparkle:shortVersionString>0.1.0</sparkle:shortVersionString>
|
||||
<pubDate>Mon, 23 Jun 2025 00:00:00 +0000</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/BrowserOS_v0.1.0.dmg"
|
||||
sparkle:edSignature="mPxpc/8SPEEOiCmiKE4haTGUaMRnUQRJ8SK8w3sWek/5oZD0dg/DQFg/HxbhHjt2mtFUI8VD5iUi4+uIBWr4Dg=="
|
||||
length="127005947"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
|
||||
</channel>
|
||||
</rss>
|
||||
461
docs/appcast.xml
461
docs/appcast.xml
@@ -1,461 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<rss version="2.0" xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle"
|
||||
xmlns:dc="http://purl.org/dc/elements/1.1/">
|
||||
<channel>
|
||||
<title>BrowserOS</title>
|
||||
<link>https://cdn.browseros.com/appcast.xml</link>
|
||||
<description>Most recent changes with links to updates.</description>
|
||||
<language>en</language>
|
||||
|
||||
<!-- Updates -->
|
||||
<item>
|
||||
<title>Nxtscape - 0.27.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7215.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.27.0</sparkle:shortVersionString>
|
||||
<pubDate>Sat, 11 Oct 2025 11:30:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.27.0_arm64.dmg"
|
||||
sparkle:edSignature="TfKnBeD6kcvQS/hDnFv8m9mcjt25ifh0gkhE7LDrFqtQ02ELpF4MTmEKOne3hvz03meC4MiV8hn+mn6oRt97Dg=="
|
||||
length="126264714"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>Nxtscape - 0.26.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7212.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.26.0</sparkle:shortVersionString>
|
||||
<pubDate>Tue, 01 Oct 2025 11:30:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.26.0_arm64.dmg"
|
||||
sparkle:edSignature="fKllNsIyBZHWlsq6oT+6Ptg9RmG2zTV9RC1j73INkZAfayMXjffnoE2i6ENVbyybht8aqfH5miV/SOEBXIWpDQ=="
|
||||
length="126214534"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.25.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7209.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.25.0</sparkle:shortVersionString>
|
||||
<pubDate>Sun, 22 Sep 2025 08:00:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.25.0_arm64.dmg"
|
||||
sparkle:edSignature="c9KIdnku+N1NYHIwSLV8OFl2dFbTBAsVarg+FP7+0L744klbGpCpUMPWhcOxZsuyy9g5tfihg6W54z8HELXuDw=="
|
||||
length="126214063"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.24.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7207.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.24.0</sparkle:shortVersionString>
|
||||
<pubDate>Fri, 30 Aug 2025 12:00:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.24.0_arm64.dmg"
|
||||
sparkle:edSignature="ENs4SOHQdkaJY+sVp/r0/a+LUwaIb9mZdPJXUF0ymH2zGYGUM8hL+3b5U1MBhuHoYmMukdLqcDgheEi3U6CXBQ=="
|
||||
length="126221017"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.23.1</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7204.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.23.1</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 29 Aug 2025 11:30:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.23.1_arm64.dmg"
|
||||
sparkle:edSignature="mH97ZRH6JZ+XmLXv0S9wAK5n455Dgidzj9JYVoYoWI/kIOUTBeZODPunz9sCUAOkXA6WmjxFYciazjufxflVCg=="
|
||||
length="126211527"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.22.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7202.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.22.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 22 Aug 2025 11:30:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.22.0_arm64.dmg"
|
||||
sparkle:edSignature="pTuEhp05gDVf7bqNt0QJL51QsX+r9pe/NYNdMlV3cGW35JeDzyafbXQzBAgMYX6cQpcFGnOtDaxBLveuiK4kDw=="
|
||||
length="126204590"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.21.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7201.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.21.0</sparkle:shortVersionString>
|
||||
<pubDate>Tue, 20 Aug 2025 11:30:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.21.0_arm64.dmg"
|
||||
sparkle:edSignature="en02Zhdpa4J/zQ3Ly11psVJnsX8Bp5DS8+sK0sr3267xocHGCkfWN8BJmsZWkae7a1mlLh+2A1835PdX5CMmDg=="
|
||||
length="126187683"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.20.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- New updated Agent UI!
|
||||
- Fixed MacOS bug which caused the app to crash on startup for some users. This unfortunately also makes a breaking change, requiring re-installation of extensions and logins.
|
||||
</description>
|
||||
<sparkle:version>7200.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.20.1</sparkle:shortVersionString>
|
||||
<pubDate>Fri, 09 Aug 2025 16:30:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.20.1_arm64.dmg"
|
||||
sparkle:edSignature="E91Zyc0wi3fVmarYBAct5qldCeZ0cw9ZpmG4WgeW+b1/2DiYNIAO/3f1qYh5osoKLETHrjwumYDANC0ao9kfCw=="
|
||||
length="126189210"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.19.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7197.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.19.0</sparkle:shortVersionString>
|
||||
<pubDate>Fri, 08 Aug 2025 11:44:55 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.19.0_arm64.dmg"
|
||||
sparkle:edSignature="jaX1AJIWKxOgMQo4+Z6BcBSlDZ/3J3aD0hF5cZS1gwtVxPa1T9vh4YN9RZgZH37npJ0IavyLKgn5PxCCaBk9CA=="
|
||||
length="126186790"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.18.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- New revamped Agent infra! This should improve our agents reliability and performance. Please test it out and give us your feedback!
|
||||
</description>
|
||||
<sparkle:version>7194.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.18.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 31 Jul 2025 17:31:17 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.18.0_arm64.dmg"
|
||||
sparkle:edSignature="s+GbkCFBmj+5zC3BaykVVsfhua98X5JKMVFZhd5alAFok4qdVaywAvd/8H77UkAgiLiMm6E2pHQLrNI6LmPvAw=="
|
||||
length="126180751"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.17.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7193.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.17.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 31 Jul 2025 07:40:48 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.17.0_arm64.dmg"
|
||||
sparkle:edSignature="fQKHsZp60WVUi3UEdlOw9gpI42T4WWq1SWJUhXEMHWN+qTsVJEkbiLETZn9o7KO+nZQ1s5WRCKnS1ewIhJxMCw=="
|
||||
length="126729542"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.16.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7192.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.16.0</sparkle:shortVersionString>
|
||||
<pubDate>Tue, 29 Jul 2025 12:00:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.16.0_arm64.dmg"
|
||||
sparkle:edSignature="jSdcXs5C6Xd91r0smpxVbmHP3UfaB8avYcGrgxmHIn18jN2vPym9zJ8wL0HLxOYzYape0CjQnukZm/3t2ihCBA=="
|
||||
length="126951526"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.15.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- Support for screenshot in LLM chat.
|
||||
- New settings page `chrome://settings/browseros-settings` for configuring BrowserOS internals. Today, it supports hiding labels in toolbar.
|
||||
- Various fixes and improvesments.
|
||||
</description>
|
||||
<sparkle:version>7189.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.15.0</sparkle:shortVersionString>
|
||||
<pubDate>Sat, 26 Jul 2025 08:56:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.15.0_arm64.dmg"
|
||||
sparkle:edSignature="If0VdDR0xIm8atPGGd9yJJXgHiCg8vIHNqP35d8mPFzB/wbsU0FqW76ERnifrlhkE/bBabq4s6s+IyU2xDhSCQ=="
|
||||
length="126936522"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.14.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7187.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.14.0</sparkle:shortVersionString>
|
||||
<pubDate>Tue, 22 Jul 2025 15:45:34 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.14.1_arm64.dmg"
|
||||
sparkle:edSignature="pHnPKzUyVt1OXJNHZu4nNNW36TmRMEWsYqQjn2iHltyMYD5+G5b8s8NBD/2urcFb2Sq8tHNV7SvnQNhk6GXECQ=="
|
||||
length="126934811"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<!-- <item> -->
|
||||
<!-- <title>BrowserOS - 0.13.0</title> -->
|
||||
<!-- <description sparkle:format="plain-text"> -->
|
||||
<!-- </description> -->
|
||||
<!-- <sparkle:version>7185.69</sparkle:version> -->
|
||||
<!-- <sparkle:shortVersionString>0.13.0</sparkle:shortVersionString> -->
|
||||
<!-- <pubDate>Fri, 18 Jul 2025 08:25:40 -0700</pubDate> -->
|
||||
<!-- <link>https://browseros.com</link> -->
|
||||
<!-- <enclosure -->
|
||||
<!-- url="http://cdn.browseros.com/dmg/BrowserOS_v0.13.0_arm64.dmg" -->
|
||||
<!-- sparkle:edSignature="EDKjlrjUsrZfbpfA+uAYY7MDqnlGpWcm70+mGzmRt1xymn3t31SdPc16rJW/+h2bAV1yC8oLGqtEcPmVWsoRBw==" -->
|
||||
<!-- length="126827416" -->
|
||||
<!-- type="application/octet-stream" /> -->
|
||||
<!-- <sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion> -->
|
||||
<!-- </item> -->
|
||||
<item>
|
||||
<title>BrowserOS - 0.12.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7183.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.12.0</sparkle:shortVersionString>
|
||||
<pubDate>Fri, 11 Jul 2025 16:49:23 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.12.1_arm64.dmg"
|
||||
sparkle:edSignature="ylPrjpTj2JPFGdfqh3/DUSzTJxdlskrlORbZOqlsQsC04Euc1ovyzohTOBjyXKNDAekNa348ejKwQO/y7kKNBA=="
|
||||
length="126839083"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.11.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7180.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.11.0</sparkle:shortVersionString>
|
||||
<pubDate>Wed, 09 Jul 2025 13:39:48 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.11.1_arm64.dmg"
|
||||
sparkle:edSignature="g4PJb3tqiSx9NcB4rwg5byFWQl48TI30jYPDF47s1lt0qCWEhewSLOWktVnDNR8Wkk07dtf61conedSxkVZ6BA=="
|
||||
length="126847980"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.10.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- BrowserOS now supports Windows. Check our GitHub page for the Windows installer.
|
||||
- Added a new easy way to report bugs and request features from the browser.
|
||||
</description>
|
||||
<sparkle:version>7178.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.10.0</sparkle:shortVersionString>
|
||||
<pubDate>Sun, 07 Jul 2025 00:00:00 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.10.0_arm64.dmg"
|
||||
sparkle:edSignature="XMJ3Vy9/XiVf38yGS5ZxHZsKrexPTtuEHr0IzA/aKRL0sMd0MhwOAt3TD4iuQDwOuyWuLbj5Uaspq1eCXliuBA=="
|
||||
length="126798649"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.9.1</title>
|
||||
<description sparkle:format="plain-text">
|
||||
</description>
|
||||
<sparkle:version>7177.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.9.1</sparkle:shortVersionString>
|
||||
<pubDate>Sat, 05 Jul 2025 09:17:24 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.9.1_arm64.dmg"
|
||||
sparkle:edSignature="ZGaPXiLs0FI9aff7TKs2yoWyg1d+6nn+/EaHeJfLDIbe6URsRvWyNy2YmMmap1cexFyMAwYipkTbnW6G8np0Dw=="
|
||||
length="126804048"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.9.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- Minor stability improvements.
|
||||
</description>
|
||||
<sparkle:version>7175.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.9.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 03 Jul 2025 10:29:43 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.9.0_arm64.dmg"
|
||||
sparkle:edSignature="cGQ8f+VOOC4ZWsl02D2Wp5uaezoepaVC4Mo0a7tXxuB/Avb04d1nLQl6U7FNW4Q4EgPP3dni7TwXg61MSHX3Cg=="
|
||||
length="126796495"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.8.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- NEW FEATURE: Sidekick LLM. Brings third party LLMs to side panel.
|
||||
- Quickly toggle between ChatGPT, Claude, Gemini, Perplexity, and Ollama
|
||||
- Supports easy copy of web page content to paste in LLM
|
||||
</description>
|
||||
<sparkle:version>7174.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.8.0</sparkle:shortVersionString>
|
||||
<pubDate>Wed, 02 Jul 2025 14:20:34 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="http://cdn.browseros.com/dmg/BrowserOS_v0.8.0_arm64.dmg"
|
||||
sparkle:edSignature="jKMoMY44vqIXWmv06m/3NjEGEI4SwZTTRJ1bVoVSS8zjNNfAme8CpA/SsA8aBk1RyF3lhzHL0V5Fh4QmI5IYBw=="
|
||||
length="126966295"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.7.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- Improved agent to allow interruptions
|
||||
- Agent now supports pausing and resuming tasks
|
||||
</description>
|
||||
<sparkle:version>7170.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.7.0</sparkle:shortVersionString>
|
||||
<pubDate>Mon, 30 Jun 2025 17:50:17 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/nxtscape-v0.7.0-universal-new.dmg"
|
||||
sparkle:edSignature="uxb3EtLfK8YD1vsGo72bRXQ21MZVZcLNxLcwGNxXGbxWqFcTtk70VWa2RdGG+pZTbEwGUKJIwl3U5uvQYvDQBQ=="
|
||||
length="232749371"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.6.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- Support for MacOS x86_64 with Universal binary.
|
||||
- Minor fixes to updater
|
||||
- Improvements to agent; it supports interruptions.
|
||||
</description>
|
||||
<sparkle:version>7167.69</sparkle:version>
|
||||
<sparkle:shortVersionString>0.6.0</sparkle:shortVersionString>
|
||||
<pubDate>Sat, 28 Jun 2025 10:13:17 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/nxtscape-v0.6.0-universal.dmg"
|
||||
sparkle:edSignature="qB+KDJ0UQdQkhxX0QB89Yjo8oQIXIcdz8O6QRFJvNfLqDiZf8T7s2iiebt5LkZvvaN/Vp4c+5F3iBHokkTU2BQ=="
|
||||
length="234987508"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.5.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- Improved Ollama support
|
||||
- Fixed issues with the unified agent
|
||||
</description>
|
||||
<sparkle:version>7158.88</sparkle:version>
|
||||
<sparkle:shortVersionString>0.5.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 26 Jun 2025 17:42:44 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/nxtscape-v0.5.0-arm64.dmg"
|
||||
sparkle:edSignature="m3ALnVjkN5FE59Kh9VoXFBc8Dhz6GWgybAh6rKvv7b38EaEnFw8JI0hnC2pmB7e8QIJwFsPJCfE2OKOJf+OxAw=="
|
||||
length="126848776"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.4.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
- [Fix] OTA updates were not working correctly for some users; fixing it.
|
||||
</description>
|
||||
<sparkle:version>7157.87</sparkle:version>
|
||||
<sparkle:shortVersionString>0.4.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 26 Jun 2025 17:42:44 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/nxtscape-v0.4.0-arm64.dmg"
|
||||
sparkle:edSignature="1TRv5Is7eKvqexbZ+h4Sa7ksPH4Sam2Eau8krwsK+w3AzhAQbRTY8Megfww2PsLxKhWzi3dBcEKK3yu8by0/CQ=="
|
||||
length="126851560"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.3.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
– Much improved AI agent for browser navigation tasks
|
||||
- Merged Productivity Agent and Browser Agent into a single AI agent
|
||||
</description>
|
||||
<sparkle:version>7155.85</sparkle:version>
|
||||
<sparkle:shortVersionString>0.3.0</sparkle:shortVersionString>
|
||||
<pubDate>Thu, 26 Jun 2025 07:34:24 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/nxtscape-v0.3.0-arm64.dmg"
|
||||
sparkle:edSignature="axUY3tBN7txWh1PMCrrtHdYiIBFQlABBbD/iHyM29m9N9FWRu99vNJjyGPLP00mfctR+XzZIBE0E8MFGcgPYCg=="
|
||||
length="126850187"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.2.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
– Support for overriding baseUrl in OpenAI, Claude
|
||||
– Gemini support in BYOK
|
||||
– Improved tool calling in Browser Agent
|
||||
</description>
|
||||
<sparkle:version>7154.84</sparkle:version>
|
||||
<sparkle:shortVersionString>0.2.0</sparkle:shortVersionString>
|
||||
<pubDate>Wed, 25 Jun 2025 14:15:31 -0700</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/nxtscape-v0.2.0-arm64.dmg"
|
||||
sparkle:edSignature="mj8TqQBTbfBY5OxiQXpJa/XD82BPx9udDqFV7p8SwQRgBwCTHdYWuswBunL7uW6IrgEytBAtyHKTse+vcZG3BA=="
|
||||
length="126848485"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
<item>
|
||||
<title>BrowserOS - 0.1.0</title>
|
||||
<description sparkle:format="plain-text">
|
||||
– Updates to AI agent to perform better on navigation tasks
|
||||
– Improves to MacOS updater
|
||||
– Fixing history import bug
|
||||
</description>
|
||||
<sparkle:version>7151.139</sparkle:version>
|
||||
<sparkle:shortVersionString>0.1.0</sparkle:shortVersionString>
|
||||
<pubDate>Mon, 23 Jun 2025 00:00:00 +0000</pubDate>
|
||||
<link>https://browseros.com</link>
|
||||
<enclosure
|
||||
url="https://storage.googleapis.com/nxtscape/BrowserOS_v0.1.0.dmg"
|
||||
sparkle:edSignature="mPxpc/8SPEEOiCmiKE4haTGUaMRnUQRJ8SK8w3sWek/5oZD0dg/DQFg/HxbhHjt2mtFUI8VD5iUi4+uIBWr4Dg=="
|
||||
length="127005947"
|
||||
type="application/octet-stream" />
|
||||
<sparkle:minimumSystemVersion>10.15</sparkle:minimumSystemVersion>
|
||||
</item>
|
||||
|
||||
</channel>
|
||||
</rss>
|
||||
@@ -1,28 +0,0 @@
|
||||
---
|
||||
title: "Claude"
|
||||
description: "Configure BrowserOS to use Anthropic's Claude AI assistant"
|
||||
---
|
||||
|
||||
Claude Sonnet 3.7 and 4.0 are excellent for agent tasks. Great for complex reasoning and following instructions precisely.
|
||||
|
||||
## Get your API key
|
||||
|
||||
### Step 1: Go to Claude Console
|
||||
|
||||
Visit [console.anthropic.com](https://console.anthropic.com/dashboard) and click **API keys** in the left sidebar.
|
||||
|
||||

|
||||
|
||||
### Step 2: Create a key
|
||||
|
||||
Click **Create Key**, name it, and click **Create Key** again. Copy the key that appears.
|
||||
|
||||

|
||||
|
||||
## Configure BrowserOS
|
||||
|
||||
Click the settings icon in BrowserOS, then click **USE** on the Claude card. Paste your API key and set your model. For Claude Sonnet 4.0, use model ID `claude-opus-4-20250514`, set **Context Window Size** to `128000`, and check **Supports Images**. Click **Save**.
|
||||
|
||||

|
||||
|
||||
Done! You're ready to use BrowserOS with Claude.
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
title: "Gemini"
|
||||
description: "Configure BrowserOS to use Google's Gemini AI model"
|
||||
---
|
||||
|
||||
Gemini 2.5 Flash is fast, powerful, and free. Google AI Studio gives you 20 requests per minute at no cost - perfect for BrowserOS.
|
||||
|
||||
## Get your API key
|
||||
|
||||
### Step 1: Go to Google AI Studio
|
||||
|
||||
Visit [aistudio.google.com](https://aistudio.google.com) and click **Get API key** in the left sidebar.
|
||||
|
||||

|
||||
|
||||
### Step 2: Create a new project
|
||||
|
||||
Click **Create API key**, then name your project and click **Create key**.
|
||||
|
||||

|
||||
|
||||
### Step 3: Copy your API key
|
||||
|
||||
Your key will appear in the list. Click on it to copy.
|
||||
|
||||

|
||||
|
||||
## Configure BrowserOS
|
||||
|
||||
### Step 1: Open LLM settings
|
||||
|
||||
Click the settings icon in BrowserOS, then click **USE** on the Gemini card.
|
||||
|
||||

|
||||
|
||||
### Step 2: Configure your provider
|
||||
|
||||
In the provider configuration:
|
||||
1. Set **Model ID** to `gemini-2.5-flash`
|
||||
2. Paste your API key in the **API Key** field
|
||||
3. Check **Supports Images**
|
||||
4. Set **Context Window Size** to `1000000` (1 million tokens)
|
||||
5. Click **Save**
|
||||
|
||||

|
||||
|
||||
Done! You're ready to use BrowserOS with Gemini.
|
||||
@@ -1,32 +0,0 @@
|
||||
---
|
||||
title: "OpenAI"
|
||||
description: "Configure BrowserOS to use OpenAI's GPT models"
|
||||
---
|
||||
|
||||
GPT-4.1 is powerful for complex agent tasks. If you need the best reasoning capabilities, OpenAI is a solid choice.
|
||||
|
||||
## Get your API key
|
||||
|
||||
### Step 1: Go to OpenAI Platform
|
||||
|
||||
Visit [platform.openai.com](https://platform.openai.com), click the settings icon in the top right, then go to **API keys** in the left sidebar.
|
||||
|
||||

|
||||
|
||||
### Step 2: Create a new key
|
||||
|
||||
Click **Create new secret key**, name it, and click **Create secret key**.
|
||||
|
||||

|
||||
|
||||
### Step 3: Copy your key
|
||||
|
||||
Copy the key that appears. Keep it safe - you won't be able to see it again.
|
||||
|
||||
## Configure BrowserOS
|
||||
|
||||
Click the settings icon in BrowserOS, then click **USE** on the OpenAI card. Paste your API key and configure the settings based on your chosen model. For GPT-4.1, set **Context Window Size** to `128000` and check **Supports Images**. Click **Save**.
|
||||
|
||||

|
||||
|
||||
Done! You're ready to use BrowserOS with OpenAI.
|
||||
@@ -1,34 +0,0 @@
|
||||
---
|
||||
title: "Open Router"
|
||||
description: "Configure BrowserOS to use Open Router for access to multiple AI models"
|
||||
---
|
||||
|
||||
OpenRouter gives you access to 500+ models through one API. Try different models without managing multiple API keys.
|
||||
|
||||
## Get your API key
|
||||
|
||||
Visit [openrouter.ai](https://openrouter.ai), sign up, and create an API key. OpenRouter shows your key right on the homepage under "Get your API key".
|
||||
|
||||

|
||||
|
||||
## Configure BrowserOS
|
||||
|
||||
### Step 1: Add OpenRouter provider
|
||||
|
||||
Click the settings icon in BrowserOS, then click **USE** on the OpenRouter card.
|
||||
|
||||

|
||||
|
||||
### Step 2: Pick a model
|
||||
|
||||
Visit [openrouter.ai/models](https://openrouter.ai/models) and find the model you want. Click on it to copy the model ID (like `openai/gpt-4.1-mini`).
|
||||
|
||||

|
||||
|
||||
### Step 3: Configure your provider
|
||||
|
||||
In BrowserOS, paste the model ID into **Model ID** field. The model ID should be in the format shown under "Custom" (e.g., `openai/gpt-4.1-mini`). Paste your OpenRouter API key, set **Context Window Size** based on the model, and check **Supports Images** if the model supports it. Click **Save**.
|
||||
|
||||

|
||||
|
||||
Done! You can switch between different models anytime by creating new providers with different model IDs.
|
||||
@@ -1,97 +0,0 @@
|
||||
---
|
||||
title: "How To Guide"
|
||||
description: "Connect BrowserOS as an MCP server to Claude Code or Claude Desktop"
|
||||
---
|
||||
|
||||
BrowserOS runs as an MCP server, letting Claude control your browser directly—open tabs, scrape data, fill forms, and more. This guide shows you how to set it up.
|
||||
|
||||
## Claude Code
|
||||
|
||||
### Step 1: Download BrowserOS
|
||||
|
||||
Download and install BrowserOS for your platform:
|
||||
|
||||
- [macOS](https://files.browseros.com/download/BrowserOS.dmg)
|
||||
- [Windows](https://files.browseros.com/download/BrowserOS_installer.exe)
|
||||
- [Linux (AppImage)](https://files.browseros.com/download/BrowserOS.AppImage)
|
||||
- [Linux (Debian)](https://cdn.browseros.com/download/BrowserOS.deb)
|
||||
|
||||
After installation, complete the [onboarding](/onboarding) and [configure your LLM](/llm-setup-guide).
|
||||
|
||||
### Step 2: Enable MCP Server
|
||||
|
||||
In BrowserOS, click the settings icon in the top right corner:
|
||||
|
||||

|
||||
|
||||
Navigate to **MCP** in the sidebar, toggle **Enable MCP** on, and note the port number from the Server URL:
|
||||
|
||||

|
||||
|
||||
> **Note:** The default port is usually `9225`. You'll need this for the next step.
|
||||
|
||||
### Step 3: Install in Claude Code
|
||||
|
||||
In your terminal, add BrowserOS as an MCP server (replace `9225` with your port if different):
|
||||
|
||||
```bash
|
||||
claude mcp add --transport http browseros http://127.0.0.1:9225/mcp
|
||||
```
|
||||
|
||||
Restart Claude Code and verify the connection:
|
||||
|
||||
```bash
|
||||
/mcp
|
||||
```
|
||||
|
||||
You should see BrowserOS listed as a connected MCP server.
|
||||
|
||||
### Step 4: Start Using
|
||||
|
||||
Try it out! Ask Claude Code to control BrowserOS:
|
||||
|
||||
```
|
||||
Open amazon.com on browseros
|
||||
```
|
||||
|
||||
Claude can now open tabs, navigate, scrape data, and automate tasks in your browser.
|
||||
|
||||
---
|
||||
|
||||
## Claude Desktop
|
||||
|
||||
If you're using Claude Desktop instead of Claude Code:
|
||||
|
||||
### Step 1: Locate Config File
|
||||
|
||||
Open your Claude Desktop config file at:
|
||||
|
||||
```
|
||||
/Users/<username>/Library/Application Support/Claude/claude_desktop_config.json
|
||||
```
|
||||
|
||||
Replace `<username>` with your actual username.
|
||||
|
||||
### Step 2: Add BrowserOS MCP
|
||||
|
||||
Add the BrowserOS MCP server to your config:
|
||||
|
||||
```json
|
||||
claude_desktop_config.json
|
||||
{
|
||||
"mcpServers": {
|
||||
"browserOS": {
|
||||
"command": "npx",
|
||||
"args": ["mcp-remote", "http://127.0.0.1:9225/mcp"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> **Note:** Replace `9225` with your MCP port from BrowserOS settings if different.
|
||||
|
||||
### Step 3: Restart Claude Desktop
|
||||
|
||||
Restart Claude Desktop. You should see the MCP connection indicator showing BrowserOS is connected.
|
||||
|
||||

|
||||
176
docs/changelog.mdx
Normal file
176
docs/changelog.mdx
Normal file
@@ -0,0 +1,176 @@
|
||||
---
|
||||
title: "Changelog"
|
||||
description: "What's new in BrowserOS"
|
||||
---
|
||||
|
||||
All notable changes to BrowserOS are documented here. For the full release history with download links, see our [GitHub Releases](https://github.com/browseros-ai/BrowserOS/releases).
|
||||
|
||||
---
|
||||
|
||||
## v0.42.0
|
||||
<sub>March 9, 2026</sub>
|
||||
|
||||
- **SOUL.md** — Your assistant now has a soul. Tell it how you like to communicate, set boundaries, shape its personality — and it adapts on its own over time. The more you use it, the more it feels like *your* assistant. [Read more →](/features/soul)
|
||||
- **Vertical tabs** — One of the most requested features is here. BrowserOS now ships with vertical tabs by default. More screen space, better tab management, and a cleaner layout out of the box. Prefer horizontal? You can switch back anytime in settings. [Read more →](/features/vertical-tabs)
|
||||
- **Long-term memory** — Your assistant finally remembers you. Your name, your projects, what you talked about last week — it carries context across every conversation so you never have to repeat yourself. All stored locally on your machine. [Read more →](/features/memory)
|
||||
- **Chromium 146** — Updated to the latest Chromium release with all recent upstream fixes and security patches
|
||||
|
||||
<Frame>
|
||||
<img src="/images/changelog/0.42.0/soul-memory.png" alt="BrowserOS v0.42.0 SOUL.md feature for agent personalization" />
|
||||
</Frame>
|
||||
|
||||
<Frame>
|
||||
<img src="/images/changelog/0.42.0/vertical-tabs.png" alt="BrowserOS v0.42.0 vertical tabs toggle in settings" />
|
||||
</Frame>
|
||||
|
||||
---
|
||||
|
||||
## v0.41.0
|
||||
<sub>March 4, 2026</sub>
|
||||
|
||||
- **New agent (v3)** — Completely redone from scratch. 2x faster, 2–3x better performance
|
||||
- **Tools — major upgrade** — Agent tools and MCP server both got a big overhaul. ~20 new tools (54 total) including file upload, save as PDF, background windows, and more. Connection with third-party coding agents (Claude Code, Codex, etc.) is much better now
|
||||
- **General fixes** — Better agent installation, bug fixes, and smoother experience overall
|
||||
- **Linux Debian packaging** — Fixed the remaining Debian packaging issues
|
||||
|
||||
---
|
||||
|
||||
## v0.40.1
|
||||
<sub>February 16, 2026</sub>
|
||||
|
||||
- **Chromium 145** — Upgraded to the latest Chromium base with all recent upstream fixes and security patches
|
||||
- **Login session import improvements** — Importing login sessions is now more reliable
|
||||
- **Stability & reliability** — General improvements across the board
|
||||
|
||||
---
|
||||
|
||||
## v0.39.0
|
||||
<sub>February 3, 2026</sub>
|
||||
|
||||
- **Sync** — Save your browser configuration, agent history, and scheduled tasks across machines. Your setup now follows you wherever you go
|
||||
- **App Connector redesign** — Connecting MCP apps is now easier. The new App Connector UI makes it simpler to discover, install, and manage your connected apps
|
||||
- **MCP port stability** — Additional fixes for users still experiencing port issues. More reliable connections across restarts
|
||||
- **Keyboard shortcuts** — Updated shortcuts to avoid conflicts with European keyboards
|
||||
|
||||
<Frame>
|
||||
<img src="/images/changelog/0.39.0-sync-mcp.png" alt="BrowserOS v0.39.0 featuring Sync and improved MCP connectors" />
|
||||
</Frame>
|
||||
|
||||
---
|
||||
|
||||
## v0.38.0
|
||||
<sub>January 28, 2026</sub>
|
||||
|
||||
Bug fix and stability release.
|
||||
|
||||
- **MCP port fix on Windows & Linux** — Fixed an issue with MCP port. Port now stays consistent across restarts and made it more reliable
|
||||
- **Settings fix** — Fixed `chrome.browser.settings` not working correctly. Settings should now persist and apply as expected
|
||||
- **Improved agent** — Made the agent more reliable and performant. General stability fixes across the agent loop
|
||||
|
||||
---
|
||||
|
||||
## v0.37.0
|
||||
<sub>January 21, 2026</sub>
|
||||
|
||||
- **Workflows** — Build reliable, repeatable browser automations with a visual graph builder. Chat with the workflow agent to define step-by-step automation—ideal for complex tasks where ad-hoc prompts aren't enough. [Read more →](/features/workflows)
|
||||
|
||||
<img src="/features/workflow/sample-workflow.png" alt="Workflows visual graph builder showing a data entry automation" />
|
||||
|
||||
- **Cowork** — Describe an outcome, step away, and come back to finished work. Combine browser automation with local file operations—research on the web and save reports, scrape data and export to files, all in one task. [Read more →](/features/cowork)
|
||||
|
||||
<img src="/features/cowork/cowork-research-example.png" alt="Agent researching Hacker News and generating an HTML report" />
|
||||
|
||||
---
|
||||
|
||||
## v0.36.3
|
||||
<sub>January 15, 2026</sub>
|
||||
|
||||
- **Agent history** — Agent conversations are now saved automatically. View and resume them anytime from the Assistant panel
|
||||
|
||||
<img src="/images/changelog/0.36.3/agent-history-highlight.png" alt="Agent history button in the Assistant panel" />
|
||||
|
||||
<img src="/images/changelog/0.36.3/agent-history-example.png" alt="Agent history showing past conversations" />
|
||||
|
||||
---
|
||||
|
||||
## v0.36.2
|
||||
<sub>January 10, 2026</sub>
|
||||
|
||||
Bug fix release focused on MCP stability.
|
||||
|
||||
- **MCP server disconnect fix** — Fixed port handling issue causing MCP connections to drop unexpectedly
|
||||
|
||||
---
|
||||
|
||||
## v0.36.0
|
||||
<sub>January 8, 2026</sub>
|
||||
|
||||
- **Agent personalization** — Add your own prompts to personalize the agent. Tweak its behavior, adjust how it responds, set your preferred formatting, and more
|
||||
- **Toolbar customization** — Hide the Hub chat and labels from the settings page to declutter your toolbar
|
||||
- **MCP server port stability** — The port now stays consistent through browser restarts, so you don't have to keep updating your MCP clients
|
||||
- **Fixed agent install/update issues** — The agent now handles installs and updates more proactively
|
||||
|
||||
---
|
||||
|
||||
## v0.35.0
|
||||
<sub>December 25, 2025</sub>
|
||||
|
||||
- **Agent stability fixes** — Fixed bugs to make the agent loop much more reliable
|
||||
- **Gemini 3 support** — Gemini 3 now supported through OpenRouter and Google adapters
|
||||
- **Better error surfacing** — Error messages are now clearer
|
||||
|
||||
---
|
||||
|
||||
## v0.34.0
|
||||
<sub>December 20, 2025</sub>
|
||||
|
||||
- **Third-party MCP server support** — Connect external MCP servers like Google Calendar, Notion, Google Docs, Gmail, and more. You can also connect your own custom MCP servers
|
||||
- **Gemini 3 support** — Gemini 3 Pro and Flash models now work with BrowserOS
|
||||
- **Windows icon fix** — The Windows icon now displays BrowserOS logo correctly
|
||||
- **Agent & UI improvements** — Various agent loop fixes and UI polish
|
||||
|
||||
---
|
||||
|
||||
## v0.33.0
|
||||
<sub>December 18, 2025</sub>
|
||||
|
||||
- **OpenAI-compatible provider support** — Connect any OpenAI-compatible API endpoint
|
||||
- **Multi-window & multi-profile agent support** — Agent now works across multiple windows and browser profiles
|
||||
- **MCP server reliability** — Fixed connection drops and improved stability
|
||||
- **Agent reliability improvements** — General stability fixes
|
||||
|
||||
---
|
||||
|
||||
## v0.32.0
|
||||
<sub>December 12, 2025</sub>
|
||||
|
||||
A complete revamp of BrowserOS.
|
||||
|
||||
**New features:**
|
||||
- **New Agent** — Completely rebuilt agent: faster, smarter, and more reliable
|
||||
- **Agent Per Tab** — Run multiple agents in different tabs simultaneously
|
||||
- **Polished UI** — Fresh, cleaner interface design
|
||||
- **Manifest V2 Support** — Ad blockers like uBlock Origin work again
|
||||
- **Native Split View** — Work on two things side by side
|
||||
- **Chromium 142** — Updated to Chromium 142.0.7444.49
|
||||
- **Azure & AWS Bedrock** — Native support for Azure OpenAI and AWS Bedrock models
|
||||
|
||||
**Breaking changes:**
|
||||
- Old agent will stop working — update required
|
||||
- LLM provider settings won't carry over — reconfiguration needed
|
||||
|
||||
---
|
||||
|
||||
## v0.30.0
|
||||
<sub>November 14, 2025</sub>
|
||||
|
||||
- **Better text extraction** — Improved copy button in LLM Chat
|
||||
- **MCP server stability** — Improved connection reliability
|
||||
- **UI cleanup** — Unpinned extensions for cleaner look
|
||||
- **Third-party MCP fixes** — Fixed support for third-party MCP servers
|
||||
|
||||
---
|
||||
|
||||
<Note>
|
||||
For older releases, see the [full release history on GitHub](https://github.com/browseros-ai/BrowserOS/releases).
|
||||
</Note>
|
||||
201
docs/comparisons/chrome-devtools-mcp.mdx
Normal file
201
docs/comparisons/chrome-devtools-mcp.mdx
Normal file
@@ -0,0 +1,201 @@
|
||||
---
|
||||
title: "Chrome DevTools MCP"
|
||||
description: "A developer-focused comparison of BrowserOS MCP and Chrome DevTools MCP for browser automation"
|
||||
---
|
||||
|
||||
Both BrowserOS MCP and [Chrome DevTools MCP](https://github.com/ChromeDevTools/chrome-devtools-mcp) give AI agents control over a browser via the Model Context Protocol. But they're built for different scopes. Chrome DevTools MCP focuses on debugging and inspection, while BrowserOS MCP is a complete browser automation and app integration platform.
|
||||
|
||||
This page breaks down the differences for developers evaluating which to use with Claude Code, Gemini CLI, Cursor, or any MCP client.
|
||||
|
||||
---
|
||||
|
||||
## At a Glance
|
||||
|
||||
| | **BrowserOS MCP** | **Chrome DevTools MCP** |
|
||||
|---|---|---|
|
||||
| **Total MCP tools** | 53 | 29 |
|
||||
| **External app integrations** | 40+ (Gmail, Slack, GitHub, etc.) | None |
|
||||
| **Setup** | Copy URL from settings, works instantly | Requires `--remote-debugging-port` flag and separate server process |
|
||||
| **Browser session** | Your real browser with cookies, logins, extensions | Attached debug session (some sites block WebDriver-controlled browsers) |
|
||||
| **Architecture** | Built into the browser | External Node.js process connecting via CDP |
|
||||
|
||||
---
|
||||
|
||||
## Feature Comparison
|
||||
|
||||
### Navigation & Tab Management
|
||||
|
||||
| Feature | BrowserOS MCP | Chrome DevTools MCP |
|
||||
|---------|:---:|:---:|
|
||||
| Navigate to URL / back / forward / reload | `navigate_page` | `navigate_page` |
|
||||
| Open new tab | `new_page` | `new_page` |
|
||||
| Close tab | `close_page` | `close_page` |
|
||||
| List open tabs | `list_pages` | `list_pages` |
|
||||
| Switch to tab | `show_page` | `select_page` |
|
||||
| Hidden/background tabs | `new_hidden_page` | - |
|
||||
| Move tab between windows | `move_page` | - |
|
||||
| Get active/focused tab | `get_active_page` | - |
|
||||
| Wait for condition | - | `wait_for` |
|
||||
|
||||
### Content & Observation
|
||||
|
||||
| Feature | BrowserOS MCP | Chrome DevTools MCP |
|
||||
|---------|:---:|:---:|
|
||||
| Accessibility tree snapshot | `take_snapshot` | `take_snapshot` |
|
||||
| Enhanced structural snapshot | `take_enhanced_snapshot` | - |
|
||||
| Page content as Markdown | `get_page_content` | - |
|
||||
| Extract all page links | `get_page_links` | - |
|
||||
| Raw HTML / DOM access | `get_dom` | - |
|
||||
| Search DOM (text / CSS / XPath) | `search_dom` | - |
|
||||
| Screenshot | `take_screenshot` | `take_screenshot` |
|
||||
| Execute JavaScript | `evaluate_script` | `evaluate_script` |
|
||||
|
||||
### Interaction & Input
|
||||
|
||||
| Feature | BrowserOS MCP | Chrome DevTools MCP |
|
||||
|---------|:---:|:---:|
|
||||
| Click element | `click` | `click` |
|
||||
| Click at coordinates | `click_at` | - |
|
||||
| Type / fill text | `fill` | `fill` |
|
||||
| Fill entire form | - | `fill_form` |
|
||||
| Type text (raw keystrokes) | - | `type_text` |
|
||||
| Clear input | `clear` | - |
|
||||
| Hover | `hover` | `hover` |
|
||||
| Drag | `drag` | `drag` |
|
||||
| Press key / key combo | `press_key` | `press_key` |
|
||||
| Check / uncheck checkbox | `check` / `uncheck` | - |
|
||||
| Select dropdown option | `select_option` | - |
|
||||
| Focus element | `focus` | - |
|
||||
| Scroll (directional) | `scroll` | - |
|
||||
| Upload file | `upload_file` | `upload_file` |
|
||||
| Handle dialog (alert/confirm) | `handle_dialog` | `handle_dialog` |
|
||||
|
||||
### File & Export
|
||||
|
||||
| Feature | BrowserOS MCP | Chrome DevTools MCP |
|
||||
|---------|:---:|:---:|
|
||||
| Save page as PDF | `save_pdf` | - |
|
||||
| Save screenshot to disk | `save_screenshot` | - |
|
||||
| Download file via click | `download_file` | - |
|
||||
|
||||
### Window Management
|
||||
|
||||
| Feature | BrowserOS MCP | Chrome DevTools MCP |
|
||||
|---------|:---:|:---:|
|
||||
| List windows | `list_windows` | - |
|
||||
| Create window | `create_window` | - |
|
||||
| Create hidden window | `create_hidden_window` | - |
|
||||
| Close window | `close_window` | - |
|
||||
| Activate / focus window | `activate_window` | - |
|
||||
|
||||
### Tab Groups
|
||||
|
||||
| Feature | BrowserOS MCP | Chrome DevTools MCP |
|
||||
|---------|:---:|:---:|
|
||||
| List tab groups | `list_tab_groups` | - |
|
||||
| Create tab group | `group_tabs` | - |
|
||||
| Update group (title/color) | `update_tab_group` | - |
|
||||
| Ungroup tabs | `ungroup_tabs` | - |
|
||||
| Close tab group | `close_tab_group` | - |
|
||||
|
||||
### Bookmarks
|
||||
|
||||
| Feature | BrowserOS MCP | Chrome DevTools MCP |
|
||||
|---------|:---:|:---:|
|
||||
| List bookmarks | `get_bookmarks` | - |
|
||||
| Create bookmark / folder | `create_bookmark` | - |
|
||||
| Remove bookmark | `remove_bookmark` | - |
|
||||
| Update bookmark | `update_bookmark` | - |
|
||||
| Move bookmark | `move_bookmark` | - |
|
||||
| Search bookmarks | `search_bookmarks` | - |
|
||||
|
||||
### History
|
||||
|
||||
| Feature | BrowserOS MCP | Chrome DevTools MCP |
|
||||
|---------|:---:|:---:|
|
||||
| Search history | `search_history` | - |
|
||||
| Get recent history | `get_recent_history` | - |
|
||||
| Delete URL from history | `delete_history_url` | - |
|
||||
| Delete history range | `delete_history_range` | - |
|
||||
|
||||
### Debugging & Performance
|
||||
|
||||
| Feature | BrowserOS MCP | Chrome DevTools MCP |
|
||||
|---------|:---:|:---:|
|
||||
| Console messages | Coming soon | `get_console_message` / `list_console_messages` |
|
||||
| Network request inspection | Coming soon | `get_network_request` / `list_network_requests` |
|
||||
| Performance tracing | Coming soon | `performance_start_trace` / `performance_stop_trace` |
|
||||
| Performance analysis | Coming soon | `performance_analyze_insight` |
|
||||
| Memory snapshot | Coming soon | `take_memory_snapshot` |
|
||||
| Lighthouse audit | Coming soon | `lighthouse_audit` |
|
||||
| Device / network emulation | Coming soon | `emulate` |
|
||||
| Resize viewport | Coming soon | `resize_page` |
|
||||
|
||||
### External App Integrations
|
||||
|
||||
| Feature | BrowserOS MCP | Chrome DevTools MCP |
|
||||
|---------|:---:|:---:|
|
||||
| Gmail, Outlook | Yes | - |
|
||||
| Google Calendar, Outlook Calendar | Yes | - |
|
||||
| Slack, Discord, Teams, WhatsApp | Yes | - |
|
||||
| GitHub, GitLab | Yes | - |
|
||||
| Linear, Jira, Asana, Monday, ClickUp | Yes | - |
|
||||
| Notion, Google Docs/Sheets/Drive | Yes | - |
|
||||
| Figma, Canva | Yes | - |
|
||||
| Salesforce, HubSpot | Yes | - |
|
||||
| Shopify, Stripe | Yes | - |
|
||||
| 20+ more services | Yes | - |
|
||||
|
||||
---
|
||||
|
||||
## Setup Comparison
|
||||
|
||||
<Tabs>
|
||||
<Tab title="BrowserOS MCP">
|
||||
BrowserOS MCP is built into the browser. No separate process, no debug flags.
|
||||
|
||||
```bash
|
||||
# One command, done
|
||||
claude mcp add --transport http browseros http://127.0.0.1:9239/mcp --scope user
|
||||
```
|
||||
|
||||
The server URL is available at `chrome://browseros/mcp`. Copy it and connect.
|
||||
</Tab>
|
||||
<Tab title="Chrome DevTools MCP">
|
||||
Chrome DevTools MCP requires launching Chrome with remote debugging enabled and running a separate Node.js server.
|
||||
|
||||
```bash
|
||||
# Step 1: Launch Chrome with debug port
|
||||
/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222
|
||||
|
||||
# Step 2: Install and run the MCP server
|
||||
npx @anthropic-ai/chrome-devtools-mcp@latest
|
||||
|
||||
# Step 3: Connect your MCP client to the server
|
||||
```
|
||||
|
||||
Some sites may block sign-in when the browser is controlled via WebDriver (the default launch mechanism).
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
| Dimension | BrowserOS MCP | Chrome DevTools MCP |
|
||||
|-----------|:---:|:---:|
|
||||
| Browser automation tools | **54** | **29** |
|
||||
| External app integrations | **40+** | **0** |
|
||||
| Window management | Yes | No |
|
||||
| Tab groups | Yes | No |
|
||||
| Bookmarks & history | Yes | No |
|
||||
| File export (PDF, screenshots, downloads) | Yes | No |
|
||||
| Content extraction (Markdown, links, DOM) | Yes | No |
|
||||
| Console / network inspection | Coming soon | Yes |
|
||||
| Performance tracing & Lighthouse | Coming soon | Yes |
|
||||
| Memory snapshots | Coming soon | Yes |
|
||||
| Device emulation | Coming soon | Yes |
|
||||
| Setup complexity | Copy URL | Debug port + Node server |
|
||||
| Browser session | Real (cookies, extensions) | Debug-attached (WebDriver flags) |
|
||||
|
||||
BrowserOS MCP gives you a broader automation surface: browser control, content extraction, file operations, and 40+ app integrations through a single connection. Debugging and performance tools are coming soon to BrowserOS MCP, which will close the remaining gap with Chrome DevTools MCP. For most AI agent workflows, BrowserOS MCP already covers more ground out of the box.
|
||||
161
docs/comparisons/claude-cowork.mdx
Normal file
161
docs/comparisons/claude-cowork.mdx
Normal file
@@ -0,0 +1,161 @@
|
||||
---
|
||||
title: "Claude Cowork"
|
||||
description: "How BrowserOS Cowork compares to Claude Cowork for getting real work done with AI"
|
||||
---
|
||||
|
||||
Both BrowserOS Cowork and [Claude Cowork](https://claude.com/product/cowork) let an AI agent work with your local files autonomously. You describe a task, step away, and come back to completed work. They share a similar file toolkit under the hood. The key difference is what else each product can do. BrowserOS Cowork runs inside a real browser with full web access and 40+ app integrations. Claude Cowork runs inside an isolated VM with professional document generation.
|
||||
|
||||
This page compares both products so you can decide which fits your workflow.
|
||||
|
||||
---
|
||||
|
||||
## At a Glance
|
||||
|
||||
| | **BrowserOS Cowork** | **Claude Cowork** |
|
||||
|---|---|---|
|
||||
| **Runs in** | Your real browser | Claude Desktop app (VM) |
|
||||
| **File tools** | Read, write, edit, search, organize | Read, write, edit, search, organize |
|
||||
| **Browser automation** | Yes, 53 tools (click, type, screenshot, navigate, etc.) | No |
|
||||
| **App integrations** | 40+ (Gmail, Slack, GitHub, Calendar, Notion, etc.) | ~4 connectors (Google Drive, Gmail, DocuSign) |
|
||||
| **AI model** | Your choice (Claude, GPT, Gemini, Kimi, local models) | Claude only |
|
||||
| **Internet access** | Full (through your real browser) | Restricted |
|
||||
| **Document generation** | Basic (HTML, Markdown, CSV) | Advanced (Excel with formulas, PowerPoint, formatted docs) |
|
||||
| **Pricing** | Free (bring your own AI key) | Requires paid Claude subscription |
|
||||
| **Platform** | Any OS with BrowserOS | macOS, Windows x64 |
|
||||
|
||||
---
|
||||
|
||||
## Feature Comparison
|
||||
|
||||
### File Operations
|
||||
|
||||
Both products provide a comparable set of file tools. You can read, write, edit, search, and organize files in both. This is table-stakes for both products.
|
||||
|
||||
| What you can do | BrowserOS Cowork | Claude Cowork |
|
||||
|-----------------|:---:|:---:|
|
||||
| Read and view files | Yes | Yes |
|
||||
| Create and save new files | Yes | Yes |
|
||||
| Edit specific parts of a file | Yes | Yes |
|
||||
| Search inside files for text | Yes | Yes |
|
||||
| Find files by name or pattern | Yes | Yes |
|
||||
| List and browse folders | Yes | Yes |
|
||||
| Run commands/scripts | Yes | Yes |
|
||||
| Break work into parallel subtasks | Coming soon | Built-in sub-agents |
|
||||
|
||||
<Note>
|
||||
The file tools are largely equivalent. The real differentiator is what else each product can do beyond file operations.
|
||||
</Note>
|
||||
|
||||
### Working with the Web
|
||||
|
||||
This is the biggest difference. BrowserOS Cowork runs inside a real browser with your existing logins and sessions.
|
||||
|
||||
| What you can do | BrowserOS Cowork | Claude Cowork |
|
||||
|-----------------|:---:|:---:|
|
||||
| Open and navigate websites | Yes | No |
|
||||
| Click buttons, fill forms, type text | Yes | No |
|
||||
| Take screenshots of web pages | Yes | No |
|
||||
| Extract content from web pages | Yes | No |
|
||||
| Save pages as PDF | Yes | No |
|
||||
| Download files from the web | Yes | No |
|
||||
| Access sites where you're logged in | Yes (your real browser session) | No |
|
||||
| Manage tabs, windows, and bookmarks | Yes | No |
|
||||
| Search your browsing history | Yes | No |
|
||||
|
||||
Claude Cowork has no browser access. If your task involves anything on the web, whether that's researching, filling out forms, grabbing content from a site, or checking on a web app, you need BrowserOS.
|
||||
|
||||
### Connected Apps
|
||||
|
||||
BrowserOS connects to 40+ services directly. Claude Cowork has a handful of connectors.
|
||||
|
||||
| Service | BrowserOS Cowork | Claude Cowork |
|
||||
|---------|:---:|:---:|
|
||||
| Gmail | Yes | Yes |
|
||||
| Google Drive | Yes | Yes |
|
||||
| Google Calendar | Yes | Limited |
|
||||
| Slack | Yes | No |
|
||||
| GitHub | Yes | No |
|
||||
| Linear / Jira / Asana | Yes | No |
|
||||
| Notion | Yes | No |
|
||||
| Figma | Yes | No |
|
||||
| Salesforce / HubSpot | Yes | No |
|
||||
| Shopify / Stripe | Yes | No |
|
||||
| 30+ more services | Yes | No |
|
||||
|
||||
### Document Generation
|
||||
|
||||
Claude Cowork has an edge when it comes to creating polished office documents.
|
||||
|
||||
| What you can do | BrowserOS Cowork | Claude Cowork |
|
||||
|-----------------|:---:|:---:|
|
||||
| HTML and Markdown files | Yes | Yes |
|
||||
| CSV and data files | Yes | Yes |
|
||||
| Excel with working formulas | No | Yes |
|
||||
| PowerPoint presentations | No | Yes |
|
||||
| Formatted Word documents | No | Yes |
|
||||
|
||||
---
|
||||
|
||||
## How They Work
|
||||
|
||||
<Tabs>
|
||||
<Tab title="BrowserOS Cowork">
|
||||
BrowserOS Cowork runs inside the browser. The agent has access to your real browser session (cookies, logins, extensions) and a sandboxed folder on your computer.
|
||||
|
||||
- Works in your real browser with your existing logins
|
||||
- File access sandboxed to the folder you select
|
||||
- 40+ app integrations via OAuth
|
||||
- Connect from any AI tool (Claude Code, Gemini CLI, Cursor, etc.)
|
||||
- Uses whatever AI model you choose
|
||||
</Tab>
|
||||
<Tab title="Claude Cowork">
|
||||
Claude Cowork runs in an isolated virtual machine on your desktop via the Claude Desktop app.
|
||||
|
||||
- Runs in a secure VM, isolated from your main system
|
||||
- File access to folders you grant permission to
|
||||
- ~4 connectors (Google Drive, Gmail, DocuSign, FactSet)
|
||||
- Only works in the Claude Desktop app
|
||||
- Uses Claude models only
|
||||
- Comes pre-loaded with Python, Node.js, Ruby, and common tools
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
---
|
||||
|
||||
## Where Claude Cowork Shines
|
||||
|
||||
- **Professional documents**: Create Excel spreadsheets with working formulas, PowerPoint presentations, and formatted Word documents
|
||||
- **Parallel subtasks**: Automatically breaks complex work into smaller tasks that run at the same time
|
||||
- **Stronger isolation**: Runs in a full virtual machine, giving you OS-level separation from your main system
|
||||
- **Zero setup**: Works out of the box in the Claude Desktop app with pre-installed tools and languages
|
||||
|
||||
---
|
||||
|
||||
## Where BrowserOS Cowork Shines
|
||||
|
||||
- **Full browser access**: Navigate websites, fill forms, click buttons, take screenshots, and extract content from any page. Claude Cowork cannot touch the web.
|
||||
- **Your real logins**: Because it runs in your actual browser, the agent can access sites where you're already logged in: dashboards, internal tools, social media, banking portals, anything.
|
||||
- **40+ app integrations**: Gmail, Slack, GitHub, Calendar, Notion, Linear, Figma, Salesforce, and more. All accessible in the same session as your file work. Claude Cowork has about 4 connectors.
|
||||
- **Pick your AI model**: Use Claude, GPT-5, Gemini, Kimi K2.5, or a local model. Claude Cowork only works with Claude.
|
||||
- **Full internet access**: Your agent can visit any website. Claude Cowork's VM is restricted to a short list of allowed sites.
|
||||
- **Free**: BrowserOS is free. Just bring your own AI API key. Claude Cowork requires a paid Claude subscription.
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
| | BrowserOS Cowork | Claude Cowork |
|
||||
|---|:---:|:---:|
|
||||
| File tools (read, write, edit, search) | Yes | Yes |
|
||||
| Browse the web | **Yes (53 tools)** | No |
|
||||
| Connected apps | **40+** | ~4 |
|
||||
| Internet access | Full | Restricted |
|
||||
| Choose your AI model | Yes | Claude only |
|
||||
| Works with other AI tools | Yes (Claude Code, Gemini CLI, Cursor, etc.) | Claude Desktop only |
|
||||
| Excel, PowerPoint, Word | No | **Yes** |
|
||||
| Parallel subtasks | Coming soon | **Built-in** |
|
||||
| Security model | Folder-level sandbox | VM isolation |
|
||||
| Platform | Any OS | macOS, Windows x64 |
|
||||
| Pricing | Free + API key | Paid subscription |
|
||||
|
||||
Both products handle file operations equally well. The choice comes down to what else you need. If your work touches the web, connected apps, or you want to choose your own AI model, BrowserOS Cowork gives you that. If you need polished office documents and prefer a fully isolated desktop experience, Claude Cowork is a good fit.
|
||||
143
docs/comparisons/openclaw.mdx
Normal file
143
docs/comparisons/openclaw.mdx
Normal file
@@ -0,0 +1,143 @@
|
||||
---
|
||||
title: "OpenClaw"
|
||||
description: "How BrowserOS compares to OpenClaw for everyday AI assistance"
|
||||
---
|
||||
|
||||
[OpenClaw](https://openclaw.ai/) is an open-source personal AI assistant that runs on your machine and connects through messaging apps like WhatsApp, Telegram, Slack, and Discord. It is a powerful tool for technical users who want a self-hosted, always-on AI agent.
|
||||
|
||||
BrowserOS takes a different approach. Instead of running a background server that you message through chat apps, BrowserOS puts the AI assistant directly inside your browser, where most of your work already happens. No terminal setup, no daemon management, no Node.js required.
|
||||
|
||||
This comparison is for users deciding which tool fits their needs.
|
||||
|
||||
## At a Glance
|
||||
|
||||
| | **BrowserOS** | **OpenClaw** |
|
||||
|---|---|---|
|
||||
| **What it is** | AI-powered browser with built-in assistant | Self-hosted AI agent you message through chat apps |
|
||||
| **Setup** | Download and open | Install via npm, run onboarding wizard, configure daemon |
|
||||
| **Technical skill needed** | None | Comfortable with terminal and Node.js |
|
||||
| **Interface** | Built into your browser | WhatsApp, Telegram, Slack, Discord, iMessage, and 15+ more |
|
||||
| **Browser automation** | 53 tools (clicks, forms, navigation, screenshots, tabs, bookmarks, history) | Chrome via CDP (snapshots and actions) |
|
||||
| **App integrations** | 40+ built-in (OAuth or API key depending on the service) | Skills-based (community-built, self-installable) |
|
||||
| **Memory** | Two-tier: permanent core facts + 30-day daily notes | Persistent memory across conversations |
|
||||
| **Personality** | SOUL.md (inspired by OpenClaw's original concept) | SOUL.md (originated the concept) |
|
||||
| **LLM support** | 11+ providers including local models (Ollama, LM Studio) | Multiple providers with failover routing |
|
||||
| **Runs on** | macOS, Windows, Linux | macOS, Windows, Linux (+ iOS/Android companion apps) |
|
||||
| **Authentication** | OAuth or API key depending on the service | API keys, OAuth, pairing codes per channel |
|
||||
| **Open source** | Yes (AGPL-3.0) | Yes (MIT) |
|
||||
|
||||
## Where BrowserOS Shines
|
||||
|
||||
### No technical setup required
|
||||
|
||||
OpenClaw requires Node.js 22+, npm installation, a terminal-based onboarding wizard, daemon configuration (launchd or systemd), and channel pairing for each messaging platform. If something goes wrong, you need `openclaw doctor` to diagnose issues.
|
||||
|
||||
BrowserOS is a browser. Download it, open it, and start talking to the assistant. There is no daemon to manage, no services to keep running, and no terminal needed.
|
||||
|
||||
### Browser automation built in
|
||||
|
||||
BrowserOS gives the assistant full control of your browser with 53 tools: clicking buttons, filling forms, navigating between pages, taking screenshots, managing tabs, organizing bookmarks, searching history, and more. The assistant sees what you see and can interact with any website you are logged into.
|
||||
|
||||
OpenClaw has browser automation through a dedicated Chrome instance with CDP, but it runs as a separate process rather than being integrated into the browser you are already using. With BrowserOS, the assistant works directly in your browsing session with all your cookies, logins, and open tabs.
|
||||
|
||||
### 40+ app integrations built in
|
||||
|
||||
BrowserOS connects to Gmail, Google Calendar, Slack, Notion, GitHub, Linear, Jira, Figma, Salesforce, Stripe, and 30+ more services out of the box. Most services connect through OAuth (one-click sign-in), while some require an API key. Either way, the assistant detects when an app is not connected and walks you through the setup right in the conversation.
|
||||
|
||||
OpenClaw uses a skills system where integrations are community-built plugins. Some popular services have skills available, but connecting a new service often means finding the right skill, installing it, and configuring credentials manually.
|
||||
|
||||
### Works where you already are
|
||||
|
||||
Most of your work happens in a browser. BrowserOS puts the assistant right there, so it can see the page you are on, interact with web apps, and pull data from your open tabs. There is no context-switching between a chat app and your browser.
|
||||
|
||||
OpenClaw's approach of messaging through WhatsApp or Telegram is clever for mobile use, but when you are at your computer working in a browser, having the assistant inside that browser is more natural and more capable.
|
||||
|
||||
## Where OpenClaw Shines
|
||||
|
||||
### Messaging app access
|
||||
|
||||
OpenClaw connects to 20+ messaging platforms including WhatsApp, Telegram, Signal, iMessage, Discord, Slack, Microsoft Teams, and more. You can message your assistant from your phone or any chat app without opening a specific application. This is ideal if you want AI help on the go through apps you already have open.
|
||||
|
||||
BrowserOS is a desktop browser. To use the assistant, you need to be in BrowserOS.
|
||||
|
||||
### Always-on background agent
|
||||
|
||||
OpenClaw runs as a daemon on your machine, processing tasks even when you are not actively chatting. It supports cron jobs, webhooks, and Gmail Pub/Sub for automated triggers. It can wake up, do something, and report back through your messaging app.
|
||||
|
||||
BrowserOS has [scheduled tasks](/features/scheduled-tasks) that run automations on a schedule, but the browser needs to be running. OpenClaw's daemon approach is more suited for server-like always-on operation.
|
||||
|
||||
### Mobile companion apps
|
||||
|
||||
OpenClaw offers iOS and Android companion apps with camera access, voice input, screen recording, and device-level actions (notifications, contacts, calendar, SMS). This extends the assistant to your phone in a way that BrowserOS cannot currently match.
|
||||
|
||||
### Agent-to-agent communication
|
||||
|
||||
OpenClaw supports multi-session agent coordination where agents can discover each other, read transcripts, and send messages between sessions. This is useful for complex workflows where multiple specialized agents collaborate.
|
||||
|
||||
### Self-modifying skills
|
||||
|
||||
OpenClaw agents can write and install their own skills during a conversation. If the assistant does not have a capability, it can create one on the fly. This makes it extremely flexible for power users who want the agent to extend itself.
|
||||
|
||||
## Feature Comparison
|
||||
|
||||
### App Integrations
|
||||
|
||||
| Service | BrowserOS | OpenClaw |
|
||||
|---------|-----------|----------|
|
||||
| Gmail | Built-in (OAuth) | Skill + API setup |
|
||||
| Google Calendar | Built-in (OAuth) | Skill + API setup |
|
||||
| Slack | Built-in (OAuth) | Built-in channel |
|
||||
| Discord | Built-in (OAuth) | Built-in channel |
|
||||
| Notion | Built-in (OAuth) | Skill |
|
||||
| GitHub | Built-in (OAuth) | Skill |
|
||||
| Linear | Built-in (OAuth or API key) | Skill |
|
||||
| Jira | Built-in (OAuth) | Skill |
|
||||
| Figma | Built-in (OAuth) | Skill |
|
||||
| Salesforce | Built-in (OAuth) | Skill |
|
||||
| Stripe | Built-in (API key) | Skill |
|
||||
| WhatsApp | Built-in (OAuth) | Built-in channel |
|
||||
| Shopify | Built-in (OAuth or API key) | Community skill |
|
||||
| Total integrations | 40+ built-in | 50+ via skills |
|
||||
|
||||
### Memory and Personality
|
||||
|
||||
| Feature | BrowserOS | OpenClaw |
|
||||
|---------|-----------|----------|
|
||||
| Persistent memory | Core facts (permanent) + daily notes (30 days) | Persistent across sessions |
|
||||
| Memory location | Local files on your machine | Local files on your machine |
|
||||
| Personality system | SOUL.md (inspired by OpenClaw) | SOUL.md (originated the concept) |
|
||||
| Memory search | Fuzzy search across all memories | Context-based recall |
|
||||
|
||||
### Setup and Maintenance
|
||||
|
||||
| | BrowserOS | OpenClaw |
|
||||
|---|-----------|----------|
|
||||
| Installation | Download browser | `npm install -g openclaw`, run onboarding wizard |
|
||||
| Runtime | Open the browser | Daemon process (launchd/systemd) |
|
||||
| Updates | Auto-update | `openclaw update --channel stable` |
|
||||
| Troubleshooting | Built-in | `openclaw doctor` CLI tool |
|
||||
| Node.js required | No | Yes (v22+) |
|
||||
| Terminal required | No | Yes |
|
||||
|
||||
## Who Should Use What
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Choose BrowserOS if you..." icon="browser">
|
||||
- Want an AI assistant without any technical setup
|
||||
- Do most of your work in a browser
|
||||
- Need browser automation (filling forms, clicking buttons, extracting data)
|
||||
- Want 40+ app integrations that connect with one click
|
||||
- Prefer a visual interface over terminal commands
|
||||
</Card>
|
||||
<Card title="Choose OpenClaw if you..." icon="terminal">
|
||||
- Want to message your AI from WhatsApp, Telegram, or Signal
|
||||
- Need an always-on agent that runs 24/7 as a background service
|
||||
- Are comfortable with Node.js and terminal-based setup
|
||||
- Want mobile companion apps for on-the-go access
|
||||
- Need agents that can write their own extensions
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Using Both Together
|
||||
|
||||
BrowserOS and OpenClaw are not mutually exclusive. Some users run OpenClaw as their always-on mobile assistant (accessible through WhatsApp or Telegram) while using BrowserOS as their desktop browser for work that involves web apps, browser automation, and visual tasks. The two tools complement each other rather than compete directly.
|
||||
@@ -1,490 +1,267 @@
|
||||
---
|
||||
title: "Contributing to BrowserOS"
|
||||
description: "Let's build the best open-source browser!"
|
||||
icon: "code-branch"
|
||||
description: "Guide to contributing to BrowserOS"
|
||||
---
|
||||
|
||||
Hey there! Thanks for your interest in BrowserOS. Whether you're fixing bugs, adding features, improving docs, or just poking around the code, we're glad you're here.
|
||||
BrowserOS has two main parts you can contribute to:
|
||||
|
||||
BrowserOS is a monorepo with two main parts:
|
||||
- **Agent** - The Chrome extension with AI features (TypeScript/React)
|
||||
- **Browser** - The custom Chromium build (C++/Python)
|
||||
- **Agent** — The AI features, UI, and browser automation (TypeScript/React)
|
||||
- **Browser** — The custom Chromium build (C++/Python)
|
||||
|
||||
Most folks start with the agent since it's way easier to set up and iterate on.
|
||||
Most contributors work on the Agent since it's much easier to set up.
|
||||
|
||||
## 1. Quick Links
|
||||
## Quick Links
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card
|
||||
title="GitHub Repository"
|
||||
icon="github"
|
||||
href="https://github.com/BrowserOS/BrowserOS"
|
||||
>
|
||||
Star, fork, and contribute to our codebase
|
||||
</Card>
|
||||
<Card
|
||||
title="Discord Community"
|
||||
icon="discord"
|
||||
href="https://discord.gg/YKwjt5vuKr"
|
||||
>
|
||||
Join our community for discussions and support
|
||||
</Card>
|
||||
<Card
|
||||
title="Report Issues"
|
||||
icon="bug"
|
||||
href="https://github.com/BrowserOS/BrowserOS/issues"
|
||||
>
|
||||
Report bugs or suggest new features
|
||||
</Card>
|
||||
</CardGroup>
|
||||
- [GitHub Repository](https://github.com/BrowserOS-ai/BrowserOS)
|
||||
- [Discord Community](https://discord.gg/YKwjt5vuKr)
|
||||
- [Report Issues](https://github.com/BrowserOS-ai/BrowserOS/issues)
|
||||
|
||||
## 2. Ways to Contribute
|
||||
## Ways to Contribute
|
||||
|
||||
You can contribute to BrowserOS in many ways! Whether you want to build features or help out in other ways, we appreciate all contributions.
|
||||
**Report bugs** — [Open an issue](https://github.com/browseros-ai/BrowserOS/issues/new) with steps to reproduce, expected vs actual behavior, and screenshots.
|
||||
|
||||
<Tabs>
|
||||
<Tab title="🐛 Report Bugs">
|
||||
Found a bug? [Open an issue](https://github.com/browseros-ai/BrowserOS/issues/new) with:
|
||||
- Clear description
|
||||
- Steps to reproduce
|
||||
- Expected vs actual behavior
|
||||
- Screenshots/videos
|
||||
- Environment details (OS, browser version, BrowserOS version)
|
||||
</Tab>
|
||||
**Suggest features** — Share ideas on [GitHub](https://github.com/browseros-ai/BrowserOS/issues/99) or [Discord](https://discord.gg/YKwjt5vuKr).
|
||||
|
||||
<Tab title="💡 Suggest Features">
|
||||
Have an idea? [Share it here](https://github.com/browseros-ai/BrowserOS/issues/99) or chat with us on [Discord](https://discord.gg/YKwjt5vuKr).
|
||||
</Tab>
|
||||
**Improve docs** — Docs live in `docs/` and use Mintlify. Edit pages and update `docs/docs.json` for navigation.
|
||||
|
||||
<Tab title="📚 Improve Docs">
|
||||
We use <b>Mintlify</b> for our documentation. All docs live in the <code>docs/</code> directory.
|
||||
---
|
||||
|
||||
- Add new documentation pages or update existing ones under <code>docs/</code>
|
||||
- Help clarify instructions; add examples, tutorials, or guides
|
||||
- After adding or editing a page, update <code>docs/docs.json</code> to include your new or changed file in the navigation
|
||||
## Path 1: Agent Development
|
||||
|
||||
If you have questions about the docs system, ask in Discord!
|
||||
</Tab>
|
||||
</Tabs>
|
||||
The Agent is a monorepo with 3 components:
|
||||
|
||||
## 3. Pick Your Path
|
||||
| Component | Path | What it does |
|
||||
|-----------|------|--------------|
|
||||
| **Agent UI** | `apps/agent` | Chrome extension — chat interface, settings, side panel |
|
||||
| **Server** | `apps/server` | Bun server — agent loop, MCP tools, API endpoints |
|
||||
| **Controller** | `apps/controller-ext` | Chrome extension — bridges `chrome.*` APIs to the server |
|
||||
|
||||
If you want to contribute to development, here are two paths you can take:
|
||||
### Architecture
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Agent Development" icon="robot">
|
||||
**What you'll work on:**
|
||||
- AI agent features & tools
|
||||
- UI/UX improvements
|
||||
- Browser automation
|
||||
- Testing & docs
|
||||
<img src="/images/contributing--architecture.png" alt="BrowserOS Agent architecture diagram" />
|
||||
|
||||
**What you need:**
|
||||
- Node.js 18+
|
||||
- ~500MB disk space
|
||||
- 10 minutes to set up
|
||||
### Setup
|
||||
|
||||
**Skills:** TypeScript, React, Chrome APIs
|
||||
</Card>
|
||||
<Card title="Browser Development" icon="globe">
|
||||
**What you'll work on:**
|
||||
- Chromium patches
|
||||
- Build system
|
||||
- Platform features
|
||||
- Core browser stuff
|
||||
```bash
|
||||
# Clone the repo
|
||||
git clone https://github.com/YOUR-USERNAME/BrowserOS.git
|
||||
cd BrowserOS/packages/browseros-agent
|
||||
|
||||
**What you need:**
|
||||
- ~100GB disk space
|
||||
- 16GB+ RAM (recommended)
|
||||
- 3+ hours for first build
|
||||
# Install dependencies
|
||||
bun install
|
||||
|
||||
**Skills:** C++, Python, Chromium internals
|
||||
</Card>
|
||||
</CardGroup>
|
||||
# Copy environment files
|
||||
cp apps/server/.env.example apps/server/.env.development
|
||||
cp apps/agent/.env.example apps/agent/.env.development
|
||||
```
|
||||
|
||||
### 3.1 Agent Development
|
||||
### Running Locally
|
||||
|
||||
The agent is a Chrome extension that provides AI-powered automation. Most contributors work here.
|
||||
```bash
|
||||
# Terminal 1: Start the server
|
||||
bun run start:server
|
||||
|
||||
<Accordion title="Instructions">
|
||||
# Terminal 2: Start the agent extension (dev mode)
|
||||
bun run start:agent
|
||||
```
|
||||
|
||||
#### Quick Setup
|
||||
Then load the extension in BrowserOS:
|
||||
1. Go to `chrome://extensions/`
|
||||
2. Enable **Developer mode**
|
||||
3. Click **Load unpacked** and select the `apps/agent/dist/` folder
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to Agent Directory">
|
||||
```bash
|
||||
cd packages/browseros-agent
|
||||
```
|
||||
</Step>
|
||||
### Commands
|
||||
|
||||
<Step title="Install Dependencies">
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
</Step>
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `bun run start:server` | Start the server |
|
||||
| `bun run start:agent` | Start agent extension (dev mode) |
|
||||
| `bun run build:server` | Build server for production |
|
||||
| `bun run build:agent` | Build agent extension |
|
||||
| `bun run build:ext` | Build controller extension |
|
||||
| `bun run test` | Run tests |
|
||||
| `bun run lint` | Check with Biome |
|
||||
| `bun run typecheck` | TypeScript check |
|
||||
|
||||
<Step title="Set Up Environment">
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
Edit `.env` and add your `LITELLM_API_KEY`
|
||||
</Step>
|
||||
---
|
||||
|
||||
<Step title="Build the Extension">
|
||||
```bash
|
||||
yarn build:dev # One-time build
|
||||
```
|
||||
</Step>
|
||||
</Steps>
|
||||
## Path 2: Browser Development
|
||||
|
||||
#### Load in BrowserOS
|
||||
Only go down this path if you're working on Chromium-level features like patches to the browser itself.
|
||||
|
||||
<Steps>
|
||||
<Step title="Open Extensions Page">
|
||||
Navigate to `chrome://extensions/`
|
||||
</Step>
|
||||
**Requirements:**
|
||||
- ~100GB disk space
|
||||
- 16GB+ RAM recommended
|
||||
- 3+ hours for first build
|
||||
|
||||
<Step title="Enable Developer Mode">
|
||||
Toggle **Developer mode** in the top right
|
||||
</Step>
|
||||
|
||||
<Step title="Load Unpacked Extension">
|
||||
Click **Load unpacked** and select `packages/browseros-agent/dist/`
|
||||
</Step>
|
||||
|
||||
<Step title="Open Agent Panel">
|
||||
Press the Agent icon from the extensions toolbar to open the agent panel
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Note>
|
||||
For detailed setup, architecture, and code standards, see the [Agent Contributing Guide](https://github.com/BrowserOS/BrowserOS/blob/main/packages/browseros-agent/CONTRIBUTING.md).
|
||||
</Note>
|
||||
|
||||
</Accordion>
|
||||
|
||||
### 3.2 Browser Development
|
||||
|
||||
Building the custom Chromium browser requires significant disk space and time. Only go down this path if you're working on browser-level features like patches to Chromium itself.
|
||||
|
||||
<Accordion title="Instructions">
|
||||
|
||||
#### Prerequisites
|
||||
### Prerequisites
|
||||
|
||||
<Tabs>
|
||||
<Tab title="macOS">
|
||||
- macOS (tested on M4 Max)
|
||||
- Xcode and Command Line Tools
|
||||
- Python 3
|
||||
- macOS with Xcode and Command Line Tools
|
||||
- Python 3.12+
|
||||
- [UV](https://docs.astral.sh/uv/) (Python package manager)
|
||||
- Git
|
||||
- ~100GB of free disk space (for Chromium source)
|
||||
- ~16GB RAM (recommended)
|
||||
</Tab>
|
||||
<Tab title="Linux">
|
||||
- Ubuntu 20.04+ or similar
|
||||
- build-essential package
|
||||
- Python 3
|
||||
- Python 3.12+
|
||||
- [UV](https://docs.astral.sh/uv/)
|
||||
- Git
|
||||
- ~100GB of free disk space
|
||||
- ~16GB RAM (recommended)
|
||||
</Tab>
|
||||
<Tab title="Windows">
|
||||
- Windows 10/11
|
||||
- Visual Studio 2022 with C++ workload
|
||||
- Python 3
|
||||
- Python 3.12+
|
||||
- [UV](https://docs.astral.sh/uv/)
|
||||
- Git
|
||||
- ~100GB of free disk space
|
||||
- ~16GB RAM minimum
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
#### Build Instructions
|
||||
### Build Instructions
|
||||
|
||||
<Steps>
|
||||
<Step title="Checkout Chromium Source">
|
||||
First, follow the official Chromium guide for your platform:
|
||||
**1. Clone Chromium source**
|
||||
|
||||
**[Chromium: Get the Code](https://www.chromium.org/developers/how-tos/get-the-code/)**
|
||||
Follow the official [Chromium: Get the Code](https://www.chromium.org/developers/how-tos/get-the-code/) guide. This sets up `depot_tools` and fetches ~100GB of source code.
|
||||
|
||||
This will set up `depot_tools` and fetch the ~100GB Chromium source tree. This typically takes 2-3 hours depending on your internet speed.
|
||||
</Step>
|
||||
Note the path where you clone it (e.g., `~/chromium/src`).
|
||||
|
||||
<Step title="Navigate to Build System">
|
||||
Once you have Chromium checked out, navigate to our build system:
|
||||
**2. Install UV and dependencies**
|
||||
|
||||
```bash
|
||||
cd packages/browseros
|
||||
```
|
||||
</Step>
|
||||
```bash
|
||||
# Install UV
|
||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||
|
||||
<Step title="Build Debug Version (for development)">
|
||||
<Tabs>
|
||||
<Tab title="macOS">
|
||||
```bash
|
||||
python build/build.py --config build/config/debug.macos.yaml --chromium-src /path/to/chromium/src --build
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="Linux">
|
||||
```bash
|
||||
python build/build.py --config build/config/debug.linux.yaml --chromium-src /path/to/chromium/src --build
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="Windows">
|
||||
```bash
|
||||
python build/build.py --config build/config/debug.windows.yaml --chromium-src /path/to/chromium/src --build
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
</Step>
|
||||
# Navigate to build system
|
||||
cd packages/browseros
|
||||
|
||||
<Step title="Build Release Version (for production)">
|
||||
<Tabs>
|
||||
<Tab title="macOS">
|
||||
```bash
|
||||
python build/build.py --config build/config/release.macos.yaml --chromium-src /path/to/chromium/src --build
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="Linux">
|
||||
```bash
|
||||
python build/build.py --config build/config/release.linux.yaml --chromium-src /path/to/chromium/src --build
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="Windows">
|
||||
```bash
|
||||
python build/build.py --config build/config/release.windows.yaml --chromium-src /path/to/chromium/src --build
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
<Note>
|
||||
The build typically takes 1-3 hours on modern hardware (M4 Max, Ryzen 9, etc.).
|
||||
</Note>
|
||||
</Step>
|
||||
|
||||
<Step title="Run BrowserOS">
|
||||
After the build completes successfully, you can run BrowserOS:
|
||||
|
||||
<Tabs>
|
||||
<Tab title="macOS Debug (ARM64)">
|
||||
```bash
|
||||
out/Default_arm64/BrowserOS\ Dev.app/Contents/MacOS/BrowserOS\ Dev --user-data-dir=/tmp/test-profile
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="macOS Debug (x64)">
|
||||
```bash
|
||||
out/Default_x64/BrowserOS\ Dev.app/Contents/MacOS/BrowserOS\ Dev --user-data-dir=/tmp/test-profile
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="macOS Release (ARM64)">
|
||||
```bash
|
||||
out/Default_arm64/BrowserOS.app/Contents/MacOS/BrowserOS --user-data-dir=/tmp/test-profile
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="macOS Release (x64)">
|
||||
```bash
|
||||
out/Default_x64/BrowserOS.app/Contents/MacOS/BrowserOS --user-data-dir=/tmp/test-profile
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="Linux/Windows">
|
||||
The built binary will be located in the `out/Default_x64/` directory. Run it with the `--user-data-dir` flag to create an isolated test profile.
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
<Tip>
|
||||
The `--user-data-dir` flag is useful for creating isolated test profiles during development.
|
||||
</Tip>
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
#### Troubleshooting
|
||||
|
||||
<Accordion title="Build fails with missing dependencies">
|
||||
- Make sure you've followed all prerequisite steps from the Chromium build guide
|
||||
- Ensure Xcode is up to date (macOS)
|
||||
- Verify all required packages are installed (Linux)
|
||||
- Check Visual Studio installation (Windows)
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Out of disk space">
|
||||
Chromium requires significant disk space (~100GB). Ensure you have enough free space before starting the build. You can use `df -h` on Unix systems or check Disk Management on Windows.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Build takes too long">
|
||||
- Use ccache to speed up rebuilds
|
||||
- Consider using a machine with more CPU cores
|
||||
- Build only the components you need for development
|
||||
- Use the debug build for faster compilation times
|
||||
</Accordion>
|
||||
|
||||
</Accordion>
|
||||
|
||||
## 4. Making Your First Contribution
|
||||
|
||||
Open a PR on GitHub with:
|
||||
- **Clear title** in conventional commit format
|
||||
- **Description** explaining what changed and why
|
||||
- **Screenshots/videos** for UI changes
|
||||
- **Link to related issues** (e.g., "Fixes #123")
|
||||
|
||||
### Sign the CLA
|
||||
|
||||
On your first PR, our bot will ask you to sign the Contributor License Agreement:
|
||||
|
||||
<Steps>
|
||||
<Step title="Read the CLA">
|
||||
Read the [CLA document](https://github.com/BrowserOS/BrowserOS/blob/main/CLA.md)
|
||||
</Step>
|
||||
|
||||
<Step title="Sign via Comment">
|
||||
Comment on your PR:
|
||||
```
|
||||
I have read the CLA Document and I hereby sign the CLA
|
||||
```
|
||||
</Step>
|
||||
|
||||
<Step title="Automatic Recording">
|
||||
The bot will record your signature (one-time thing)
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## 5. Code Standards
|
||||
|
||||
### TypeScript (Agent)
|
||||
|
||||
- **Strict typing** - Always declare types, avoid `any`
|
||||
- **Zod schemas** - Use Zod instead of TypeScript interfaces
|
||||
- **Path aliases** - Use `@/lib` not relative paths like `../`
|
||||
- **Naming:**
|
||||
- Classes: `PascalCase`
|
||||
- Functions/variables: `camelCase`
|
||||
- Constants: `UPPERCASE`
|
||||
- Private methods: prefix with `_`
|
||||
|
||||
**Example:**
|
||||
|
||||
```typescript
|
||||
import { z } from 'zod'
|
||||
|
||||
// Good: Zod schema with inline comments
|
||||
export const ToolInputSchema = z.object({
|
||||
action: z.enum(['click', 'type']), // Action to perform
|
||||
target: z.string().min(1), // Element selector
|
||||
timeout: z.number().default(5000) // Timeout in ms
|
||||
})
|
||||
|
||||
export type ToolInput = z.infer<typeof ToolInputSchema>
|
||||
# Install dependencies
|
||||
uv sync
|
||||
```
|
||||
|
||||
### React (Agent UI)
|
||||
**3. Build debug version**
|
||||
|
||||
- **Styling:** Tailwind CSS only (no SCSS or CSS modules)
|
||||
- **Hooks:** Only at top level
|
||||
- **Props:** Define with Zod schemas
|
||||
- **Testing:** Vitest (not Jest)
|
||||
|
||||
### General Guidelines
|
||||
|
||||
- Keep functions short (\<20 lines ideally)
|
||||
- Write tests for new features
|
||||
- Use descriptive variable names
|
||||
- Handle errors gracefully
|
||||
|
||||
<Note>
|
||||
claude.md file can be found at below:
|
||||
- Agent: [packages/browseros-agent/CLAUDE.md](https://github.com/BrowserOS/BrowserOS/blob/main/packages/browseros-agent/CLAUDE.md)
|
||||
</Note>
|
||||
|
||||
## 6. Project Structure
|
||||
|
||||
```
|
||||
monorepo/
|
||||
├── packages/
|
||||
│ ├── browseros/ # Chromium build system
|
||||
│ │ ├── build/ # Python build scripts
|
||||
│ │ ├── chromium_patches/ # Patches to Chromium source
|
||||
│ │ └── resources/ # Icons, configs
|
||||
│ │
|
||||
│ └── browseros-agent/ # Chrome extension
|
||||
│ ├── src/
|
||||
│ │ ├── lib/ # Core agent logic
|
||||
│ │ ├── sidepanel/ # Side panel UI
|
||||
│ │ ├── newtab/ # New tab page
|
||||
│ │ └── background/ # Extension background
|
||||
│ └── docs/ # Architecture docs
|
||||
│
|
||||
├── docs/ # General documentation
|
||||
└── CONTRIBUTING.md # Contributing guide
|
||||
```bash
|
||||
uv run browseros build \
|
||||
--chromium-src <your-chromium-src-path> \
|
||||
--setup \
|
||||
--prep \
|
||||
--build \
|
||||
--build-type debug
|
||||
```
|
||||
|
||||
## 7. Development Workflow
|
||||
The `--setup` and `--prep` flags are only needed for the first build. After that, just use `--build` for incremental builds:
|
||||
|
||||
<Steps>
|
||||
<Step title="Fork and Clone">
|
||||
Fork the repository on GitHub and clone it locally:
|
||||
```bash
|
||||
uv run browseros build --chromium-src <path> --build --build-type debug
|
||||
```
|
||||
|
||||
**4. Run BrowserOS**
|
||||
|
||||
<Tabs>
|
||||
<Tab title="macOS (ARM64)">
|
||||
```bash
|
||||
git clone https://github.com/YOUR-USERNAME/BrowserOS.git
|
||||
cd BrowserOS
|
||||
<chromium-src>/out/Default_arm64/BrowserOS\ Dev.app/Contents/MacOS/BrowserOS\ Dev \
|
||||
--enable-logging=stderr \
|
||||
--use-mock-keychain \
|
||||
--user-data-dir=/tmp/test-profile
|
||||
```
|
||||
</Step>
|
||||
|
||||
<Step title="Create a Branch">
|
||||
Create a new branch for your feature or fix:
|
||||
</Tab>
|
||||
<Tab title="macOS (x64)">
|
||||
```bash
|
||||
git checkout -b feature/your-feature-name
|
||||
<chromium-src>/out/Default_x64/BrowserOS\ Dev.app/Contents/MacOS/BrowserOS\ Dev \
|
||||
--enable-logging=stderr \
|
||||
--use-mock-keychain \
|
||||
--user-data-dir=/tmp/test-profile
|
||||
```
|
||||
</Step>
|
||||
|
||||
<Step title="Make Changes">
|
||||
Make your changes and test them thoroughly. Follow our coding standards and ensure all tests pass.
|
||||
</Step>
|
||||
|
||||
<Step title="Commit and Push">
|
||||
Commit your changes with a descriptive message:
|
||||
</Tab>
|
||||
<Tab title="Windows">
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "feat: add new feature description"
|
||||
git push origin feature/your-feature-name
|
||||
<chromium-src>\out\Default_x64\BrowserOS Dev.exe \
|
||||
--enable-logging=stderr \
|
||||
--user-data-dir=%TEMP%\test-profile
|
||||
```
|
||||
</Step>
|
||||
</Tab>
|
||||
<Tab title="Linux">
|
||||
```bash
|
||||
<chromium-src>/out/Default_x64/browseros \
|
||||
--enable-logging=stderr \
|
||||
--user-data-dir=/tmp/test-profile
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
<Step title="Submit PR">
|
||||
Open a pull request on GitHub with a clear description of your changes and why they're needed.
|
||||
</Step>
|
||||
</Steps>
|
||||
### Build Flags
|
||||
|
||||
## 8. Support
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--chromium-src` | Path to Chromium source directory |
|
||||
| `--setup` | Run setup phase (first build only) |
|
||||
| `--prep` | Run prep phase (first build only) |
|
||||
| `--build` | Run the compile phase |
|
||||
| `--build-type` | `debug` or `release` |
|
||||
| `--sign` | Sign the build |
|
||||
| `--package` | Package for distribution |
|
||||
|
||||
Stuck? Need clarification? We're here to help.
|
||||
### Troubleshooting
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card
|
||||
title="Discord Support"
|
||||
icon="discord"
|
||||
href="https://discord.gg/YKwjt5vuKr"
|
||||
>
|
||||
Real-time chat and support
|
||||
</Card>
|
||||
<Card
|
||||
title="GitHub Issues"
|
||||
icon="bug"
|
||||
href="https://github.com/browseros-ai/BrowserOS/issues"
|
||||
>
|
||||
Bug reports and features
|
||||
</Card>
|
||||
<Card
|
||||
title="GitHub Discussions"
|
||||
icon="comments"
|
||||
href="https://github.com/browseros-ai/BrowserOS/discussions"
|
||||
>
|
||||
General questions
|
||||
</Card>
|
||||
</CardGroup>
|
||||
**Build fails with missing dependencies** — Make sure you followed all steps from the Chromium build guide for your platform.
|
||||
|
||||
**Out of disk space** — Chromium needs ~100GB. Check with `df -h`.
|
||||
|
||||
## 9. License
|
||||
**Build takes too long** — Use ccache, more CPU cores, or stick to debug builds.
|
||||
|
||||
By contributing, you agree that your contributions will be licensed under AGPL-3.0.
|
||||
**UV command not found** — Restart your terminal after installing UV.
|
||||
|
||||
---
|
||||
|
||||
Built with ❤️ from San Francisco
|
||||
## Making Your First PR
|
||||
|
||||
1. **Fork** the repository on GitHub
|
||||
2. **Clone** your fork locally
|
||||
3. **Create a branch**: `git checkout -b feature/your-feature`
|
||||
4. **Make changes** and test them
|
||||
5. **Commit**: `git commit -m "feat: add your feature"`
|
||||
6. **Push**: `git push origin feature/your-feature`
|
||||
7. **Open a PR** with a clear description
|
||||
|
||||
### Sign the CLA
|
||||
|
||||
On your first PR, our bot will ask you to sign the Contributor License Agreement. Just comment:
|
||||
|
||||
```
|
||||
I have read the CLA Document and I hereby sign the CLA
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Code Standards
|
||||
|
||||
**TypeScript:**
|
||||
- Use strict typing, avoid `any`
|
||||
- Use Zod schemas instead of TypeScript interfaces
|
||||
- Use path aliases (`@/lib`) not relative paths (`../`)
|
||||
- Naming: `PascalCase` for classes, `camelCase` for functions
|
||||
|
||||
**React:**
|
||||
- Tailwind CSS only (no SCSS or CSS modules)
|
||||
- Hooks at top level only
|
||||
- Test with Vitest
|
||||
|
||||
**General:**
|
||||
- Keep functions short (under 20 lines)
|
||||
- Write tests for new features
|
||||
- Handle errors gracefully
|
||||
|
||||
---
|
||||
|
||||
## Getting Help
|
||||
|
||||
- **Discord** — [discord.gg/YKwjt5vuKr](https://discord.gg/YKwjt5vuKr)
|
||||
- **GitHub Issues** — [github.com/BrowserOS-ai/BrowserOS/issues](https://github.com/BrowserOS-ai/BrowserOS/issues)
|
||||
- **GitHub Discussions** — [github.com/BrowserOS-ai/BrowserOS/discussions](https://github.com/BrowserOS-ai/BrowserOS/discussions)
|
||||
|
||||
---
|
||||
|
||||
By contributing, you agree that your contributions will be licensed under AGPL-3.0.
|
||||
|
||||
159
docs/docs.json
159
docs/docs.json
@@ -1,94 +1,79 @@
|
||||
{
|
||||
"$schema": "https://mintlify.com/docs.json",
|
||||
"theme": "mint",
|
||||
"theme": "maple",
|
||||
"name": "BrowserOS Documentation",
|
||||
"colors": {
|
||||
"primary": "#0066CC",
|
||||
"light": "#3399FF",
|
||||
"dark": "#003D7A"
|
||||
"primary": "#f25e1a",
|
||||
"light": "#FF7A3D",
|
||||
"dark": "#D14E10"
|
||||
},
|
||||
"favicon": "/logo/favicon.svg",
|
||||
"favicon": "/logo/favicon.png",
|
||||
"navigation": {
|
||||
"tabs": [
|
||||
"groups": [
|
||||
{
|
||||
"tab": "Documentation",
|
||||
"groups": [
|
||||
{
|
||||
"group": "Getting Started",
|
||||
"pages": [
|
||||
"index",
|
||||
"onboarding"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Configure AI",
|
||||
"expanded": true,
|
||||
"pages": [
|
||||
"llm-setup-guide",
|
||||
{
|
||||
"group": "BYOK LLM",
|
||||
"expanded": true,
|
||||
"pages": [
|
||||
"bring-your-own-keys/gemini",
|
||||
"bring-your-own-keys/claude",
|
||||
"bring-your-own-keys/openai",
|
||||
"bring-your-own-keys/openrouter"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Local LLMs",
|
||||
"expanded": true,
|
||||
"pages": [
|
||||
"local-LLMs/ollama",
|
||||
"local-LLMs/lm-studio",
|
||||
"local-LLMs/gpt-oss"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "BrowserOS-mcp",
|
||||
"expanded": true,
|
||||
"pages": [
|
||||
"browseros-mcp/how-to-guide"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Contributing",
|
||||
"pages": [
|
||||
"contributing"
|
||||
]
|
||||
}
|
||||
"group": "Get Started",
|
||||
"pages": [
|
||||
"index",
|
||||
"onboarding",
|
||||
"update/index",
|
||||
"changelog"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Core Features",
|
||||
"pages": [
|
||||
"features/bring-your-own-llm",
|
||||
"features/chatgpt-pro-oauth",
|
||||
"features/github-copilot-oauth",
|
||||
"features/qwen-code-oauth",
|
||||
"features/local-models",
|
||||
"features/workflows",
|
||||
"features/scheduled-tasks",
|
||||
"features/cowork",
|
||||
"features/connect-mcps",
|
||||
"features/skills",
|
||||
"features/smart-nudges",
|
||||
"features/use-with-claude-code",
|
||||
"features/soul",
|
||||
"features/memory",
|
||||
"features/sync-to-cloud",
|
||||
"features/llm-chat-hub",
|
||||
"features/ad-blocking",
|
||||
"features/vertical-tabs"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Comparisons",
|
||||
"pages": [
|
||||
"comparisons/chrome-devtools-mcp",
|
||||
"comparisons/claude-cowork",
|
||||
"comparisons/openclaw"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Integrations",
|
||||
"pages": ["integrations/n8n"]
|
||||
},
|
||||
{
|
||||
"group": "Troubleshooting",
|
||||
"pages": ["troubleshooting/connection-issues"]
|
||||
},
|
||||
{
|
||||
"group": "Contributing",
|
||||
"pages": ["contributing"]
|
||||
}
|
||||
],
|
||||
"global": {
|
||||
"anchors": [
|
||||
{
|
||||
"anchor": "GitHub",
|
||||
"href": "https://github.com/BrowserOS-ai/BrowserOS",
|
||||
"icon": "github"
|
||||
},
|
||||
{
|
||||
"anchor": "Discord",
|
||||
"href": "https://discord.gg/YKwjt5vuKr",
|
||||
"icon": "discord"
|
||||
},
|
||||
{
|
||||
"anchor": "Slack",
|
||||
"href": "http://dub.sh/browseros-slack",
|
||||
"icon": "slack"
|
||||
}
|
||||
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"logo": {
|
||||
"light": "/logo/browseros.svg",
|
||||
"dark": "/logo/browseros.svg"
|
||||
"light": "/logo/logo44.png",
|
||||
"dark": "/logo/logo44.png"
|
||||
},
|
||||
"navbar": {
|
||||
"links": [
|
||||
{
|
||||
"label": "llms.txt",
|
||||
"href": "/llms.txt"
|
||||
},
|
||||
{
|
||||
"label": "Support",
|
||||
"href": "https://discord.gg/YKwjt5vuKr"
|
||||
@@ -102,22 +87,22 @@
|
||||
},
|
||||
"contextual": {
|
||||
"options": [
|
||||
"copy",
|
||||
"view",
|
||||
"chatgpt",
|
||||
"claude",
|
||||
"perplexity",
|
||||
"mcp",
|
||||
"cursor",
|
||||
"vscode"
|
||||
]
|
||||
"copy",
|
||||
"view",
|
||||
"chatgpt",
|
||||
"claude",
|
||||
"perplexity",
|
||||
"mcp",
|
||||
"cursor",
|
||||
"vscode"
|
||||
]
|
||||
},
|
||||
"footer": {
|
||||
"socials": {
|
||||
"x": "https://x.com/browseros_ai",
|
||||
"github": "https://github.com/BrowserOS-ai/BrowserOS",
|
||||
"discord": "https://discord.gg/YKwjt5vuKr",
|
||||
"slack": "http://dub.sh/browseros-slack"
|
||||
"slack": "https://dub.sh/browserOS-slack"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
39
docs/features/ad-blocking.mdx
Normal file
39
docs/features/ad-blocking.mdx
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "Ad Blocking"
|
||||
description: "BrowserOS supports full ad blocking with uBlock Origin"
|
||||
---
|
||||
|
||||
BrowserOS supports full ad blocking through [uBlock Origin](https://ublockorigin.com/), the most powerful open-source ad blocker available — the full extension, not the watered-down "Lite" version.
|
||||
|
||||
## Why BrowserOS?
|
||||
|
||||
Chrome [killed support](https://developer.chrome.com/docs/extensions/develop/migrate/mv2-deprecation-timeline) for uBlock Origin by phasing out Manifest V2 extensions. The only option left on Chrome is "uBlock Origin Lite," a significantly weaker version that can't use advanced filtering rules.
|
||||
|
||||
**BrowserOS re-enabled full Manifest V2 support**, so you can install and run the original uBlock Origin at full power — the same extension Chrome no longer allows.
|
||||
|
||||
<Card title="Install uBlock Origin" icon="shield-check" href="https://chromewebstore.google.com/detail/ublock-origin/cjpalhdlnbpafiamejdnhcphjbkeiagm">
|
||||
Install the full uBlock Origin extension from the Chrome Web Store. Works on BrowserOS out of the box.
|
||||
</Card>
|
||||
|
||||
## BrowserOS vs Chrome
|
||||
|
||||
We ran both browsers through [adblock.turtlecute.org](https://adblock.turtlecute.org/), a test that measures how effectively a browser blocks ads and tracking scripts.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="BrowserOS — 68%">
|
||||
<img src="/images/adblock-browseros.png" alt="BrowserOS blocking 68% of ads" />
|
||||
</Card>
|
||||
<Card title="Chrome — 7%">
|
||||
<img src="/images/adblock-chrome.png" alt="Chrome blocking only 7% of ads" />
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
Out of 133 ad-related requests:
|
||||
- **BrowserOS** blocked 91 (68%)
|
||||
- **Chrome** blocked 9 (7%)
|
||||
|
||||
That's roughly **10x more protection** with zero configuration.
|
||||
|
||||
## What This Means
|
||||
|
||||
Fewer ads means faster page loads, less bandwidth usage, and significantly reduced tracking. BrowserOS handles this natively so you can focus on browsing.
|
||||
284
docs/features/bring-your-own-llm.mdx
Normal file
284
docs/features/bring-your-own-llm.mdx
Normal file
@@ -0,0 +1,284 @@
|
||||
---
|
||||
title: "Bring Your Own LLM"
|
||||
description: "Connect your own AI models to BrowserOS"
|
||||
---
|
||||
|
||||
BrowserOS includes a default AI model you can use right away, but it has strict rate limits. For the best experience, bring your own API keys or run models locally.
|
||||
|
||||
See how to connect your own LLM in under a minute:
|
||||
|
||||
<video
|
||||
controls
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://pub-80f8a01e6e8b4239ae53a7652ef85877.r2.dev/resources/feature-videos/1-bring-your-own-LLM.mov"
|
||||
></video>
|
||||
|
||||
## Use Your Existing Subscription
|
||||
|
||||
Already paying for ChatGPT Pro, GitHub Copilot, or Qwen Code? Connect your existing account to BrowserOS with a single sign-in — no API keys, no extra cost.
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card href="/features/chatgpt-pro-oauth">
|
||||
<svg fill="currentColor" fillRule="evenodd" height="24" width="24" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.205 8.658v-2.26c0-.19.072-.333.238-.428l4.543-2.616c.619-.357 1.356-.523 2.117-.523 2.854 0 4.662 2.212 4.662 4.566 0 .167 0 .357-.024.547l-4.71-2.759a.797.797 0 00-.856 0l-5.97 3.473zm10.609 8.8V12.06c0-.333-.143-.57-.429-.737l-5.97-3.473 1.95-1.118a.433.433 0 01.476 0l4.543 2.617c1.309.76 2.189 2.378 2.189 3.948 0 1.808-1.07 3.473-2.76 4.163zM7.802 12.703l-1.95-1.142c-.167-.095-.239-.238-.239-.428V5.899c0-2.545 1.95-4.472 4.591-4.472 1 0 1.927.333 2.712.928L8.23 5.067c-.285.166-.428.404-.428.737v6.898zM12 15.128l-2.795-1.57v-3.33L12 8.658l2.795 1.57v3.33L12 15.128zm1.796 7.23c-1 0-1.927-.332-2.712-.927l4.686-2.712c.285-.166.428-.404.428-.737v-6.898l1.974 1.142c.167.095.238.238.238.428v5.233c0 2.545-1.974 4.472-4.614 4.472zm-5.637-5.303l-4.544-2.617c-1.308-.761-2.188-2.378-2.188-3.948A4.482 4.482 0 014.21 6.327v5.423c0 .333.143.571.428.738l5.947 3.449-1.95 1.118a.432.432 0 01-.476 0zm-.262 3.9c-2.688 0-4.662-2.021-4.662-4.519 0-.19.024-.38.047-.57l4.686 2.71c.286.167.571.167.856 0l5.97-3.448v2.26c0 .19-.07.333-.237.428l-4.543 2.616c-.619.357-1.356.523-2.117.523zm5.899 2.83a5.947 5.947 0 005.827-4.756C22.287 18.339 24 15.84 24 13.296c0-1.665-.713-3.282-1.998-4.448.119-.5.19-.999.19-1.498 0-3.401-2.759-5.947-5.946-5.947-.642 0-1.26.095-1.88.31A5.962 5.962 0 0010.205 0a5.947 5.947 0 00-5.827 4.757C1.713 5.447 0 7.945 0 10.49c0 1.666.713 3.283 1.998 4.448-.119.5-.19 1-.19 1.499 0 3.401 2.759 5.946 5.946 5.946.642 0 1.26-.095 1.88-.309a5.96 5.96 0 004.162 1.713z"></path></svg>
|
||||
**ChatGPT Pro / Plus**
|
||||
|
||||
Sign in with your OpenAI account. Access GPT-5 Codex, GPT-5.4, and the full Codex lineup with up to 400K context.
|
||||
</Card>
|
||||
<Card href="/features/github-copilot-oauth">
|
||||
<svg fill="currentColor" fillRule="evenodd" height="24" width="24" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M19.245 5.364c1.322 1.36 1.877 3.216 2.11 5.817.622 0 1.2.135 1.592.654l.73.964c.21.278.323.61.323.955v2.62c0 .339-.173.669-.453.868C20.239 19.602 16.157 21.5 12 21.5c-4.6 0-9.205-2.583-11.547-4.258-.28-.2-.452-.53-.453-.868v-2.62c0-.345.113-.679.321-.956l.73-.963c.392-.517.974-.654 1.593-.654l.029-.297c.25-2.446.81-4.213 2.082-5.52 2.461-2.54 5.71-2.851 7.146-2.864h.198c1.436.013 4.685.323 7.146 2.864zm-7.244 4.328c-.284 0-.613.016-.962.05-.123.447-.305.85-.57 1.108-1.05 1.023-2.316 1.18-2.994 1.18-.638 0-1.306-.13-1.851-.464-.516.165-1.012.403-1.044.996a65.882 65.882 0 00-.063 2.884l-.002.48c-.002.563-.005 1.126-.013 1.69.002.326.204.63.51.765 2.482 1.102 4.83 1.657 6.99 1.657 2.156 0 4.504-.555 6.985-1.657a.854.854 0 00.51-.766c.03-1.682.006-3.372-.076-5.053-.031-.596-.528-.83-1.046-.996-.546.333-1.212.464-1.85.464-.677 0-1.942-.157-2.993-1.18-.266-.258-.447-.661-.57-1.108-.32-.032-.64-.049-.96-.05zm-2.525 4.013c.539 0 .976.426.976.95v1.753c0 .525-.437.95-.976.95a.964.964 0 01-.976-.95v-1.752c0-.525.437-.951.976-.951zm5 0c.539 0 .976.426.976.95v1.753c0 .525-.437.95-.976.95a.964.964 0 01-.976-.95v-1.752c0-.525.437-.951.976-.951zM7.635 5.087c-1.05.102-1.935.438-2.385.906-.975 1.037-.765 3.668-.21 4.224.405.394 1.17.657 1.995.657h.09c.649-.013 1.785-.176 2.73-1.11.435-.41.705-1.433.675-2.47-.03-.834-.27-1.52-.63-1.813-.39-.336-1.275-.482-2.265-.394zm6.465.394c-.36.292-.6.98-.63 1.813-.03 1.037.24 2.06.675 2.47.968.957 2.136 1.104 2.776 1.11h.044c.825 0 1.59-.263 1.995-.657.555-.556.765-3.187-.21-4.224-.45-.468-1.335-.804-2.385-.906-.99-.088-1.875.058-2.265.394zM12 7.615c-.24 0-.525.015-.84.044.03.16.045.336.06.526l-.001.159a2.94 2.94 0 01-.014.25c.225-.022.425-.027.612-.028h.366c.187 0 .387.006.612.028-.015-.146-.015-.277-.015-.409.015-.19.03-.365.06-.526a9.29 9.29 0 00-.84-.044z"></path></svg>
|
||||
**GitHub Copilot**
|
||||
|
||||
Sign in with your GitHub account. Access 19+ models including Claude, GPT-5, and Gemini through one subscription.
|
||||
</Card>
|
||||
<Card href="/features/qwen-code-oauth">
|
||||
<svg fill="currentColor" fillRule="evenodd" height="24" width="24" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M12.604 1.34c.393.69.784 1.382 1.174 2.075a.18.18 0 00.157.091h5.552c.174 0 .322.11.446.327l1.454 2.57c.19.337.24.478.024.837-.26.43-.513.864-.76 1.3l-.367.658c-.106.196-.223.28-.04.512l2.652 4.637c.172.301.111.494-.043.77-.437.785-.882 1.564-1.335 2.34-.159.272-.352.375-.68.37-.777-.016-1.552-.01-2.327.016a.099.099 0 00-.081.05 575.097 575.097 0 01-2.705 4.74c-.169.293-.38.363-.725.364-.997.003-2.002.004-3.017.002a.537.537 0 01-.465-.271l-1.335-2.323a.09.09 0 00-.083-.049H4.982c-.285.03-.553-.001-.805-.092l-1.603-2.77a.543.543 0 01-.002-.54l1.207-2.12a.198.198 0 000-.197 550.951 550.951 0 01-1.875-3.272l-.79-1.395c-.16-.31-.173-.496.095-.965.465-.813.927-1.625 1.387-2.436.132-.234.304-.334.584-.335a338.3 338.3 0 012.589-.001.124.124 0 00.107-.063l2.806-4.895a.488.488 0 01.422-.246c.524-.001 1.053 0 1.583-.006L11.704 1c.341-.003.724.032.9.34zm-3.432.403a.06.06 0 00-.052.03L6.254 6.788a.157.157 0 01-.135.078H3.253c-.056 0-.07.025-.041.074l5.81 10.156c.025.042.013.062-.034.063l-2.795.015a.218.218 0 00-.2.116l-1.32 2.31c-.044.078-.021.118.068.118l5.716.008c.046 0 .08.02.104.061l1.403 2.454c.046.081.092.082.139 0l5.006-8.76.783-1.382a.055.055 0 01.096 0l1.424 2.53a.122.122 0 00.107.062l2.763-.02a.04.04 0 00.035-.02.041.041 0 000-.04l-2.9-5.086a.108.108 0 010-.113l.293-.507 1.12-1.977c.024-.041.012-.062-.035-.062H9.2c-.059 0-.073-.026-.043-.077l1.434-2.505a.107.107 0 000-.114L9.225 1.774a.06.06 0 00-.053-.031zm6.29 8.02c.046 0 .058.02.034.06l-.832 1.465-2.613 4.585a.056.056 0 01-.05.029.058.058 0 01-.05-.029L8.498 9.841c-.02-.034-.01-.052.028-.054l.216-.012 6.722-.012z"></path></svg>
|
||||
**Qwen Code**
|
||||
|
||||
Sign in with your Qwen account. Access Qwen 3 Coder with a 1 million token context window.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
---
|
||||
|
||||
## Which Model Should I Use?
|
||||
|
||||
| Mode | What works | Recommendation |
|
||||
|------|------------|----------------|
|
||||
| **Chat Mode** | Any model, including local | Ollama or Gemini Flash |
|
||||
| **Agent Mode** | Cloud models only | Claude Opus 4.5, GPT-5, or Kimi K2.5 (open source) |
|
||||
|
||||
<Warning>
|
||||
**Local LLMs aren't powerful for most agentic tasks yet.** They're great for Chat — asking questions about a page, summarizing, etc. But agent tasks need strong reasoning to click the right elements and handle multi-step workflows. Use Claude Opus 4.5, GPT-5, or Kimi K2.5 for agents.
|
||||
</Warning>
|
||||
|
||||
---
|
||||
|
||||
## Kimi K2.5 — In Partnership with Moonshot AI
|
||||
|
||||
{/* <img src="/images/moonshot-partnership-banner.png" alt="BrowserOS x Moonshot AI" className="rounded-xl" /> */}
|
||||
|
||||
BrowserOS has partnered with [Moonshot AI](https://www.kimi.com) to bring **Kimi K2.5** as a first-class provider. Kimi K2.5 is now the **recommended model** in BrowserOS and is set as the default provider.
|
||||
|
||||
For a limited time, BrowserOS users get **extended usage limits** powered by Kimi K2.5. This means you can use the AI agent, chat, and other AI-powered features with increased limits at no cost.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Open Source" icon="code-branch">
|
||||
Fully open-source model you can inspect and trust.
|
||||
</Card>
|
||||
<Card title="Multimodal" icon="image">
|
||||
Supports images out of the box, including screenshots and visual context.
|
||||
</Card>
|
||||
<Card title="Great for Agents" icon="robot">
|
||||
Strong reasoning for browser automation, form filling, and multi-step workflows.
|
||||
</Card>
|
||||
<Card title="Affordable" icon="piggy-bank">
|
||||
Excellent agentic performance at a fraction of the cost of other frontier models.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
<div id="moonshot" />
|
||||
|
||||
### Why Kimi K2.5?
|
||||
|
||||
Kimi K2.5 offers excellent performance for agentic tasks at a fraction of the cost of other frontier models. It supports images, has a 128,000 token context window, and delivers strong results on browser automation tasks. Combined with BrowserOS's open-source agent framework, this makes for a powerful and affordable AI browsing experience.
|
||||
|
||||
### Bring Your Own Kimi API Key
|
||||
|
||||
You can also bring your own Kimi API key if you want to use Kimi K2.5 beyond the extended usage period, or if you want your own dedicated limits.
|
||||
|
||||
**Get your API key:**
|
||||
1. Go to [platform.moonshot.ai](https://platform.moonshot.ai) and create an account
|
||||
2. Navigate to the **API keys** section in your dashboard
|
||||
3. Click **Create new API key** and copy the key
|
||||
|
||||
**Add to BrowserOS:**
|
||||
1. Go to `chrome://browseros/settings`
|
||||
2. Click **USE** on the **Moonshot AI** card
|
||||
3. Enter your API key (it will be encrypted and stored locally on your machine)
|
||||
4. The model is pre-configured to `kimi-k2.5` with a 128,000 context window
|
||||
5. Click **Save**
|
||||
|
||||
<Tip>
|
||||
The base URL for the Kimi API (`https://api.moonshot.ai/v1`) is pre-filled automatically when you select the Moonshot AI provider template.
|
||||
</Tip>
|
||||
|
||||
---
|
||||
|
||||
## Cloud Providers
|
||||
|
||||
Connect to powerful AI models using your API keys. Your keys stay on your machine — requests go directly to the provider.
|
||||
|
||||
<AccordionGroup>
|
||||
<div id="gemini" />
|
||||
<Accordion title="Gemini (Free)" icon="google">
|
||||
Gemini Flash is fast and free. Google gives you 20 requests per minute at no cost.
|
||||
|
||||
**Get your API key:**
|
||||
1. Go to [aistudio.google.com](https://aistudio.google.com)
|
||||
2. Click **Get API key** in the sidebar
|
||||
3. Click **Create API key** and copy it
|
||||
|
||||

|
||||
|
||||
**Add to BrowserOS:**
|
||||
1. Go to `chrome://browseros/settings`
|
||||
2. Click **USE** on the Gemini card
|
||||
3. Set **Model ID** to `gemini-2.5-flash` (or `gemini-2.5-pro`, `gemini-3-pro-preview`, `gemini-3-flash-preview`)
|
||||
4. Paste your API key
|
||||
5. Check **Supports Images**, set **Context Window** to `1000000`
|
||||
6. Click **Save**
|
||||
|
||||

|
||||
</Accordion>
|
||||
|
||||
<div id="claude" />
|
||||
<Accordion title="Claude (Best for Agents)" icon="message-bot">
|
||||
Claude Opus 4.5 gives the best results for Agent Mode.
|
||||
|
||||
**Get your API key:**
|
||||
1. Go to [console.anthropic.com](https://console.anthropic.com/dashboard)
|
||||
2. Click **API keys** in the sidebar
|
||||
3. Click **Create Key** and copy it
|
||||
|
||||

|
||||
|
||||
**Add to BrowserOS:**
|
||||
1. Go to `chrome://browseros/settings`
|
||||
2. Click **USE** on the Anthropic card
|
||||
3. Set **Model ID** to `claude-opus-4-5-20251101` (or `claude-sonnet-4-5-20250929`, `claude-haiku-4-5-20251001`)
|
||||
4. Paste your API key
|
||||
5. Check **Supports Images**, set **Context Window** to `200000`
|
||||
6. Click **Save**
|
||||
|
||||

|
||||
</Accordion>
|
||||
|
||||
<div id="openai" />
|
||||
<Accordion title="OpenAI" icon="brain">
|
||||
GPT-5 is OpenAI's most capable model for both chat and agent tasks.
|
||||
|
||||
**Get your API key:**
|
||||
1. Go to [platform.openai.com](https://platform.openai.com)
|
||||
2. Click settings icon → **API keys**
|
||||
3. Click **Create new secret key** and copy it
|
||||
|
||||

|
||||
|
||||
**Add to BrowserOS:**
|
||||
1. Go to `chrome://browseros/settings`
|
||||
2. Click **USE** on the OpenAI card
|
||||
3. Set **Model ID** to `gpt-5` (or `gpt-5.2`, `gpt-5-mini`, `gpt-4.1`, `o4-mini`)
|
||||
4. Paste your API key
|
||||
5. Check **Supports Images**, set **Context Window** to `200000`
|
||||
6. Click **Save**
|
||||
|
||||

|
||||
</Accordion>
|
||||
|
||||
<div id="openrouter" />
|
||||
<Accordion title="OpenRouter" icon="shuffle">
|
||||
Access 500+ models through one API.
|
||||
|
||||
**Get your API key:**
|
||||
1. Go to [openrouter.ai](https://openrouter.ai) and sign up
|
||||
2. Go to [openrouter.ai/keys](https://openrouter.ai/keys) and create a key
|
||||
|
||||
**Pick a model:**
|
||||
Go to [openrouter.ai/models](https://openrouter.ai/models) and copy the model ID you want (e.g., `anthropic/claude-opus-4.5`, `google/gemini-2.5-flash`).
|
||||
|
||||

|
||||
|
||||
**Add to BrowserOS:**
|
||||
1. Go to `chrome://browseros/settings`
|
||||
2. Click **USE** on the OpenRouter card
|
||||
3. Paste the model ID and your API key
|
||||
4. Set **Context Window** based on the model
|
||||
5. Click **Save**
|
||||
|
||||

|
||||
</Accordion>
|
||||
|
||||
<div id="azure" />
|
||||
<Accordion title="Azure OpenAI" icon="microsoft">
|
||||
Use OpenAI models hosted on your own Azure subscription for enterprise compliance and data residency.
|
||||
|
||||
**Prerequisites:**
|
||||
1. An Azure subscription with access to [Azure OpenAI Service](https://portal.azure.com/#view/Microsoft_Azure_ProjectOxford/CognitiveServicesHub/~/OpenAI)
|
||||
2. A deployed model (e.g., GPT-4o) in your Azure OpenAI resource
|
||||
|
||||
**Get your credentials:**
|
||||
1. Go to [portal.azure.com](https://portal.azure.com) → **Azure OpenAI** resource
|
||||
2. Navigate to **Keys and Endpoint**
|
||||
3. Copy **Key 1** and your **Endpoint URL**
|
||||
|
||||
**Add to BrowserOS:**
|
||||
1. Go to `chrome://browseros/settings`
|
||||
2. Click **USE** on the Azure card
|
||||
3. Set **Base URL** to your Azure endpoint (e.g., `https://your-resource.openai.azure.com/openai/deployments/your-deployment`)
|
||||
4. Set **Model ID** to your deployment name
|
||||
5. Paste your API key
|
||||
6. Check **Supports Images**, set **Context Window** to `128000`
|
||||
7. Click **Save**
|
||||
</Accordion>
|
||||
|
||||
<div id="bedrock" />
|
||||
<Accordion title="AWS Bedrock" icon="aws">
|
||||
Access Claude, Llama, and other models through your AWS account with IAM-based authentication.
|
||||
|
||||
**Prerequisites:**
|
||||
1. An AWS account with [Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/getting-started.html) enabled
|
||||
2. Model access granted in the Bedrock console for your desired models
|
||||
|
||||
**Get your credentials:**
|
||||
1. Go to the [AWS Console](https://console.aws.amazon.com) → **IAM**
|
||||
2. Create or use an existing access key with Bedrock permissions
|
||||
3. Note your **Access Key ID**, **Secret Access Key**, and **Region**
|
||||
|
||||
**Add to BrowserOS:**
|
||||
1. Go to `chrome://browseros/settings`
|
||||
2. Click **USE** on the AWS Bedrock card
|
||||
3. Set **Base URL** to your Bedrock endpoint (region-specific)
|
||||
4. Set **Model ID** to the Bedrock model ID (e.g., `anthropic.claude-3-sonnet-20240229-v1:0`)
|
||||
5. Paste your credentials
|
||||
6. Check **Supports Images**, set **Context Window** to `200000`
|
||||
7. Click **Save**
|
||||
</Accordion>
|
||||
|
||||
<div id="openai-compatible" />
|
||||
<Accordion title="OpenAI Compatible" icon="plug">
|
||||
Connect to any provider that implements the OpenAI-compatible API format (e.g., Together AI, Fireworks, Groq, Perplexity).
|
||||
|
||||
**Add to BrowserOS:**
|
||||
1. Go to `chrome://browseros/settings`
|
||||
2. Click **USE** on the OpenAI Compatible card
|
||||
3. Set **Base URL** to the provider's API endpoint
|
||||
4. Set **Model ID** to the model you want to use
|
||||
5. Paste your API key
|
||||
6. Set **Supports Images** and **Context Window** based on the model
|
||||
7. Click **Save**
|
||||
|
||||
<Tip>
|
||||
Most newer AI providers support the OpenAI-compatible API format. Check your provider's docs for the base URL and available model IDs.
|
||||
</Tip>
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
---
|
||||
|
||||
## Local Models
|
||||
|
||||
<Card title="Local Model Guide" icon="server" href="/features/local-models">
|
||||
Run AI completely offline with Ollama or LM Studio. Includes recommended models, context length setup, and configuration steps.
|
||||
</Card>
|
||||
|
||||
---
|
||||
|
||||
## Switching Between Models
|
||||
|
||||
Use the model switcher in the Assistant panel to change providers anytime. The default provider is highlighted.
|
||||
|
||||

|
||||
|
||||
<Tip>
|
||||
Use local models for sensitive work data. Switch to Claude for agent tasks that need complex reasoning.
|
||||
</Tip>
|
||||
56
docs/features/chatgpt-pro-oauth.mdx
Normal file
56
docs/features/chatgpt-pro-oauth.mdx
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
title: "ChatGPT Pro / Plus"
|
||||
description: "Use your ChatGPT subscription to power BrowserOS"
|
||||
---
|
||||
|
||||
Connect your ChatGPT Pro or Plus subscription to BrowserOS and access GPT-5 Codex, GPT-5.4, and the full lineup of OpenAI's most advanced models — with up to 400K context. No API keys needed.
|
||||
|
||||
## Setup
|
||||
|
||||
**1.** Open BrowserOS and go to **Settings** (`chrome://browseros/settings`). You'll see the AI Providers section.
|
||||
|
||||

|
||||
|
||||
**2.** Click **USE** on the **ChatGPT Plus/Pro** card. You'll be prompted to sign in with your OpenAI account.
|
||||
|
||||

|
||||
|
||||
**3.** Sign in with the OpenAI account that has your ChatGPT Pro or Plus subscription active, and accept the authorization.
|
||||
|
||||

|
||||
|
||||
**4.** Once authorized, ChatGPT will appear as a provider in your settings. Select a model and start using it.
|
||||
|
||||
## Available Models
|
||||
|
||||
| Model | Context Window |
|
||||
|-------|---------------|
|
||||
| `gpt-5.4` | 400K |
|
||||
| `gpt-5.3-codex` | 400K |
|
||||
| `gpt-5.2-codex` | 400K |
|
||||
| `gpt-5.2` | 200K |
|
||||
| `gpt-5.1-codex` | 400K |
|
||||
| `gpt-5.1-codex-max` | 400K |
|
||||
| `gpt-5.1-codex-mini` | 400K |
|
||||
| `gpt-5.1` | 200K |
|
||||
|
||||
<Info>
|
||||
ChatGPT Pro subscribers have access to the full model lineup. ChatGPT Plus subscribers can access a subset of models depending on their plan. The available models will be shown automatically after you connect.
|
||||
</Info>
|
||||
|
||||
<Tip>
|
||||
The Codex models (e.g., `gpt-5.3-codex`) are optimized for code and reasoning tasks — ideal for complex browser automation workflows that involve form filling, data extraction, and multi-step navigation.
|
||||
</Tip>
|
||||
|
||||
## Reasoning Settings
|
||||
|
||||
ChatGPT Pro includes additional settings for models that support reasoning:
|
||||
|
||||
- **Reasoning Effort** — Control how much the model "thinks" before responding. Options: none, low, medium, high.
|
||||
- **Reasoning Summary** — Choose how reasoning is displayed. Options: auto, concise, detailed.
|
||||
|
||||
These settings are available in the provider configuration after connecting.
|
||||
|
||||
## Disconnecting
|
||||
|
||||
To disconnect your OpenAI account, go to **Settings**, find the ChatGPT Plus/Pro provider, and click **Disconnect**. Your OAuth tokens will be immediately deleted from your machine.
|
||||
308
docs/features/connect-mcps.mdx
Normal file
308
docs/features/connect-mcps.mdx
Normal file
@@ -0,0 +1,308 @@
|
||||
---
|
||||
title: "Connect Apps"
|
||||
description: "Connect 40+ apps to BrowserOS so the assistant can work with your email, calendar, projects, and more"
|
||||
---
|
||||
|
||||
Connect your favorite apps to BrowserOS and let the assistant work across all of them. Read emails, check your calendar, create tasks, post messages, manage files, and more, all through natural conversation.
|
||||
|
||||
<video
|
||||
controls
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://pub-80f8a01e6e8b4239ae53a7652ef85877.r2.dev/resources/feature-videos/4-MCP.mp4"
|
||||
></video>
|
||||
|
||||
## How It Works
|
||||
|
||||
BrowserOS uses the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) to connect your apps. You do not need to install anything or manage API keys. Just sign in once and the assistant handles the rest.
|
||||
|
||||
|
||||
## Smart App Connection
|
||||
|
||||
When you ask the assistant to do something that needs an app you have not connected yet, it shows an interactive card right in the conversation. You can connect the app with one click or choose to skip it. No need to set things up in advance.
|
||||
|
||||
<Steps>
|
||||
<Step title="You make a request">
|
||||
Ask the assistant something like "What's on my calendar today?" or "Send an email to Sarah."
|
||||
</Step>
|
||||
<Step title="A connection card appears">
|
||||
The assistant detects the app is not connected and shows a card explaining why connecting it would help. You get two choices: **Connect** or **Do it manually**.
|
||||
</Step>
|
||||
<Step title="You connect or skip">
|
||||
- **Connect**: Opens a sign-in page. Authorize the app and the assistant continues with full integration access.
|
||||
- **Do it manually**: The assistant skips the integration and navigates to the app's website directly using browser automation.
|
||||
</Step>
|
||||
<Step title="The assistant continues">
|
||||
Once connected, the app stays linked for all future conversations. If you chose to skip, the assistant remembers and will not ask again.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
{/* <Frame caption="The assistant detects an unconnected app and shows a connection card">
|
||||
<img src="/images/connect-apps-smart-connection.png" alt="Smart app connection prompt in chat" />
|
||||
</Frame> */}
|
||||
|
||||
See [Smart Nudges](/features/smart-nudges#app-connection) for more details on how connection suggestions work.
|
||||
|
||||
You can also connect apps ahead of time from the sidebar if you prefer.
|
||||
|
||||
## Connect from the Sidebar
|
||||
|
||||
<Steps>
|
||||
<Step title="Open Connect Apps">
|
||||
Click **Connect Apps** in the sidebar.
|
||||
</Step>
|
||||
<Step title="Add an app">
|
||||
Click **Add built-in app** and select the app you want
|
||||
</Step>
|
||||
<Step title="Sign in">
|
||||
Complete the OAuth sign-in when prompted
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Frame caption="Connected apps show a green 'Authenticated' badge">
|
||||
<img src="/images/connect-apps-settings.png" alt="Connected Apps settings page" />
|
||||
</Frame>
|
||||
|
||||
## 40+ Supported Apps
|
||||
|
||||
BrowserOS connects to over 40 apps across every category you need.
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Email" icon="envelope">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **Gmail** | Send, read, and search emails, manage drafts and labels |
|
||||
| **Outlook Mail** | Send, read, and manage emails |
|
||||
| **Resend** | Send transactional and marketing emails |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Calendar and Scheduling" icon="calendar">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **Google Calendar** | Create events, find free time, manage calendars |
|
||||
| **Outlook Calendar** | Schedule meetings, manage events |
|
||||
| **Cal.com** | Schedule meetings, manage availability |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Messaging" icon="comments">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **Slack** | Post messages, manage channels |
|
||||
| **Discord** | Send messages, manage servers |
|
||||
| **WhatsApp** | Send messages, manage conversations |
|
||||
| **Microsoft Teams** | Chat, meet, and collaborate |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Development" icon="code">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **GitHub** | Manage repos, issues, and pull requests |
|
||||
| **GitLab** | Manage repos, issues, and merge requests |
|
||||
| **Vercel** | Deploy and manage web applications |
|
||||
| **Postman** | Test and manage APIs |
|
||||
| **Cloudflare** | Manage domains, DNS, and security |
|
||||
| **Supabase** | Manage databases and backend services |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Project Management" icon="list-check">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **Linear** | Create issues, manage cycles and projects |
|
||||
| **Jira** | Create issues, manage sprints |
|
||||
| **Asana** | Organize and track team projects |
|
||||
| **Monday** | Manage work and team collaboration |
|
||||
| **ClickUp** | Manage tasks, projects, and workflows |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Documents and Productivity" icon="file-lines">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **Notion** | Create pages, manage databases |
|
||||
| **Google Docs** | Create and edit documents |
|
||||
| **Google Sheets** | Create and edit spreadsheets |
|
||||
| **Google Drive** | Upload, download, and manage files |
|
||||
| **Google Forms** | Create and manage forms and surveys |
|
||||
| **Confluence** | Create and manage documentation |
|
||||
| **Airtable** | Manage bases, tables, and records |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="File Storage" icon="folder-open">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **Dropbox** | Store and share files |
|
||||
| **OneDrive** | Store and sync files with Microsoft |
|
||||
| **Box** | Manage and share enterprise files |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Design" icon="pen-ruler">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **Figma** | Access and manage design files |
|
||||
| **Canva** | Create and manage designs |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="CRM and Marketing" icon="chart-line">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **Salesforce** | Manage leads, contacts, and opportunities |
|
||||
| **HubSpot** | Manage contacts, deals, and marketing |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="E-commerce and Payments" icon="cart-shopping">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **Shopify** | Manage products, orders, and store |
|
||||
| **Stripe** | Manage payments and subscriptions |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Analytics" icon="chart-bar">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **PostHog** | Query analytics, manage feature flags |
|
||||
| **Mixpanel** | Analyze user behavior and metrics |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Support" icon="headset">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **Zendesk** | Manage support tickets and customers |
|
||||
| **Intercom** | Manage customer messaging and support |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Search and AI" icon="magnifying-glass">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **Brave Search** | Search the web privately |
|
||||
| **Exa** | AI-powered semantic web search |
|
||||
| **Mem0** | Store and retrieve AI memory |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Social and Content" icon="share-nodes">
|
||||
| App | What you can do |
|
||||
|-----|----------------|
|
||||
| **LinkedIn** | Post updates, manage connections |
|
||||
| **YouTube** | Access video info and transcripts |
|
||||
| **WordPress** | Manage websites and blog content |
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## Example Prompts
|
||||
|
||||
The assistant figures out which apps to use based on what you ask. Just describe what you want in plain language.
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Calendar" icon="calendar">
|
||||
- What's on my calendar today?
|
||||
- Schedule a meeting with Sarah tomorrow at 2pm
|
||||
- When is my next meeting with the marketing team?
|
||||
- Block off Friday afternoon for focus time
|
||||
</Accordion>
|
||||
<Accordion title="Email" icon="envelope">
|
||||
- Show me unread emails from my manager
|
||||
- Draft a reply to the last email from John thanking him for the update
|
||||
- Find emails about the Q4 budget from last week
|
||||
- Send an email to the team with the meeting notes
|
||||
</Accordion>
|
||||
<Accordion title="Messaging" icon="hashtag">
|
||||
- Post a message to #general saying I'll be out tomorrow
|
||||
- What's the latest message in #engineering?
|
||||
- Send a DM to Sarah asking if she's free for lunch
|
||||
- Summarize what was discussed in #product today
|
||||
</Accordion>
|
||||
<Accordion title="Project Management" icon="list-check">
|
||||
- Create a new Linear issue for the homepage redesign
|
||||
- What are my open tasks in Jira?
|
||||
- Move the "Launch campaign" task to complete in Asana
|
||||
- Add a comment to the latest ClickUp task
|
||||
</Accordion>
|
||||
<Accordion title="Documents" icon="cube">
|
||||
- Add "Review Q4 report" to my Notion tasks database
|
||||
- Create a new page in my Projects database for the website redesign
|
||||
- What are my open tasks in Notion?
|
||||
- Update the status of the "Launch campaign" task to complete
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## Cross-App Workflows
|
||||
|
||||
The real power of connected apps is combining them in a single request. The assistant can pull data from one app and use it in another without you switching between tabs.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Email to task" icon="envelope">
|
||||
"Find action items in my latest emails and add them to my Notion tasks"
|
||||
</Card>
|
||||
<Card title="Meeting prep" icon="calendar">
|
||||
"Check my calendar for tomorrow, then draft an email to John summarizing what we're meeting about"
|
||||
</Card>
|
||||
<Card title="Bug triage" icon="bug">
|
||||
"Test the checkout flow on our staging site, file a Linear issue if anything is broken, and post a summary to #engineering on Slack"
|
||||
</Card>
|
||||
<Card title="Sales pipeline" icon="chart-line">
|
||||
"Pull my open deals from Salesforce and create a summary spreadsheet in Google Sheets"
|
||||
</Card>
|
||||
<Card title="Content roundup" icon="newspaper">
|
||||
"Check the latest pull requests on our main repo and post a daily summary to #dev-updates on Slack"
|
||||
</Card>
|
||||
<Card title="Expense tracking" icon="receipt">
|
||||
"Find all receipts in my Gmail from this month and organize them in a Google Sheet"
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Add a Custom MCP Server
|
||||
|
||||
You can connect any MCP-compatible server that exposes an SSE endpoint.
|
||||
|
||||
1. Go to **Settings > Connected Apps**
|
||||
2. Click **Add custom app**
|
||||
3. Enter your server URL (e.g., `http://localhost:8000/sse`) and give it a name
|
||||
|
||||
Custom servers appear alongside built-in apps and work the same way.
|
||||
|
||||
<Tip>
|
||||
MCP has a growing ecosystem of servers. Browse [MCP servers on GitHub](https://github.com/modelcontextprotocol/servers) to find integrations for databases, APIs, and more.
|
||||
</Tip>
|
||||
|
||||
### Connect to OAuth-Protected Remote Servers
|
||||
|
||||
Some remote MCP servers (like Atlassian Jira, GitHub, etc.) require OAuth authentication. Use [mcp-remote](https://www.npmjs.com/package/mcp-remote) and [supergateway](https://github.com/supercorp-ai/supergateway) to handle the OAuth flow locally:
|
||||
|
||||
```bash
|
||||
npx -y supergateway --stdio "npx -y mcp-remote https://mcp.atlassian.com/v1/sse" --port 8000
|
||||
```
|
||||
|
||||
A browser window will open to sign in. Once authenticated, add `http://localhost:8000/sse` as a custom MCP in BrowserOS.
|
||||
|
||||
<Note>
|
||||
Keep the terminal running while you use BrowserOS. The local server handles authentication and proxies requests to the remote MCP server.
|
||||
</Note>
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Example: Atlassian Jira" icon="jira" iconType="brands">
|
||||
```bash
|
||||
npx -y supergateway --stdio "npx -y mcp-remote https://mcp.atlassian.com/v1/sse" --port 8000
|
||||
```
|
||||
Then add `http://localhost:8000/sse` as a custom MCP.
|
||||
</Accordion>
|
||||
<Accordion title="Example: GitHub" icon="github" iconType="brands">
|
||||
```bash
|
||||
npx -y supergateway --stdio "npx -y mcp-remote https://api.githubcopilot.com/mcp/sse" --port 8001
|
||||
```
|
||||
Then add `http://localhost:8001/sse` as a custom MCP.
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## Privacy and Security
|
||||
|
||||
<Columns cols={2}>
|
||||
<Card title="Secure OAuth" icon="shield-check">
|
||||
All apps use OAuth sign-in. BrowserOS never sees or stores your passwords.
|
||||
</Card>
|
||||
<Card title="On-demand only" icon="clock">
|
||||
Apps are only accessed when you ask. Nothing runs in the background.
|
||||
</Card>
|
||||
<Card title="You control access" icon="toggle-on">
|
||||
Connect or disconnect any app at any time from Settings.
|
||||
</Card>
|
||||
<Card title="Credentials stay local" icon="lock">
|
||||
Your authentication tokens are managed securely and stored locally on your machine.
|
||||
</Card>
|
||||
</Columns>
|
||||
222
docs/features/cowork.mdx
Normal file
222
docs/features/cowork.mdx
Normal file
@@ -0,0 +1,222 @@
|
||||
---
|
||||
title: "Cowork"
|
||||
description: "Give the agent controlled access to local files and commands alongside browser automation"
|
||||
---
|
||||
|
||||
Cowork lets you describe complex tasks and let the agent handle them end-to-end. It combines browser automation with local file operations: research on the web, then save reports directly to your folder. Read code, edit files, run shell commands, and search through your project, all in the same session as your browser tasks.
|
||||
|
||||
Here's what it looks like to give the agent access to your local files:
|
||||
|
||||
<video
|
||||
controls
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://pub-80f8a01e6e8b4239ae53a7652ef85877.r2.dev/resources/feature-videos/3-filesystem-access.mp4"
|
||||
></video>
|
||||
|
||||
## Why Cowork?
|
||||
|
||||
Without Cowork, the agent can only interact with browser tabs. With Cowork enabled, it gains full access to a folder on your machine through 7 filesystem tools:
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card title="Read & write files" icon="file-lines">
|
||||
Read documents and data files, write reports, markdown, HTML, and other outputs
|
||||
</Card>
|
||||
<Card title="Edit files" icon="pen-to-square">
|
||||
Make targeted edits to existing files with surgical string replacement
|
||||
</Card>
|
||||
<Card title="Run commands" icon="terminal">
|
||||
Execute shell commands within the sandboxed folder
|
||||
</Card>
|
||||
<Card title="Search content" icon="magnifying-glass">
|
||||
Search file contents with regex or literal patterns across your project
|
||||
</Card>
|
||||
<Card title="Find files" icon="folder-tree">
|
||||
Find files by glob pattern, with smart filtering of build directories
|
||||
</Card>
|
||||
<Card title="Browse directories" icon="list">
|
||||
List directory contents with file sizes, sorted and organized
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
The real power: do both browser automation AND file operations in a single task. Describe what you want, step away, and come back to finished work.
|
||||
|
||||
## Setting Up Cowork
|
||||
|
||||
<Steps>
|
||||
<Step title="Open the Cowork selector">
|
||||
Click the **Cowork** dropdown next to the prompt input
|
||||
</Step>
|
||||
<Step title="Choose a folder">
|
||||
Select a recent folder or click **Choose a different folder**
|
||||
</Step>
|
||||
<Step title="Grant access">
|
||||
Allow BrowserOS to access that folder when prompted
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Frame caption="Select a folder for the agent to operate in">
|
||||
<img src="/features/cowork/cowork-selector.png" alt="Select a folder for the agent to operate in" />
|
||||
</Frame>
|
||||
|
||||
The agent is sandboxed to your selected folder. It cannot access files outside of it.
|
||||
|
||||
<Note>
|
||||
Cowork is available in **Agent Mode** only. In Chat Mode, the agent works with browser tabs only.
|
||||
</Note>
|
||||
|
||||
<Tip>
|
||||
To disable file access, select **No folder** and the agent will work with browser tabs only.
|
||||
</Tip>
|
||||
|
||||
## Filesystem Tools
|
||||
|
||||
Cowork provides 7 filesystem tools that the agent can use alongside browser automation:
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="filesystem_read" icon="file-import">
|
||||
Read a file from the filesystem. Returns text content with line numbers, or image data for image files (PNG, JPG, GIF, WEBP, BMP, SVG, ICO). Supports pagination through large files with `offset` and `limit` parameters.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
|-----------|------|-------------|
|
||||
| `path` | string (required) | File path relative to working directory |
|
||||
| `offset` | number (optional) | Starting line number (1-indexed) |
|
||||
| `limit` | number (optional) | Max lines to read |
|
||||
|
||||
Responses are capped at 2000 lines or 50KB per request.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="filesystem_write" icon="file-export">
|
||||
Create or overwrite a file. Automatically creates parent directories if they don't exist.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
|-----------|------|-------------|
|
||||
| `path` | string (required) | File path relative to working directory |
|
||||
| `content` | string (required) | Complete file content to write |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="filesystem_edit" icon="pen-to-square">
|
||||
Make a targeted edit by replacing an exact string match. If the exact match fails, a whitespace-tolerant fuzzy match is attempted. Preserves original line endings (CRLF, CR, LF) and BOM.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
|-----------|------|-------------|
|
||||
| `path` | string (required) | File path relative to working directory |
|
||||
| `old_string` | string (required) | Exact text to find |
|
||||
| `new_string` | string (required) | Replacement text |
|
||||
|
||||
Returns a side-by-side diff of the change.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="filesystem_bash" icon="terminal">
|
||||
Execute a shell command and return its output. Commands run in `sh`/`bash` on Unix or `cmd` on Windows.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
|-----------|------|-------------|
|
||||
| `command` | string (required) | Shell command to execute |
|
||||
| `timeout` | number (optional) | Timeout in seconds (default: 120) |
|
||||
|
||||
Output is truncated to the last 2000 lines if too large. Returns the exit code on failure.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="filesystem_find" icon="folder-tree">
|
||||
Find files matching a glob pattern. Searches recursively while skipping common build directories (`node_modules`, `.git`, `dist`, `build`, `.next`, `coverage`, `__pycache__`, and more).
|
||||
|
||||
| Parameter | Type | Description |
|
||||
|-----------|------|-------------|
|
||||
| `pattern` | string (required) | Glob pattern (e.g., `*.ts`, `**/*.json`) |
|
||||
| `path` | string (optional) | Directory to search (default: working directory) |
|
||||
| `limit` | number (optional) | Max results (default: 1000) |
|
||||
|
||||
Returns relative file paths sorted alphabetically.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="filesystem_grep" icon="magnifying-glass">
|
||||
Search file contents using regex or literal string matching. Skips binary files and files over 2MB.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
|-----------|------|-------------|
|
||||
| `pattern` | string (required) | Search pattern (regex by default) |
|
||||
| `path` | string (optional) | Directory or file to search |
|
||||
| `glob` | string (optional) | Filter files by glob (e.g., `*.ts`) |
|
||||
| `ignore_case` | boolean (optional) | Case-insensitive search |
|
||||
| `literal` | boolean (optional) | Treat pattern as literal string |
|
||||
| `context` | number (optional) | Lines of context around matches |
|
||||
| `limit` | number (optional) | Max matches (default: 100) |
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="filesystem_ls" icon="list">
|
||||
List directory contents. Shows directories first (with trailing `/`), then files with human-readable sizes.
|
||||
|
||||
| Parameter | Type | Description |
|
||||
|-----------|------|-------------|
|
||||
| `path` | string (optional) | Directory path (default: working directory) |
|
||||
| `limit` | number (optional) | Max entries (default: 500) |
|
||||
|
||||
Entries are sorted alphabetically, case-insensitive.
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## Try It: Research and Create a Report
|
||||
|
||||
With Cowork enabled, try this prompt:
|
||||
|
||||
```
|
||||
Read the top 3 stories on Hacker News, read the comments too, and write an HTML report.
|
||||
```
|
||||
|
||||
The agent will:
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to Hacker News">
|
||||
Opens the site and identifies top stories
|
||||
</Step>
|
||||
<Step title="Read stories and comments">
|
||||
Clicks into each story and reads discussion threads
|
||||
</Step>
|
||||
<Step title="Generate report">
|
||||
Creates an HTML report summarizing the findings
|
||||
</Step>
|
||||
<Step title="Save to folder">
|
||||
Writes the report to your selected folder
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Frame caption="Agent researching Hacker News and generating an HTML report">
|
||||
<img src="/features/cowork/cowork-research-example.png" alt="Agent researching Hacker News and generating an HTML report" />
|
||||
</Frame>
|
||||
|
||||
## Example Use Cases
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Organize your downloads" icon="folder-tree">
|
||||
> Go through my Downloads folder and organize files by type: documents, images, videos, archives.
|
||||
</Accordion>
|
||||
<Accordion title="Competitive research report" icon="magnifying-glass-chart">
|
||||
> Research key trends about [topic] on Reddit, Twitter, and LinkedIn. Create an HTML report with your findings.
|
||||
</Accordion>
|
||||
<Accordion title="Web scraping to files" icon="spider-web">
|
||||
> Visit these 10 product pages, extract the name, price, and description, and save the results as a markdown file.
|
||||
</Accordion>
|
||||
<Accordion title="Content aggregation" icon="newspaper">
|
||||
> Find the top posts from these 5 subreddits today and compile them into a daily digest document.
|
||||
</Accordion>
|
||||
<Accordion title="Codebase exploration" icon="code">
|
||||
> Search my project for all TODO comments, list them with file paths and line numbers, then create a summary markdown file.
|
||||
</Accordion>
|
||||
<Accordion title="Log analysis" icon="file-lines">
|
||||
> Grep through the log files in this folder for errors from the last 24 hours and write a summary of what went wrong.
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## Security
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card title="Sandboxed access" icon="box">
|
||||
The agent can only access the folder you select. No parent directories, no path traversal.
|
||||
</Card>
|
||||
<Card title="Revoke anytime" icon="ban">
|
||||
Select **No folder** to instantly disable file access
|
||||
</Card>
|
||||
<Card title="Local only" icon="house-laptop">
|
||||
All file operations happen locally on your machine
|
||||
</Card>
|
||||
</CardGroup>
|
||||
BIN
docs/features/cowork/cowork-research-example.png
Normal file
BIN
docs/features/cowork/cowork-research-example.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 859 KiB |
BIN
docs/features/cowork/cowork-selector.png
Normal file
BIN
docs/features/cowork/cowork-selector.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 522 KiB |
60
docs/features/github-copilot-oauth.mdx
Normal file
60
docs/features/github-copilot-oauth.mdx
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: "GitHub Copilot"
|
||||
description: "Use your GitHub Copilot subscription to power BrowserOS"
|
||||
---
|
||||
|
||||
Connect your GitHub Copilot subscription to BrowserOS and access 19+ models — including Claude, GPT-5, and Gemini — through a single GitHub sign-in. No API keys needed.
|
||||
|
||||
<Info>
|
||||
**Free tier** includes GPT-5 Mini, Claude Haiku 4.5, GPT-4o, and GPT-4.1. **Copilot Pro** ($10/month) unlocks Claude Sonnet 4.6, Claude Opus 4.6, Gemini 3 Pro, GPT-5.4, and more.
|
||||
</Info>
|
||||
|
||||
## Setup
|
||||
|
||||
**1.** Open BrowserOS and go to **Settings** (`chrome://browseros/settings`). You'll see the AI Providers section.
|
||||
|
||||

|
||||
|
||||
**2.** Click **USE** on the **GitHub Copilot** card. A device code will appear — copy it, then click the link to open GitHub's device authorization page.
|
||||
|
||||

|
||||
|
||||
**3.** Select your GitHub account to authorize.
|
||||
|
||||

|
||||
|
||||
**4.** Paste the device code and authorize BrowserOS to access your Copilot subscription.
|
||||
|
||||

|
||||
|
||||
**5.** Once authorized, GitHub Copilot will appear as a provider in your settings. Select a model and start using it.
|
||||
|
||||
## Available Models
|
||||
|
||||
### Free Tier
|
||||
| Model | Context Window |
|
||||
|-------|---------------|
|
||||
| `gpt-5-mini` | 128K |
|
||||
| `claude-haiku-4.5` | 128K |
|
||||
| `gpt-4o` | 64K |
|
||||
| `gpt-4.1` | 64K |
|
||||
|
||||
### Copilot Pro / Pro+
|
||||
| Model | Context Window |
|
||||
|-------|---------------|
|
||||
| `claude-sonnet-4.6` | 200K |
|
||||
| `claude-opus-4.6` | 200K |
|
||||
| `gemini-2.5-pro` | 1M |
|
||||
| `gemini-3-pro-preview` | 1M |
|
||||
| `gpt-5.4` | 400K |
|
||||
| `gpt-5.3-codex` | 400K |
|
||||
| `gpt-5.2-codex` | 400K |
|
||||
| `grok-code-fast-1` | 128K |
|
||||
|
||||
<Tip>
|
||||
GitHub Copilot is the most versatile provider — one subscription gives you access to models from OpenAI, Anthropic, Google, and xAI. Great if you want to switch between models for different tasks.
|
||||
</Tip>
|
||||
|
||||
## Disconnecting
|
||||
|
||||
To disconnect your GitHub account, go to **Settings**, find the GitHub Copilot provider, and click **Disconnect**. Your OAuth tokens will be immediately deleted from your machine.
|
||||
68
docs/features/llm-chat-hub.mdx
Normal file
68
docs/features/llm-chat-hub.mdx
Normal file
@@ -0,0 +1,68 @@
|
||||
---
|
||||
title: "Chat & Hub"
|
||||
description: "Access ChatGPT, Claude, and Gemini from any webpage with one click"
|
||||
---
|
||||
|
||||
BrowserOS puts AI chat at your fingertips. Open a chat panel on any webpage to ask questions with full page context, or compare responses across multiple LLMs side-by-side.
|
||||
|
||||
Watch the chat panel and LLM Hub in action:
|
||||
|
||||
<video
|
||||
controls
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://pub-80f8a01e6e8b4239ae53a7652ef85877.r2.dev/resources/feature-videos/2-llm-chat-hub.mp4"
|
||||
></video>
|
||||
|
||||
## LLM Chat
|
||||
|
||||
Click the **Chat** button in the toolbar (or press `Option+K`) to open an AI chat panel on any webpage.
|
||||
|
||||
<img src="/images/features--llm-chat-panel.png" alt="LLM Chat panel open on a webpage" />
|
||||
|
||||
### Features
|
||||
|
||||
- **Switch providers instantly** — Use the dropdown or press `Option+L` to cycle between Claude, ChatGPT, and Gemini
|
||||
- **Copy page context** — Grab the current webpage content to paste into your prompt
|
||||
- **Screenshot and attach** — Capture the visible page as an image for visual questions
|
||||
- **Works everywhere** — The panel stays open as you browse
|
||||
|
||||
### Toolbar Buttons
|
||||
|
||||
<img src="/images/features--llm-chat-toolbar.png" alt="LLM Chat toolbar buttons" />
|
||||
|
||||
| Icon | Action |
|
||||
|------|--------|
|
||||
| Copy | Copy webpage content to clipboard |
|
||||
| Image | Screenshot webpage and copy |
|
||||
| Refresh | Reset LLM chat |
|
||||
| External | Open LLM in new tab |
|
||||
| Menu | Additional options + Popout LLM Hub |
|
||||
|
||||
### Keyboard Shortcuts
|
||||
|
||||
| Shortcut | Action |
|
||||
|----------|--------|
|
||||
| `Option+K` | Toggle chat panel |
|
||||
| `Option+L` | Switch to next provider |
|
||||
|
||||
## LLM Hub (Clash of GPTs)
|
||||
|
||||
Click the **Hub** button in the toolbar (or press `Cmd+Shift+U`) to open a multi-pane comparison window.
|
||||
|
||||
<img src="/images/features--llm-hub.png" alt="LLM Hub with three panes showing Claude, Gemini, and ChatGPT" />
|
||||
|
||||
The Hub lets you query multiple LLMs simultaneously:
|
||||
|
||||
1. Choose 1, 2, or 3 panes using the panel selector in the top-right
|
||||
2. Select which LLM to use in each pane (Claude, Gemini, or ChatGPT)
|
||||
3. Paste your prompt into each pane and compare responses
|
||||
|
||||
This is useful when you want an "LLM council" — get multiple perspectives on a question and see where the models agree or differ.
|
||||
|
||||
## Customization
|
||||
|
||||
Control which buttons appear in your toolbar from **Settings → Customization**:
|
||||
|
||||
- **Show Chat Button** — Display the Chat button in the toolbar
|
||||
- **Show Hub Button** — Display the Hub button in the toolbar
|
||||
- **Show Button Labels** — Display text labels next to toolbar icons
|
||||
120
docs/features/local-models.mdx
Normal file
120
docs/features/local-models.mdx
Normal file
@@ -0,0 +1,120 @@
|
||||
---
|
||||
title: "Bring Your Local Model"
|
||||
description: "Run AI models locally with Ollama or LM Studio for free, private, offline use"
|
||||
---
|
||||
|
||||
BrowserOS works great with local models for Chat Mode. Run models completely offline — your data never leaves your machine.
|
||||
|
||||
## Context Length
|
||||
|
||||
<Warning>
|
||||
**Ollama defaults to 4,096 tokens of context — this is too low for BrowserOS.** Below 15K tokens, the context overflows and the agent gets stuck in a loop constantly trying to recover. Only Chat Mode will work at low context lengths. Set at least **15,000–20,000 tokens** for local models to function properly.
|
||||
</Warning>
|
||||
|
||||
Set context length when starting Ollama:
|
||||
|
||||
```bash
|
||||
OLLAMA_CONTEXT_LENGTH=20000 ollama serve
|
||||
```
|
||||
|
||||
<Info>
|
||||
Increasing context length uses more VRAM. Run `ollama ps` to check your current allocation. See the [Ollama context length docs](https://docs.ollama.com/context-length) for more details.
|
||||
</Info>
|
||||
|
||||
---
|
||||
|
||||
## Setup
|
||||
|
||||
<Tabs>
|
||||
<Tab title="Ollama" icon="terminal">
|
||||
The easiest way to run models locally.
|
||||
|
||||
<Steps>
|
||||
<Step title="Install Ollama">
|
||||
Download from [ollama.com](https://ollama.com) and install it.
|
||||
</Step>
|
||||
<Step title="Pull a model">
|
||||
```bash
|
||||
ollama pull qwen/qwen3-4b
|
||||
```
|
||||
</Step>
|
||||
<Step title="Start Ollama with higher context">
|
||||
```bash
|
||||
OLLAMA_CONTEXT_LENGTH=20000 ollama serve
|
||||
```
|
||||
</Step>
|
||||
<Step title="Configure in BrowserOS">
|
||||
1. Go to `chrome://browseros/settings`
|
||||
2. Click **USE** on the Ollama card
|
||||
3. Set **Model ID** to `qwen/qwen3-4b`
|
||||
4. Set **Context Window** to `20000`
|
||||
5. Click **Save**
|
||||
|
||||

|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
<Tab title="LM Studio" icon="desktop">
|
||||
Nice GUI if you don't want to use the terminal.
|
||||
|
||||
<Steps>
|
||||
<Step title="Install LM Studio">
|
||||
Download from [lmstudio.ai](https://lmstudio.ai) and install it.
|
||||
</Step>
|
||||
<Step title="Load a model">
|
||||
Open LM Studio → **Developer** tab → load a model. It runs a server at `http://localhost:1234/v1/`.
|
||||
|
||||

|
||||
</Step>
|
||||
<Step title="Configure in BrowserOS">
|
||||
1. Go to `chrome://browseros/settings`
|
||||
2. Click **USE** on the **OpenAI Compatible** card
|
||||
3. Set **Base URL** to `http://localhost:1234/v1/`
|
||||
4. Set **Model ID** to the model you loaded
|
||||
5. Set **Context Window** to at least `20000`
|
||||
6. Click **Save**
|
||||
|
||||

|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
---
|
||||
|
||||
## Recommended Models
|
||||
|
||||
Pick a model based on your available RAM/VRAM. Smaller models are faster but less capable.
|
||||
|
||||
### Lightweight (under 5 GB)
|
||||
|
||||
Good for machines with 8 GB RAM. Fast responses, suitable for simple chat tasks.
|
||||
|
||||
| Model | Publisher | Params | Quant | Size |
|
||||
|-------|-----------|--------|-------|------|
|
||||
| `qwen/qwen3-4b` | Qwen | 4B | 4bit | 2.28 GB |
|
||||
| `mistralai/ministral-3-3b` | Mistral | 3B | Q4_K_M | 2.99 GB |
|
||||
| `deepseek-r1-distill-qwen-7b` | lmstudio-community | 7B | Q4_K_M | 4.68 GB |
|
||||
| `deepseek-r1-distill-llama-8b` | lmstudio-community | 8B | Q4_K_M | 4.92 GB |
|
||||
|
||||
### Mid-range (10–15 GB)
|
||||
|
||||
Needs 16+ GB RAM. Better reasoning, handles longer conversations well.
|
||||
|
||||
| Model | Publisher | Params | Quant | Size |
|
||||
|-------|-----------|--------|-------|------|
|
||||
| `openai/gpt-oss-20b` | OpenAI | 20B | MXFP4 | 12.11 GB |
|
||||
| `mistralai/magistral-small` | Mistral | 23.6B | 4bit | 13.28 GB |
|
||||
| `mistralai/devstral-small-2-2512` | Mistral | 24B | 4bit | 14.12 GB |
|
||||
|
||||
### Heavy (60+ GB)
|
||||
|
||||
For workstations with 64+ GB RAM. Closest to cloud model quality.
|
||||
|
||||
| Model | Publisher | Params | Quant | Size |
|
||||
|-------|-----------|--------|-------|------|
|
||||
| `openai/gpt-oss-120b` | OpenAI | 120B | MXFP4 | 63.39 GB |
|
||||
|
||||
<Tip>
|
||||
Start with `qwen/qwen3-4b` if you're unsure — it's small, fast, and surprisingly capable for its size.
|
||||
</Tip>
|
||||
128
docs/features/memory.mdx
Normal file
128
docs/features/memory.mdx
Normal file
@@ -0,0 +1,128 @@
|
||||
---
|
||||
title: "Memory"
|
||||
description: "Your assistant remembers what matters across every conversation"
|
||||
---
|
||||
|
||||
The BrowserOS assistant has long-term memory. It remembers your name, your projects, the tools you use, and things that came up in past conversations. You do not need to repeat yourself. The assistant builds up knowledge about you over time and uses it to give better, more relevant answers.
|
||||
|
||||
## How Memory Works
|
||||
|
||||
Memory is automatic. As you chat, the assistant saves important facts and observations to local files on your machine. Before responding in future conversations, it searches these files to recall relevant context.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Remembers you" icon="user">
|
||||
Your name, job, location, projects, and preferences are stored permanently and recalled whenever relevant.
|
||||
</Card>
|
||||
<Card title="Keeps session notes" icon="note-sticky">
|
||||
Useful details from each conversation are saved as daily notes and kept for 30 days.
|
||||
</Card>
|
||||
<Card title="Searches before answering" icon="magnifying-glass">
|
||||
The assistant proactively searches its memory before responding, so it can reference things you have mentioned before.
|
||||
</Card>
|
||||
<Card title="Stays on your machine" icon="hard-drive">
|
||||
All memory files are plain Markdown stored locally. Memory is never uploaded to the cloud, even with Sync to Cloud enabled.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Two Types of Memory
|
||||
|
||||
BrowserOS uses a two-tier memory system to keep important facts separate from session notes.
|
||||
|
||||
### Core Memory
|
||||
|
||||
Core memory holds permanent facts about you. Things like your name, where you work, what projects you are working on, the tools and languages you use, and people you mention regularly. These facts persist forever and are never automatically deleted.
|
||||
|
||||
Core memory lives in a single file called `CORE.md`. When the assistant learns something new about you, it reads the existing core memory, merges the new fact in, and saves the updated file.
|
||||
|
||||
**Examples of what goes in core memory:**
|
||||
- Your name and role
|
||||
- Company and team
|
||||
- Projects you are working on
|
||||
- Tools, languages, and frameworks you use
|
||||
- People you mention often
|
||||
- Long-term preferences ("I prefer TypeScript over JavaScript")
|
||||
|
||||
### Daily Memory
|
||||
|
||||
Daily memory holds session notes, observations, and recent events. Each day gets its own file (e.g., `2026-03-07.md`), and entries are timestamped so the assistant can see when things happened.
|
||||
|
||||
Daily memories automatically expire after **30 days**. If something keeps coming up, the assistant promotes it to core memory so it is not lost.
|
||||
|
||||
**Examples of what goes in daily memory:**
|
||||
- Tasks you worked on today
|
||||
- Decisions made during a conversation
|
||||
- Temporary context ("meeting with Sarah moved to Thursday")
|
||||
- Research findings from a browsing session
|
||||
|
||||
## Memory in Action
|
||||
|
||||
You do not need to tell the assistant to remember things. It picks up on important details naturally. But you can also be explicit:
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Automatic memory" icon="wand-magic-sparkles">
|
||||
Just mention something in conversation and the assistant decides whether to save it:
|
||||
- "I'm working on a project called Atlas at Acme Corp" -> saved to core memory
|
||||
- "We decided to go with Postgres instead of MongoDB" -> saved to daily memory
|
||||
- "My name is Sarah" -> saved to core memory
|
||||
</Accordion>
|
||||
<Accordion title="Ask it to remember" icon="bookmark">
|
||||
Be explicit when you want something remembered:
|
||||
- "Remember that our staging URL is staging.example.com"
|
||||
- "Save this: the design review happens every Tuesday at 2pm"
|
||||
- "Remember that I prefer dark mode in all my tools"
|
||||
</Accordion>
|
||||
<Accordion title="Ask it to recall" icon="rotate-left">
|
||||
The assistant searches memory automatically, but you can also ask directly:
|
||||
- "What do you remember about the Atlas project?"
|
||||
- "What did we discuss yesterday?"
|
||||
- "Do you know my team members' names?"
|
||||
</Accordion>
|
||||
<Accordion title="Ask it to forget" icon="eraser">
|
||||
You can ask the assistant to remove specific memories:
|
||||
- "Forget my phone number"
|
||||
- "Remove the note about the staging URL"
|
||||
- "Clear what you know about Project X"
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## Where Memory Lives
|
||||
|
||||
All memory files are stored locally on your machine in the BrowserOS data folder:
|
||||
|
||||
| File | Path | Purpose |
|
||||
|------|------|---------|
|
||||
| **Core memory** | `~/.browseros/memory/CORE.md` | Permanent facts about you |
|
||||
| **Daily notes** | `~/.browseros/memory/2026-03-07.md` | Session notes, auto-expire after 30 days |
|
||||
|
||||
|
||||
## Memory vs SOUL.md
|
||||
|
||||
BrowserOS separates what the assistant **knows** from how it **behaves**. These are two different systems that work together.
|
||||
|
||||
<Columns cols={2}>
|
||||
<Card title="Memory" icon="brain">
|
||||
**Facts about you and the world.** Your name, projects, preferences, recent events. Stored in CORE.md and daily files.
|
||||
</Card>
|
||||
<Card title="SOUL.md" icon="heart">
|
||||
**How the assistant acts.** Personality, tone, communication style, boundaries. Stored in a single SOUL.md file. See [SOUL.md](/features/soul) for details.
|
||||
</Card>
|
||||
</Columns>
|
||||
|
||||
When the assistant learns that you work at Acme Corp, that goes in memory. When it learns that you prefer bullet points over paragraphs, that goes in SOUL.md. This separation means the assistant can change its personality without losing knowledge about you, and vice versa.
|
||||
|
||||
## Privacy
|
||||
|
||||
<Columns cols={2}>
|
||||
<Card title="Never leaves your machine" icon="lock">
|
||||
Memory files live on your machine and are never uploaded to any server. Even with Sync to Cloud enabled, memory stays local.
|
||||
</Card>
|
||||
<Card title="You control what is remembered" icon="toggle-on">
|
||||
Ask the assistant to forget anything at any time. You can also directly edit or delete the memory files.
|
||||
</Card>
|
||||
<Card title="Plain text files" icon="file-lines">
|
||||
Memory is stored as readable Markdown. No hidden databases or encrypted blobs. You can inspect everything.
|
||||
</Card>
|
||||
<Card title="30-day auto-cleanup" icon="clock">
|
||||
Daily notes are automatically deleted after 30 days. Only facts you have promoted to core memory persist.
|
||||
</Card>
|
||||
</Columns>
|
||||
39
docs/features/qwen-code-oauth.mdx
Normal file
39
docs/features/qwen-code-oauth.mdx
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "Qwen Code"
|
||||
description: "Use your Qwen Code account to power BrowserOS"
|
||||
---
|
||||
|
||||
Connect your Qwen Code account to BrowserOS and access Alibaba's coding models with up to a **1 million token context window** — the largest of any provider we support. No API keys needed.
|
||||
|
||||
## Setup
|
||||
|
||||
**1.** Open BrowserOS and go to **Settings** (`chrome://browseros/settings`). You'll see the AI Providers section.
|
||||
|
||||

|
||||
|
||||
**2.** Click **USE** on the **Qwen Code** card. You'll be prompted to sign in with your Qwen account.
|
||||
|
||||

|
||||
|
||||
**3.** Sign in with your Alibaba Cloud / Qwen account to authorize BrowserOS.
|
||||
|
||||

|
||||
|
||||
**4.** Once authorized, Qwen Code will appear as a provider in your settings. Select a model and start using it.
|
||||
|
||||
## Available Models
|
||||
|
||||
| Model | Context Window |
|
||||
|-------|---------------|
|
||||
| `coder-model` | 1M |
|
||||
| `qwen3-coder-plus` | 1M |
|
||||
| `qwen3-coder-flash` | 1M |
|
||||
| `qwen3.5-plus` | 1M |
|
||||
|
||||
<Tip>
|
||||
Qwen Code's 1 million token context window is ideal for tasks that involve long documents, entire documentation sites, or working across many browser tabs simultaneously — the agent can hold everything in context at once.
|
||||
</Tip>
|
||||
|
||||
## Disconnecting
|
||||
|
||||
To disconnect your Qwen account, go to **Settings**, find the Qwen Code provider, and click **Disconnect**. Your OAuth tokens will be immediately deleted from your machine.
|
||||
147
docs/features/scheduled-tasks.mdx
Normal file
147
docs/features/scheduled-tasks.mdx
Normal file
@@ -0,0 +1,147 @@
|
||||
---
|
||||
title: "Scheduled Tasks"
|
||||
description: "Run the BrowserOS agent automatically on a schedule"
|
||||
---
|
||||
|
||||
Scheduled Tasks let you run the BrowserOS agent automatically, whether it is daily, every few hours, or every few minutes. Write a prompt once, set a schedule, and let the agent handle it on autopilot.
|
||||
|
||||
Watch how to set up a scheduled task from scratch:
|
||||
|
||||
<video
|
||||
controls
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://pub-80f8a01e6e8b4239ae53a7652ef85877.r2.dev/resources/feature-videos/5-scheduled-tasks.mp4"
|
||||
></video>
|
||||
|
||||
## Creating a Scheduled Task
|
||||
|
||||
There are two ways to create a scheduled task: from a conversation or from the settings page.
|
||||
|
||||
### From a conversation
|
||||
|
||||
After the agent completes a task that could run on a schedule, it will suggest scheduling it with an interactive card. You can also ask directly:
|
||||
|
||||
- "Schedule this to run every morning"
|
||||
- "Can this run daily at 8am?"
|
||||
- "Automate this task"
|
||||
|
||||
The agent fills in the task details for you. Just review and confirm. See [Smart Nudges](/features/smart-nudges#schedule-suggestion) for more details.
|
||||
|
||||
### From settings
|
||||
|
||||
<Steps>
|
||||
<Step title="Open Scheduled Tasks">
|
||||
Click **Scheduled Tasks** in the sidebar.
|
||||
</Step>
|
||||
<Step title="Click New Task">
|
||||
Click the **New Task** button to open the creation dialog.
|
||||
</Step>
|
||||
<Step title="Fill in the details">
|
||||
- **Name**: A friendly name for your task
|
||||
- **Prompt**: What you want the agent to do (any natural language instruction)
|
||||
- **Schedule type**: Daily at a specific time, every N hours, or every N minutes
|
||||
- **Enable**: Toggle on to start running immediately
|
||||
</Step>
|
||||
<Step title="Create and go">
|
||||
Click **Create**. The task will run at the next scheduled time automatically.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<img src="/images/features--scheduled-tasks-create.png" alt="Create scheduled task dialog" />
|
||||
|
||||
## Schedule Types
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card title="Daily" icon="calendar-day">
|
||||
Runs once a day at a specific time you choose (e.g., every morning at 8:00 AM).
|
||||
</Card>
|
||||
<Card title="Hourly" icon="clock">
|
||||
Runs every N hours (e.g., every 2 hours, every 6 hours). Set an interval from 1 to 24 hours.
|
||||
</Card>
|
||||
<Card title="Minutes" icon="stopwatch">
|
||||
Runs every N minutes (e.g., every 15 minutes, every 30 minutes). Set an interval from 1 to 60 minutes.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Example Use Cases
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Morning briefing" icon="sun">
|
||||
> Every morning at 8am, check my Google Calendar and send me a summary of today's events. For each meeting, do a quick Google search on the attendees and include their LinkedIn summary.
|
||||
</Accordion>
|
||||
<Accordion title="LinkedIn automation" icon="linkedin" iconType="brands">
|
||||
> Every day, go to LinkedIn and accept up to 25 pending connection requests.
|
||||
</Accordion>
|
||||
<Accordion title="Price monitoring" icon="tag">
|
||||
> Check the price of this Amazon item every hour. If it drops below $50, place the order.
|
||||
</Accordion>
|
||||
<Accordion title="Competitor tracking" icon="chart-line">
|
||||
> Every morning at 9am, visit these 5 competitor websites and check for new product announcements or pricing changes. Summarize what is new.
|
||||
</Accordion>
|
||||
<Accordion title="Social media digest" icon="newspaper">
|
||||
> Every evening at 6pm, check the top posts on Hacker News and r/programming. Create a brief summary of the most interesting discussions.
|
||||
</Accordion>
|
||||
<Accordion title="Cross-app workflow" icon="arrows-rotate">
|
||||
> Check my Google Calendar for tomorrow's meetings, then post a summary to my Slack channel, and create a Notion page with prep notes for each meeting.
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
Your scheduled task prompts can be as complex as you want. If you have [connected apps](/features/connect-mcps) like Google Calendar, Slack, Notion, or Gmail, your scheduled tasks can work across all of them.
|
||||
|
||||
## Viewing Results
|
||||
|
||||
When a scheduled task runs, you can see the results in two places:
|
||||
|
||||
- **New Tab page**: Results show up right on your new tab
|
||||
- **Scheduled Tasks page**: View the full run history for each task
|
||||
|
||||
<img src="/images/features--scheduled-tasks-results.png" alt="Scheduled task results" />
|
||||
|
||||
Each task keeps a history of its last 15 runs. Click on any run to see the full output, including what tools the agent used and what it found.
|
||||
|
||||
<img src="/images/features--scheduled-tasks-output.png" alt="Scheduled task output showing a daily news briefing" />
|
||||
|
||||
You can also:
|
||||
- **Test** a task manually without waiting for the next scheduled run
|
||||
- **Retry** a failed task
|
||||
- **Cancel** a task that is currently running
|
||||
|
||||
## How It Works
|
||||
|
||||
<Steps>
|
||||
<Step title="Task triggers on schedule">
|
||||
BrowserOS uses your browser's built-in alarm system to trigger tasks at the right time. If your laptop was closed at the scheduled time, the task runs as soon as you open BrowserOS again.
|
||||
</Step>
|
||||
<Step title="Background window opens">
|
||||
A hidden browser window opens automatically. The task runs there so it never interrupts whatever you are working on. You will not see anything happen on screen.
|
||||
</Step>
|
||||
<Step title="Agent executes your prompt">
|
||||
The agent runs your prompt with full access to browser automation and any connected apps. It can navigate pages, fill forms, extract data, and interact with your services.
|
||||
</Step>
|
||||
<Step title="Results are saved">
|
||||
When the task finishes, the result is saved and appears on your New Tab page and in the task's run history. The hidden window closes automatically.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Note>
|
||||
BrowserOS needs to be open for scheduled tasks to run. Tasks have a 10-minute timeout. If a task takes longer than that, it will be marked as failed and you can retry it.
|
||||
</Note>
|
||||
|
||||
## Cloud Sync
|
||||
|
||||
If you are signed in, your scheduled task configurations sync across devices. Create a task on your laptop and it appears on your desktop. Edits sync both ways, and conflicts are resolved automatically using timestamps.
|
||||
|
||||
Only the schedule setup syncs (name, prompt, schedule type, and timing). Task run results and output stay on the device where the task ran.
|
||||
|
||||
See [Sync to Cloud](/features/sync-to-cloud) for more details.
|
||||
|
||||
## Privacy
|
||||
|
||||
<Columns cols={2}>
|
||||
<Card title="Runs locally" icon="house-laptop">
|
||||
All tasks run on your machine in a hidden browser window. Nothing is sent to external servers.
|
||||
</Card>
|
||||
<Card title="Full control" icon="toggle-on">
|
||||
Enable, disable, edit, or delete any task at any time. You decide what runs and when.
|
||||
</Card>
|
||||
</Columns>
|
||||
193
docs/features/skills.mdx
Normal file
193
docs/features/skills.mdx
Normal file
@@ -0,0 +1,193 @@
|
||||
---
|
||||
title: "Skills"
|
||||
description: "Teach your BrowserOS agent new abilities with reusable, custom instructions"
|
||||
---
|
||||
|
||||
Skills let you teach the BrowserOS agent how to handle specific tasks. Each skill is a set of instructions written in plain Markdown that the agent loads when it recognizes a matching task. Think of skills as recipes: you write the steps once, and the agent follows them whenever that type of task comes up.
|
||||
|
||||
BrowserOS implements the open [Agent Skills specification](https://agentskills.io/specification), so skills you create are portable across any AI agent that supports the standard.
|
||||
|
||||
## How Skills Work
|
||||
|
||||
<Steps>
|
||||
<Step title="You create a skill">
|
||||
Give it a name, a short description of when to use it, and write the instructions in Markdown.
|
||||
</Step>
|
||||
<Step title="The agent sees the skill catalog">
|
||||
When a conversation starts, the agent loads a list of all your enabled skills with their names and descriptions.
|
||||
</Step>
|
||||
<Step title="The agent matches a task">
|
||||
When your request matches a skill's description, the agent loads that skill's full instructions and follows them.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## Creating a Skill
|
||||
|
||||
<Steps>
|
||||
<Step title="Open Skills settings">
|
||||
Click **Skills** in the sidebar.
|
||||
</Step>
|
||||
<Step title="Click New Skill">
|
||||
Click the **New Skill** button to open the creation form.
|
||||
</Step>
|
||||
<Step title="Fill in the details">
|
||||
- **Name**: A short, descriptive name (e.g., "Morning Status Report")
|
||||
- **Description**: Tell the agent when to use this skill. Be specific. For example: "When the user wants to read status updates from work across Notion, Linear, and Slack"
|
||||
- **Content**: Write your instructions in Markdown. Include step-by-step directions, examples, and edge cases.
|
||||
</Step>
|
||||
<Step title="Save and enable">
|
||||
Click **Create**. The skill is enabled by default and will be available to the agent immediately.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Tip>
|
||||
Write your description like a trigger. The agent uses it to decide whether to activate the skill. A good description says both **what** the skill does and **when** to use it.
|
||||
</Tip>
|
||||
|
||||
## Example Skills
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Morning status report">
|
||||
**Description:** When the user wants to read status updates from work
|
||||
|
||||
**Instructions:**
|
||||
```markdown
|
||||
Always look for updates in 3 sources:
|
||||
1. **Notion** - Check the team updates page for any new entries from today
|
||||
2. **Linear** - Look at issues assigned to the user that were updated in the last 24 hours
|
||||
3. **Slack** - Check the #team-updates and #engineering channels for unread messages
|
||||
|
||||
Summarize everything in a single report grouped by source.
|
||||
If a source has no updates, say so.
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="PDF processing">
|
||||
**Description:** Extract text and tables from PDF files, fill PDF forms, and merge multiple PDFs. Use when the user mentions PDFs, forms, or document extraction.
|
||||
|
||||
**Instructions:**
|
||||
```markdown
|
||||
When extracting text from a PDF:
|
||||
1. Download or open the PDF in the browser
|
||||
2. Use the page content tool to extract visible text
|
||||
3. Preserve table structure using Markdown tables
|
||||
4. If the PDF has multiple pages, process each page
|
||||
|
||||
When filling a PDF form:
|
||||
- Ask the user for the values if not provided
|
||||
- Fill each field carefully and confirm before submitting
|
||||
|
||||
See references/FORMS.md for common form templates.
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Code review checklist">
|
||||
**Description:** When the user asks to review code, a pull request, or wants feedback on code quality
|
||||
|
||||
**Instructions:**
|
||||
```markdown
|
||||
Follow this checklist for every code review:
|
||||
1. Check for security issues (XSS, injection, hardcoded secrets)
|
||||
2. Look for performance problems (N+1 queries, unnecessary re-renders)
|
||||
3. Verify error handling is present and meaningful
|
||||
4. Check that naming is clear and consistent
|
||||
5. Look for missing tests for new logic
|
||||
|
||||
Format your review as a list of findings with severity: Critical, Warning, or Suggestion.
|
||||
Always start with what the code does well.
|
||||
```
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## Managing Skills
|
||||
|
||||
From the Skills page, you can:
|
||||
|
||||
- **Enable or disable** a skill using the toggle switch. Disabled skills are not loaded by the agent.
|
||||
- **Edit** a skill's name, description, or instructions by clicking the edit icon.
|
||||
- **Delete** a skill by clicking the trash icon. This removes the skill permanently.
|
||||
|
||||
## Skill File Format
|
||||
|
||||
Under the hood, each skill is stored as a `SKILL.md` file following the [Agent Skills specification](https://agentskills.io/specification):
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: morning-status-report
|
||||
description: When the user wants to read status updates from work
|
||||
metadata:
|
||||
display-name: Morning Status Report
|
||||
enabled: "true"
|
||||
---
|
||||
Always look for updates in 3 sources:
|
||||
1. Notion - Check the team updates page
|
||||
2. Linear - Look at assigned issues updated in the last 24 hours
|
||||
3. Slack - Check #team-updates and #engineering channels
|
||||
|
||||
Summarize everything in a single report grouped by source.
|
||||
```
|
||||
|
||||
The file uses YAML frontmatter for metadata and Markdown for the instructions.
|
||||
|
||||
### Frontmatter fields
|
||||
|
||||
| Field | Required | Description |
|
||||
|---|---|---|
|
||||
| `name` | Yes | Lowercase, hyphenated identifier (e.g., `morning-status-report`) |
|
||||
| `description` | Yes | When and how the agent should use this skill |
|
||||
| `license` | No | License for the skill |
|
||||
| `compatibility` | No | Environment requirements |
|
||||
| `metadata` | No | Extra fields like `display-name`, `enabled`, `version` |
|
||||
| `allowed-tools` | No | Restrict which tools the skill can use (experimental) |
|
||||
|
||||
### Supporting files
|
||||
|
||||
A skill can include additional directories alongside `SKILL.md`:
|
||||
|
||||
- **`scripts/`** for executable code the agent can run
|
||||
- **`references/`** for detailed documentation loaded on demand
|
||||
- **`assets/`** for templates, images, or data files
|
||||
|
||||
```
|
||||
morning-status-report/
|
||||
├── SKILL.md
|
||||
├── scripts/
|
||||
│ └── format-report.py
|
||||
└── references/
|
||||
└── REFERENCE.md
|
||||
```
|
||||
|
||||
The agent loads the main `SKILL.md` first. Supporting files are only loaded when the instructions reference them, keeping context usage efficient.
|
||||
|
||||
## Where Skills Live
|
||||
|
||||
Skills are stored as folders inside your BrowserOS configuration directory:
|
||||
|
||||
| OS | Path |
|
||||
|---|---|
|
||||
| macOS | `~/.browseros/skills/` |
|
||||
| Windows | `%USERPROFILE%\.browseros\skills\` |
|
||||
| Linux | `~/.browseros/skills/` |
|
||||
|
||||
Each skill gets its own folder named after the skill's `name` field.
|
||||
|
||||
## Tips for Writing Good Skills
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Be specific in descriptions" icon="crosshairs">
|
||||
Include keywords the agent can match against. "When the user asks about PDFs, forms, or document extraction" is better than "Helps with documents."
|
||||
</Card>
|
||||
<Card title="Keep instructions focused" icon="scissors">
|
||||
A skill should do one thing well. Split complex workflows into multiple skills rather than one large one.
|
||||
</Card>
|
||||
<Card title="Include examples" icon="lightbulb">
|
||||
Show the agent what good output looks like. Examples reduce ambiguity and improve results.
|
||||
</Card>
|
||||
<Card title="Use supporting files" icon="folder-tree">
|
||||
Move detailed references to separate files. The agent loads them only when needed, saving context space.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
<Note>
|
||||
Skills follow the open [Agent Skills specification](https://agentskills.io/specification). Skills you create in BrowserOS work with any agent that supports the standard.
|
||||
</Note>
|
||||
117
docs/features/smart-nudges.mdx
Normal file
117
docs/features/smart-nudges.mdx
Normal file
@@ -0,0 +1,117 @@
|
||||
---
|
||||
title: "Smart Nudges"
|
||||
description: "BrowserOS suggests app connections and task scheduling at the right moment"
|
||||
---
|
||||
|
||||
Smart Nudges are context-aware suggestions that appear as interactive cards during a conversation. The agent detects opportunities to connect an app or schedule a task, and shows you a card at the right moment. You decide whether to act on it or skip it.
|
||||
|
||||
There are two types of nudges: **App Connection** and **Schedule Suggestion**.
|
||||
|
||||
## App Connection
|
||||
|
||||
When you ask the agent to do something that involves an external app (like sending an email or checking your calendar), it checks whether that app is connected. If it is not, the agent shows a connection card before starting the task.
|
||||
|
||||
<Steps>
|
||||
<Step title="You make a request">
|
||||
For example: "Send Sarah an email with the meeting notes."
|
||||
</Step>
|
||||
<Step title="The agent detects an unconnected app">
|
||||
Gmail is not connected yet, so the agent cannot send emails through the integration.
|
||||
</Step>
|
||||
<Step title="A connection card appears">
|
||||
The card explains why connecting the app would help and gives you two choices: **Connect** or **Do it manually**.
|
||||
</Step>
|
||||
<Step title="You choose">
|
||||
- **Connect**: Opens a sign-in page for the app. Once you authorize, the agent continues with full integration access.
|
||||
- **Do it manually**: The agent skips the integration and uses browser automation instead (navigates to the website directly).
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
### What happens after you choose
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Connected" icon="circle-check">
|
||||
The app is added to your connected list. The agent uses the integration for this and all future conversations. You can manage connected apps in [Connect Apps](/features/connect-mcps).
|
||||
</Card>
|
||||
<Card title="Declined" icon="forward">
|
||||
The agent remembers your choice and will not ask about this app again. It uses browser automation to complete the task instead.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
<Tip>
|
||||
If you declined an app but change your mind later, you can connect it anytime from the [Connect Apps](/features/connect-mcps) settings page.
|
||||
</Tip>
|
||||
|
||||
### Supported apps
|
||||
|
||||
The agent can suggest connections for all 40+ built-in integrations, including Gmail, Google Calendar, Slack, Notion, GitHub, Linear, Jira, Figma, Salesforce, and many more. See [Connect Apps](/features/connect-mcps) for the full list.
|
||||
|
||||
## Schedule Suggestion
|
||||
|
||||
After the agent completes a task that could run on a recurring schedule, it shows a scheduling card. This helps you turn one-time tasks into automated routines without leaving the conversation.
|
||||
|
||||
<Steps>
|
||||
<Step title="The agent completes a task">
|
||||
For example: "Here are the top 5 tech headlines from today."
|
||||
</Step>
|
||||
<Step title="The agent recognizes a schedulable task">
|
||||
News gathering, price monitoring, report building, data tracking, and similar tasks that do not need your real-time input are good candidates.
|
||||
</Step>
|
||||
<Step title="A scheduling card appears">
|
||||
The card suggests a name and schedule. For example: "Run this automatically? 'Morning News Briefing' - daily at 09:00."
|
||||
</Step>
|
||||
<Step title="You choose">
|
||||
- **Schedule this task**: Opens the Scheduled Tasks page with the details pre-filled. Review and confirm to create the task.
|
||||
- **Maybe later**: Dismisses the card. You can always create the scheduled task manually later.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
### You can also ask directly
|
||||
|
||||
You do not have to wait for the agent to suggest it. Just tell the agent you want to schedule the task:
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Example prompts" icon="message">
|
||||
- "Schedule this to run every morning"
|
||||
- "Can this run daily at 8am?"
|
||||
- "Automate this task"
|
||||
- "Run this every hour"
|
||||
|
||||
The agent will infer the task name, schedule type, and timing from your conversation and show the scheduling card immediately.
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
### What gets scheduled
|
||||
|
||||
The scheduling card pre-fills the [Scheduled Tasks](/features/scheduled-tasks) dialog with:
|
||||
|
||||
- **Task name**: A short description based on the conversation
|
||||
- **Prompt**: The original query you asked the agent
|
||||
- **Schedule type**: Daily or hourly, based on what makes sense for the task
|
||||
- **Time**: A suggested time (for daily tasks)
|
||||
|
||||
You can adjust any of these before confirming.
|
||||
|
||||
## When Nudges Appear
|
||||
|
||||
Nudges are designed to appear at the right moment without interrupting your workflow:
|
||||
|
||||
| Nudge | When it appears | How often |
|
||||
|---|---|---|
|
||||
| App Connection | Before the agent starts working, when it detects an unconnected app | Once per app per conversation |
|
||||
| Schedule Suggestion | After the agent finishes a task that could be automated | Once per conversation |
|
||||
|
||||
Nudges do not appear in:
|
||||
- **Scheduled tasks** running in the background
|
||||
- **Chat mode** (read-only, no browser automation)
|
||||
|
||||
## Privacy
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Nothing is sent without your approval" icon="shield-check">
|
||||
The agent only suggests a connection. No data is shared with the app until you explicitly authorize it.
|
||||
</Card>
|
||||
<Card title="Your choices are remembered locally" icon="hard-drive">
|
||||
Declined apps are stored on your device. The agent will not ask about them again unless you reconnect from settings.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user