snapfail 0.0.15 → 0.0.17

package/README.md

@@ -1,78 +1,33 @@
 # snapfail
 
-> **The official Command Line Interface (CLI) to automatically initialize and configure SnapFail error-tracking.**
+CLI for [snapfail](https://snapfail.com) — automatic error capture and AI diagnostics for your web app.
 
-[![npm version](https://img.shields.io/npm/v/snapfail.svg)](https://www.npmjs.com/package/snapfail)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-**SnapFail CLI** is a terminal-based onboarding utility that automatically configures and integrates SnapFail error tracking and session replays inside your Vite and Astro codebases in seconds.
-
-Visit the live telemetry dashboard at [app.snapfail.com](https://app.snapfail.com).
-
----
-
-## Getting Started
-
-You do not need to install the CLI permanently. You can run it on-demand using standard Node `npx`:
+## Install
 
 ```bash
-npx snapfail init
-```
-
-Or, if you prefer, install it globally on your system:
-
-```bash
-# npm
 npm install -g snapfail
-
-# pnpm
-pnpm add -g snapfail
-
-# Bun
+# or
 bun add -g snapfail
 ```
 
-Once installed globally, you can invoke the CLI with:
+## Usage
+
 ```bash
+# Set up snapfail in your project (one time)
 snapfail init
-```
-
----
-
-## Interactive Onboarding Flow
-
-Running `snapfail init` initiates a guided terminal onboarding experience:
-
-1. **Dashboard Authentication:** Automatically opens your default web browser to [app.snapfail.com/cli-auth](https://app.snapfail.com/cli-auth), securely performing a local CORS-approved handshake to authorize your CLI session.
-2. **Project Selection:** Fetches your existing projects from the SnapFail dashboard, allowing you to select one or instantly create a new one right from the terminal.
-3. **Session Replay Setup:** Prompts whether you want to enable **rrweb Session Replays** (enables full 60-second DOM playback video captures of browser crashes).
-4. **Codebase Inspection:** Detects your project's build tool configuration:
-   * **Astro Project:** Locates `astro.config.mjs` / `astro.config.ts`, automatically installs `@snapfail/sdk` using your project's active package manager (`npm`, `pnpm`, `yarn`, or `bun`), and safely injects the `snapfail` integration.
-   * **Vite Project:** Locates `vite.config.js` / `vite.config.ts`, automatically installs `@snapfail/sdk`, and injects the `snapfail` Vite plugin.
-   * **Vanilla HTML:** Provides a ready-to-copy custom CDN `<script>` tag snippet pre-configured with your project's API Key and the new `sdk.js` loader.
 
----
+# View unresolved incidents
+snapfail incidents
 
-## CLI Options
+# View incident detail
+snapfail incident <id>
 
-```bash
-# Show help and commands list
-npx snapfail --help
-
-# Initialize integration in the current directory
-npx snapfail init
+# Get AI diagnosis
+snapfail explain <id>
 ```
 
----
-
-## Advanced Detection Features
-
-* 📦 **Dynamic Package Manager Detection:** The CLI automatically inspects lockfiles (`package-lock.json`, `pnpm-lock.yaml`, `bun.lock`, `yarn.lock`) to run the correct installation command natively in your project.
-* 🔐 **Secure Handshake:** The CLI launches a temporary local secure server on port `4321` or random fallback, using full cross-origin headers to safely receive authorization tokens back from the dashboard browser.
-* ⚡ **Node.js Native:** Executable binary runs natively in standard Node.js without requiring third-party runtime dependencies (like Bun or ts-node).
-
----
+`snapfail init` detects your framework, authenticates, lets you pick or create a project, writes `SNAPFAIL_PROJECT_KEY` to `.env`, and injects the browser SDK into your config automatically.
 
-## License
+## Documentation
 
-MIT © [SnapFail Protocol](https://app.snapfail.com)
+Full docs at [snapfail.com](https://snapfail.com)