res README

项目的 README,来自 github.com/alextnetto/res。合并为一个 markdown 文件:README.md。

RES: Reverse Engineering SaaS

Turn a SaaS product into a build kit your team or your coding agent can ship.

Study a web product through the browser, document how it works, and hand off everything needed to rebuild and launch it, without touching production data.

test release Node.js 22+ license: MIT

Quick start · How RES works · What you get · Examples · Safety model · FAQ · Documentation

claude plugin marketplace add alextnetto/res

[!IMPORTANT] RES drives a real browser on accounts you control. Use it only on products you are allowed to study, read the safety model before the first run, and prefer a trial account in a separate browser profile.

RES studies a live product in a safe environment, writes a knowledge base with evidence, and hands it off as a zip for any coding agent

Want to rebuild a product your team relies on, or launch a competitor in your market? Ask your agent to study it with RES. The agent explores the product in a test environment, records every change it makes, and writes what it learns to files: screens and states, business rules with evidence, the data model, API shapes, design tokens, and what could stop the clone from launching, such as integrations that need approval, licenses and certifications.

At the end you get two files. REPORT.html is the report you read: one page that starts with the overview and the decisions you need to make, then walks through what the product does, every screen and rule, the data model and design, the build plan, and what to prepare before launch. The zip is for your coding agent: unzip it, give it the folder, and it starts from BUILD.md.

RES is one agent skill with plain Markdown templates and a few dependency-free Node.js scripts. It adds about 130 tokens to every session and about 4,600 when it runs (measured with claude plugin details).

Quick start

Install

In a terminal:

claude plugin marketplace add alextnetto/res
claude plugin install res@res

Inside a Claude Code session, the same commands are /plugin marketplace add alextnetto/res and /plugin install res@res. Start a new session afterwards.

For other agents that read skills from disk, copy the skill folder where your agent reads skills:

git clone https://github.com/alextnetto/res.git && mkdir -p ~/.claude/skills && cp -R res/skills/reverse-engineering-saas ~/.claude/skills/

You need Node.js 22 or later and an agent that can drive a browser and run JavaScript in the page: Claude in Chrome, Playwright MCP or Chrome DevTools MCP.

Prepare a safe environment

Create a trial account of the product with an email you own, log in to it in a separate Chrome profile, and connect your agent's browser tool to that profile (how). This is the safest setup: the agent cannot reach your production account even by mistake.

Without a trial account, the agent writes only if you ask it to test or to create a test environment, and then only inside a separate workspace or a sandbox container. Otherwise it only observes.

Ask your agent

Study Pipedrive so my team can rebuild it for the Brazilian market.
Use the trial profile, and don't ask me anything until you're done.

Replace the product, the market and the scope with your own. The agent creates re-<product>/ in its working directory, works through the phases below, and sends you REPORT.html and re-<product>-handoff-<date>.zip when it finishes. To continue later, start a session in the same directory and say "Continue the Pipedrive study."

Use the scripts directly

The scripts work without an agent, for example to inspect or repackage a knowledge base:

node skills/reverse-engineering-saas/scripts/init-kb.mjs --product "Acme CRM" --git
node skills/reverse-engineering-saas/scripts/check-kb.mjs re-acme-crm
node skills/reverse-engineering-saas/scripts/build-report.mjs re-acme-crm
node skills/reverse-engineering-saas/scripts/pack-kb.mjs re-acme-crm

Each script prints its options with --help.

Update

claude plugin marketplace update res
claude plugin update res@res

How RES works

flowchart LR
    A[Charter] --> B[Safe environment<br/>and preflight]
    B --> C[Public docs<br/>and barrier scan]
    C --> D[Map screens]
    D --> E[Deep dive<br/>one feature at a time]
    E -->|next feature| E
    E --> F[Synthesis:<br/>PRD, parity, barriers]
    F --> G[Close:<br/>report and zip]
Phase What happens
1 Charter Goal, scope, priorities and the clone's target market
2 Environment Pick the safest environment; check for automations, webhooks and integrations that could fire
3 Recon Public docs, API reference, pricing, integrations list and terms, read with web fetch; first barrier scan
4 Map Every screen and route; stack and design tokens
5 Deep dive One feature at a time: fixtures, states, rules, persistence, network, written to disk before the next feature
6 Synthesis Data model, design tokens, barriers, PRD, parity tests
7 Close Restore what changed, pass check-kb, send REPORT.html and the handoff zip

The knowledge base on disk is the agent's only memory, so a study can span many sessions and survive context limits. Every statement carries its evidence: [obs] seen in the product, [net] captured on the network, [doc] from public documentation, [inf] an inference with an open question.

What you get

Area What the knowledge base contains Where
Inventory Feature tree, screen catalog with URL patterns, a coverage matrix that works as the queue inventory/
UX Anatomy, states (empty, loading, error, no permission, plan-gated), interactions, keyboard, accessibility, microcopy screens/, components/
Behavior Business rules as Given/When/Then with evidence, user flows, cross-cutting topics rules/, flows/, topics/
Data Entities with fields, enums and relations, ER diagram, TypeScript types, permissions matrix data-model/
API Endpoint templates per user action, with JSON shapes and no values api/
Design Color, type, spacing, radius, shadow and motion tokens, mapped to the product's CSS variables design/
Production barriers Integrations that need approval, licenses, certifications, distribution gatekeepers and moats, with severity, market weight, lead time and mitigation clone/barriers.md
Build plan Requirements, parity tests derived from the rules, what to copy, avoid and improve clone/
Report REPORT.html: one self-contained page a person reads, with images embedded and every ID linked KB root
Handoff BUILD.md, a brief for any coding agent: read order, rules as tests, what not to copy zip root

A rule:

### R-014 Completing the last open activity prompts for the next one
- Given a deal with exactly one open activity
- When the user marks that activity done
- Then a "Schedule next activity" dialog opens; Cancel closes it and the deal shows a warning icon
- Evidence: [obs EV-031, EV-032]

A production barrier:

### BR-003 WhatsApp messages need Meta business verification
- Category: permissioned integration
- Blocks: F-014 (WhatsApp notifications)
- Gatekeeper: Meta, WhatsApp Business Platform
- Severity: blocks feature
- Market weight: required to sell
- Lead time and cost: [doc SRC-021]
- Mitigation: start verification in month one; launch with email notifications
- Evidence: [doc SRC-021]

Examples

Two end-to-end studies, run by Claude Code with Claude in Chrome without a person at the keyboard:

Product Environment Result Read
ClickUp: board, task view, custom fields L2, a new free workspace 55 rules, 19 components, 14 production barriers Report · Knowledge base
Pipedrive: pipeline, deals, next-activity rule, won and lost L3, a sandbox pipeline in a production account, removed at the end 46 rules, 8 components, 15 production barriers Report · Knowledge base

Each folder is the unzipped handoff. Notes on trademarks and terms: examples/README.md.

Safety model

Level Environment What the agent may change
L1 Trial account in a separate browser profile, created by you Everything except outbound and irreversible actions
L2 New, empty workspace under your login Test data and configuration inside that workspace
L3 One sandbox list, project or pipeline inside production Test data inside the container only
L4 Production, observe only Nothing

The full procedures are in references/safety.md.

RES and REA

REA is an open-source reverse engineering toolkit for binaries, Android, Electron, network captures and websites. It answers what a product is built with; RES answers how it works for the user and what it takes to rebuild and launch it. We ran both on ClickUp: docs/comparison-with-rea.md.

FAQ

Will it change my production data?

Only inside a sandbox you allowed. Every change is recorded in a ledger and, at the end, restored, removed, or listed for you to resolve. Without permission to write, it only observes. Messages, invites, mentions of other people and billing actions are forbidden at every level.

Does it need my password?

No. The agent never types passwords or creates accounts. You log in, preferably to a trial account in a separate browser profile.

Which agents and browsers work?

Any agent that reads skills from disk and can drive a browser and run JavaScript in the page. RES was written for Claude Code; the method was tested with Claude Code subagents and the page scripts in headless Chromium. Claude in Chrome, Playwright MCP and Chrome DevTools MCP are covered in references/tools.md.

Can I leave it running overnight?

Yes. Tell it not to ask you anything. It records what needs you under "Needs human" in STATUS.md, keeps working on the rest, and restores what it changed before it stops.

How do I give the result to my developers?

Ask for the handoff, or wait for the end of the study. The agent sends REPORT.html for people and a zip with the knowledge base and BUILD.md for coding agents. Account details (sandbox/, log/) stay out of the zip, except a copy of the change ledger without object IDs, locations or URLs.

Does it work for desktop or mobile apps?

Not well. It needs the DOM and the network. For binaries and Electron internals, use REA.

Is copying a product legal?

That depends on the product's terms and your jurisdiction. RES records the relevant terms clause, rebuilds from behavior instead of copying assets, and flags legal questions for counsel. It does not give legal advice.

Documentation

Status

Version 0.4.0. The method was tested with scenario runs on subagents, before and after each change to the skill, and the scripts with automated tests on Node.js 22 and 24. Two end-to-end studies on real products (ClickUp at L2, Pipedrive at L3) are in examples/. Version 0.3.0 fixes the gaps the Pipedrive study found; the ClickUp study's are tracked in an issue. Reports from real runs are welcome: open a study report.

Responsible use

Use RES only on accounts you own or are authorized to examine. Read the product's terms: many forbid reverse engineering or competing use, and that decision is yours. Rebuild from observed behavior; do not copy code, icons, illustrations, logos or long text. The barrier analysis is research, not legal advice.

Contributing

See CONTRIBUTING.md. Security problems go through SECURITY.md.

License

MIT

res (alextnetto/res)

正在搜索数据库…

310 ·GitHub
这是什么?RES 是一个 Claude Code 智能体技能。它通过浏览器研究一款 SaaS 产品,并把研究所得整理成知识库,用于重建和重新上线该产品,内容涵盖页面、业务规则、数据模型、设计 token 以及上线阻碍。
这是独立应用,还是我的智能体运行的东西?它不是独立应用。它是一个单独的智能体技能,由纯 Markdown 模板和几个无依赖的 Node.js 脚本组成,编程智能体加载后即可调用和驱动。
我该如何安装和运行 RES?将它作为 Claude Code 插件安装:运行 'claude plugin marketplace add alextnetto/res' 和 '/plugin install res@res',然后开启新会话,让智能体研究某个产品。其他能从磁盘读取技能的智能体,直接复制技能文件夹即可。
运行前我需要准备什么?需要 Node.js 22 或更高版本,以及一个能驱动浏览器并在页面上运行 JavaScript 的智能体,例如 Claude in Chrome、Playwright MCP 或 Chrome DevTools MCP。
它适用于所有类型的应用吗?不适用。它需要研究网页 DOM 和网络流量,因此对原生桌面或移动应用效果不佳。对于这类应用,作者的配套工具 REA 更适合用于二进制文件和 Electron 内部结构的分析。
把它用在我真实的 SaaS 账号上安全吗?RES 采用分级安全模型(从 L1 试用账号到 L4 生产环境仅观察)。智能体做出的每项更改都会记录到台账中,之后会被恢复或删除。它绝不会发送消息、操作账单、创建账号或输入密码。
研究结束后,我实际能得到什么?两份交付物:REPORT.html,一个独立完整的页面,涵盖页面、规则、数据模型、设计 token 和构建计划;以及一个交接压缩包,内含 BUILD.md,供编程智能体据此开始重建。
RES 与作者的 REA 项目有何不同?REA 是一套逆向工程工具包,针对二进制文件、Android、Electron 和网络抓包,用于揭示产品的技术构成;RES 则研究网页版 SaaS 产品对用户的实际表现,以及重建和上线该产品需要做什么。
以这种方式克隆产品合法吗?这取决于产品的服务条款和你所在的司法管辖区。RES 会记录相关的服务条款条目,并把法律问题标记出来供律师审阅,但它明确不提供法律建议。
这个技能每次会话的额外上下文开销是多少?仅安装该技能,每次会话就会额外增加约 130 个 token;实际运行一次研究时,约增加 4,600 个 token。这些数据是通过 'claude plugin details' 测得的。
大小
13.2 MB
星标
310
时长
1个月
提交 · 90 天