Skip to content

user-w-ui/search-before-build

v0.4.0MIT

A plain-language pre-build reality check and evidence-backed alternative research toolkit for vibe coders.

Search Before Build

Before you start vibe coding, make sure the idea is actually worth building.

A pre-build research plugin for Claude Code, Codex, OpenCode, and other agents that load skills: clarify your real needs, discover and aggregate similar projects and alternatives across platforms, and get a clear recommendation before you start building—use an existing tool, adapt a close match, or build from scratch.

npm Codex Claude Code License

English | 简体中文


Why does this exist?

Vibe coding has made the distance between “I have an idea” and “I’m writing code” incredibly short. That feels great, but it also makes it easy to build an entire system for a one-off problem, discover a mature product halfway through, reinvent the wheel, or spend a huge number of tokens on a project you will never use.

search-before-build is not here to discourage ideas. It simply asks you to pause for a few minutes before starting and answer three questions:

  1. What are you actually trying to solve?
  2. Does this really need to be built?
  3. Is there an existing solution you can use or adapt?

How does it work?

A vague idea
     │
     ▼
Clarify the real problem ──→ Decide whether it is worth building ──→ Find and verify existing solutions
                                                                                  │
                                                                                  ▼
                                                             Build / Adapt / Use existing / Stop

It ends with a clear recommendation that you remain free to override:

RecommendationMeaning
BuildThe need is real, and existing solutions do not cover the critical gap
AdaptA close solution already exists, and modifying it makes more sense than starting from scratch
Use existingA mature solution already addresses the main problem, so using it is the better trade-off
StopEvidence for the need is weak, or the cost of building clearly outweighs the benefit

Two skills

SkillBest forWhat it does
assessA full check of whether an idea is worth building, or finding competitors and references for existing workReads whatever you supply first (repository, docs, screenshots), asks only about what is still missing (one question at a time, up to five), confirms its understanding, then researches and recommends a direction with a full brief
quick-searchA fast "does something like this already exist?" checkAsks nothing unless it must, checks a few relevant sources, and answers in the chat with up to five candidates and a clearly marked preliminary view
/search-before-build:assess I want to build a tool that automatically organizes saved content
/search-before-build:assess ./docs/plan.md
/search-before-build:quick-search a CLI that converts OpenAPI specs to TypeScript clients

More than GitHub search

The plugin first determines what it needs to find, then chooses where to look. It extracts a functional fingerprint from your needs and searches only relevant sources instead of scanning every platform every time.

What you are looking forPreferred source
Open-source repositories, source code, or reusable implementationsGitHub
JavaScript / Node.js dependencies, CLIs, or pluginsnpm
Python libraries or tools (exact package names)PyPI
Cross-ecosystem package metadata and maintenance signalsEcosyste.ms Packages
MCP tools or connectors for agentsOfficial MCP Registry
JVM dependencies (Java / Kotlin / Android)Maven Central
Rust cratescrates.io
Models, datasets, or reusable AI applicationsHugging Face Hub
Algorithms, papers, or academic precedentsarXiv

For SaaS products, commercial tools, app-store listings, and other solutions outside those catalogs, it supplements the research with web search and official product pages. When the target market is unclear, it searches in both Chinese and English. Stars and download counts help assess maturity, but never replace functional matching.

Optional in-depth GitHub search

The plugin looks for your GitHub tools automatically; without them it still works through public APIs and web search. If you agree, assess can also install GitHub’s official MCP server automatically on Claude Code and Codex:

Enable in-depth GitHub search

The installer downloads and verifies the official binary, then runs it with the repos toolset in --read-only mode, signing in through browser-based OAuth that requests no extra permission scopes. GitHub keeps that sign-in in memory only, so each new Agent session briefly opens GitHub in the browser on its first search; after the first approval this usually needs no extra clicks.

Temporary research brief

After research, assess renders a local visual HTML brief containing the final recommendation, search coverage, capability matrix, strongest candidates, reusable lessons, and unknowns. The page is a self-contained offline file with no CDN dependency. It is written to the OS temporary directory, so a casual question does not leave reports in the current project.

Read a research brief in three steps

Explore a live report

1. Start with the decision

Turn the real need, strongest evidence, and remaining unknowns into one clear recommendation before development begins.

The English Search Before Build brief showing a Use existing recommendation, strongest reuse option, and biggest unknown

2. Inspect the capability matrix

Compare only decision-relevant capabilities with consistent support labels. Missing evidence stays unverified instead of becoming unsupported.

The English Search Before Build capability matrix comparing the proposed idea with several candidate solutions

3. Examine each candidate

Review adoption cost, material constraints, reusable designs, and traceable primary sources for every strong candidate.

The English Search Before Build candidate analysis showing project comparison, reusable lessons, and summary

Every competitor has Save Markdown and Copy Markdown actions. A long-lived report is created only when you choose to export it after reviewing the result, or explicitly ask the plugin to persist a selected competitor:

docs/search-before-build/<topic>/<competitor>.md

Persisted reports remain one file per competitor and contain only the overview, comparison with the current project, notable designs, reusable lessons, one-sentence summary, and sources. They exclude the necessity check and final verdict.

Installation and usage

Let your agent install it

Send this to the agent you use (Claude Code, Codex, OpenCode, Pi, and others):

Read https://raw.githubusercontent.com/user-w-ui/search-before-build/main/INSTALL.md and follow it to install Search Before Build.

Or install it yourself:

Codex (one command)

npx @superq/search-before-build install

Codex (development install, tracks main)

codex plugin marketplace add user-w-ui/search-before-build --ref main
codex plugin add search-before-build@search-before-build

Claude Code (marketplace)

/plugin marketplace add user-w-ui/search-before-build
/plugin install search-before-build@search-before-build

After installation, use /search-before-build:assess or /search-before-build:quick-search. Update it with /plugin marketplace update search-before-build.

OpenCode (v2 or later)

opencode plugin add github:user-w-ui/search-before-build

OpenCode attaches skills with @ rather than /, for example @search-before-build-assess I want to build a tool that automatically organizes saved content.

Pi

pi install git:github.com/user-w-ui/search-before-build

Cursor, GitHub Copilot, VS Code, and other Agent Plugins clients

The repository root carries an Agent Plugins plugin.json, so clients that support the format can install the repository directly.

Automatic GitHub MCP installation is available only on Claude Code and Codex; on other hosts the skills reuse any GitHub tool you already have, or fall back to public APIs and web search.

Validate the plugin

npm test
npm run benchmark:offline
claude plugin validate --strict .
python tests/validate_plugin.py

Benchmark

We ran a paired, real-scenario comparison: 12 tasks (9 "should I build this" ideas + 3 evaluations of existing projects), each executed twice — once with a bare agent, once with the plugin loaded — across Claude Code and Codex. Full data and methodology: bench/results/SUMMARY.md.

Acknowledgements

  • WebVector — design reference for the retrieval pipeline and rank fusion
  • pi-web-access — an early example of packaging web access for a coding agent

Contributing

Issues and pull requests are welcome, especially for commonly overlooked search platforms, false matches between similarly named but functionally different products, reuse cases that save meaningful time or tokens, and wording that is still too difficult for non-technical users.


Think twice. Build once.