@hasna/connectors 0.0.5 → 0.1.0

package/README.md

@@ -1,6 +1,6 @@
 # Connectors
 
-Open source library of 62 TypeScript API connectors. Install any connector with a single command.
+Open source library of 63 TypeScript API connectors. Install any connector with a single command.
 
 ## Quick Start
 
@@ -13,6 +13,9 @@ npx @hasna/connectors install figma stripe github
 
 # List all available connectors
 npx @hasna/connectors list
+
+# Open the auth dashboard
+npx @hasna/connectors serve
 ```
 
 ## Installation
@@ -25,61 +28,77 @@ bun install -g @hasna/connectors
 npx @hasna/connectors
 ```
 
-## NPM Auth (Optional)
+## Usage
 
-If you need a scoped registry token (publish or private installs), copy an example file and set `NPM_TOKEN`:
+### Install Connectors
 
 ```bash
-# Repo root
-cp .npmrc.example .npmrc
-
-# Or per-connector
-cp connectors/connect-<name>/.npmrc.example connectors/connect-<name>/.npmrc
+connectors install figma stripe github   # Install connectors
+connectors install figma --overwrite     # Overwrite existing
+connectors remove figma                  # Remove a connector
 ```
 
-See `CONTRIBUTING.md` for publishing and secrets guidance.
+### Browse & Search
 
-## Usage
+```bash
+connectors                               # Interactive browser (TTY)
+connectors list                          # List all connectors
+connectors list --category "AI & ML"     # Filter by category
+connectors search payment                # Search connectors
+connectors info stripe                   # Connector details
+connectors docs gmail                    # Auth, env vars, CLI docs
+```
 
-### Interactive Mode
+### Dashboard
 
-Run without arguments to browse connectors by category:
+Start a local web dashboard to manage connector authentication:
 
 ```bash
-connectors
+connectors serve                         # http://localhost:19426
+connectors serve --port 3000             # Custom port
+connectors serve --no-open               # Don't auto-open browser
+connectors open                          # Open dashboard in browser
+connectors dashboard                     # Alias for serve
 ```
 
-### Install Connectors
+The dashboard shows all 63 connectors with:
+- Install status and auth type (OAuth, API Key, Bearer)
+- Configure API keys via dialog
+- Run OAuth flows for Google connectors
+- Monitor token expiry and refresh tokens
+- Light/dark theme, sorting, filtering, pagination
 
-```bash
-# Install one or more connectors
-connectors install figma stripe github
+### MCP Server (for AI Agents)
 
-# Connectors are installed to .connectors/ in your project
+```bash
+connectors-mcp                           # Start MCP server on stdio
 ```
 
-### Search
-
-```bash
-# Search by name, description, or tags
-connectors search payment
-connectors search ai
+Add to your MCP config:
+```json
+{
+  "mcpServers": {
+    "connectors": {
+      "command": "connectors-mcp"
+    }
+  }
+}
 ```
 
-### List by Category
+Tools: `search_connectors`, `list_connectors`, `connector_docs`, `connector_info`, `install_connector`, `remove_connector`, `list_installed`, `connector_auth_status`
 
-```bash
-connectors list --category "AI & ML"
-connectors list --category "Developer Tools"
-```
+### JSON Output (for scripts & agents)
 
-### Remove
+Every command supports `--json` for machine-readable output:
 
 ```bash
-connectors remove figma
+connectors list --json
+connectors search ai --json
+connectors info stripe --json
+connectors docs gmail --json
 ```
 
-## Available Connectors (62)
+## Available Connectors (63)
 
 ### AI & ML (12)
 | Connector | Description |
@@ -170,9 +189,10 @@ connectors remove figma
 | openweathermap | Weather data and forecasts |
 | brandsight | Brand monitoring |
 
-### Business Tools (3)
+### Business Tools (4)
 | Connector | Description |
 |-----------|-------------|
+| notion | Pages, databases, blocks, and property management |
 | quo | Business quotes and invoices |
 | tinker | Internal tooling |
 | sedo | Domain marketplace |