lopebase 0.1.0 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jackalope Digital
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,28 +1,124 @@
-# lopebase
+<p align="center">
+  <a href="https://lopebase.com"><img src="https://lopebase.com/icon-512.png" width="72" height="72" alt="LopeBase"></a>
+</p>
 
-Set up a project in LopeBase from its own repo. Your coding agent does the steps
-and stops for you only when it has to. See ADR 0020.
+<h1 align="center">lopebase</h1>
+
+<p align="center">
+  Set up <a href="https://lopebase.com">LopeBase</a> from your project's own folder.<br>
+  Your coding agent does the steps. It stops for you only when it has to.
+</p>
+
+<p align="center">
+  <a href="https://lopebase.com">Website</a> ·
+  <a href="https://lopebase.com/agents">For agents</a> ·
+  <a href="https://lopebase.com/pricing">Pricing</a> ·
+  <a href="https://www.npmjs.com/package/@lopebase/adapter">@lopebase/adapter</a>
+</p>
+
+---
+
+LopeBase is one place to see and run all of your products: traffic, search,
+signups, revenue, and errors side by side, with a weekly summary and an agent
+that can help. This CLI connects a project to it in a few minutes.
+
+## Quick start
+
+In the folder of any project you run:
 
 ```sh
-npx lopebase          # scan, pick what to connect, hand off to your agent
-npx lopebase login    # connect this computer: approve a code in the browser
-npx lopebase scan     # what the scan found (--json for machines)
-npx lopebase prompt   # print the agent prompt instead of launching an agent
-npx lopebase mcp      # stdio MCP server that forwards to your workspace
+npx lopebase
 ```
 
-`login` uses the device flow: it shows a short code, opens your workspace, and
-waits while you press Connect. `login --paste` takes a token from Settings,
-Agent access instead, for workspaces that do not offer device sign-in.
+1. **Scan.** It reads your dependency names, config file names, and the
+   variable *names* in example env files, then shows your stack, the services
+   you already use, and what is missing (for example analytics or error
+   tracking). You see each thing it reads as it reads it.
+2. **Connect this computer.** It opens your LopeBase workspace and shows a
+   short code. Check it matches and press Connect.
+3. **Pick what to connect.** Services already in your code are ticked; the
+   ones you do not use yet are offered, never forced.
+4. **Hand over to your agent.** It finds the coding agents you have installed
+   (Claude Code, Codex, Gemini CLI, opencode, Cursor Agent), gives the one you
+   choose the LopeBase tools, and starts it with what the scan found. The agent
+   does the setup and asks you when it needs a sign-in, a key, or a decision.
+
+No agent installed? It prints the prompt for you to paste instead.
+
+It animates a little in an interactive terminal. `--no-motion` or
+`LOPEBASE_NO_MOTION=1` turns that off; CI and pipes never animate.
+
+## What it recognizes
+
+Made for web products, and fine with anything else:
+
+- **Frameworks:** Next.js, Astro, SvelteKit, Remix, React Router, Nuxt,
+  Gatsby, Docusaurus, Eleventy, Hugo, Jekyll, Angular, SolidStart, Qwik,
+  TanStack Start, Vue, React and Vite apps, plain static sites, Django, Flask,
+  FastAPI, Rails, Laravel, WordPress, Express, Fastify, NestJS, Hono, Expo, and
+  Electron.
+- **Languages:** JavaScript and TypeScript, Python, Ruby, PHP, Go, and Rust,
+  from their own manifests.
+- **Hosting, data, email, billing, and sign-in:** Cloudflare, Vercel, Netlify,
+  Fly.io, Render, Railway, Firebase, Amplify, Heroku, GitHub Pages, and Docker;
+  Supabase, Convex, Neon, Postgres, MySQL, MongoDB, D1, Prisma, Drizzle, and
+  more; Resend, Sequenzy, SendGrid, Postmark; Stripe, Polar, Lemon Squeezy,
+  Paddle; Clerk, WorkOS, Better Auth, Auth.js, and others.
+- **Ready to connect to LopeBase:** PostHog, Google Analytics, Sentry, Stripe,
+  Polar, Supabase, Resend, Sequenzy, and GitHub when your code uses them; plus
+  Search Console, Bing, and an uptime check for any website.
+- **Your site's address**, from `homepage`, wrangler routes, `CNAME`, a
+  framework config (`site`, `siteUrl`, `baseURL`), or the canonical tag in
+  `index.html`. **Your GitHub repo**, from the git remote.
+
+## Commands
+
+| Command | What it does |
+| --- | --- |
+| `npx lopebase` | Scan, connect, choose, and hand over to your agent. |
+| `npx lopebase login` | Connect this computer to your workspace with a short code. `--paste` to paste an agent token instead. |
+| `npx lopebase scan` | Show what the scan found. `--json` for scripts. |
+| `npx lopebase prompt` | Print the setup prompt instead of starting an agent. |
+| `npx lopebase mcp` | Run the LopeBase tools as a local MCP server (stdio) for any agent. |
+| `npx lopebase adapter secret` | Print a new signing secret for [@lopebase/adapter](https://www.npmjs.com/package/@lopebase/adapter). Pipe it straight into your secret store. |
+| `npx lopebase adapter check <url>` | Test a running adapter, local or deployed, before you connect it. |
+
+## What it reads, and what it keeps
+
+- **Reads:** `package.json` files (and `requirements.txt`, `pyproject.toml`,
+  `Gemfile`, `composer.json`, `go.mod`, `Cargo.toml`) at the root, in your
+  workspace folders, and in `apps/`, `packages/`, and similar folders; config
+  file names such as `wrangler.toml` or `vercel.json`; the site address in a
+  few config files; your git remote's address; and the variable names in
+  `.env.example` style files.
+- **Never reads** a real `.env` file, and never sends a value anywhere. Only
+  names leave your machine, and only to your own workspace.
+- **Keeps** one thing: an agent token in `~/.config/lopebase/auth.json`,
+  readable only by you. It lasts 30 days, acts as the workspace admin who
+  approved it, is limited to what that admin allowed, and can be revoked any
+  time under Settings, Agent access.
+- `LOPEBASE_TOKEN` and `LOPEBASE_URL` override the saved values, for CI or
+  another machine.
+
+## Use it with any agent
+
+`npx lopebase` sets this up for you. To add the tools by hand, register this
+as a stdio MCP server in your agent:
+
+```sh
+npx -y lopebase mcp
+```
+
+Or point an agent that supports remote MCP straight at your workspace, for
+example `https://yourteam.lopebase.com/api/mcp`. It will ask you to sign in.
+
+## Requirements
+
+Node 18 or newer. Works on macOS, Linux, and Windows.
 
-From this monorepo: `bun run lopebase` (from the repo root). To publish:
-`bun run build` makes `dist/lopebase.js` for Node, and `npm publish` runs
-verify and build first.
+## Help
 
-The scan reads package.json files, config file names, and env var names from
-example env files. It never reads a real `.env` file and never sends a value.
-The token is saved to `~/.config/lopebase/auth.json` (mode 600), or read from
-`LOPEBASE_TOKEN` and `LOPEBASE_URL`.
+Questions or problems: [contact@jackalope.digital](mailto:contact@jackalope.digital).
+Privacy: [app.lopebase.com/legal/privacy](https://app.lopebase.com/legal/privacy).
 
-`src/detect.ts` is also imported by the backoffice's `detect_stack` tool, so the
-terminal and the server give the same answer.
+LopeBase is made by [Jackalope Digital](https://jackalope.digital).