@hasna/connectors 1.3.10 → 1.3.11

package/README.md

@@ -1,377 +1,58 @@
-# Connectors
+# @hasna/connectors
 
-Open source library of 126 TypeScript API connectors. Set up any connector in 30 seconds.
+Open source connector library - Install API connectors with a single command
 
-## 30-Second Quickstart
+[![npm](https://img.shields.io/npm/v/@hasna/connectors)](https://www.npmjs.com/package/@hasna/connectors)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
 
-```bash
-# Install globally
-bun install -g @hasna/connectors
-
-# Set up a connector (install + auth in one step)
-connectors setup stripe --key sk_test_your_key_here
-
-# Use it immediately
-connectors run stripe products list
-connectors run stripe customers create --email "test@example.com"
-
-# Discover what any connector can do
-connectors ops stripe
-connectors ops gmail
-connectors ops anthropic
-```
-
-**That's it.** `setup` installs the connector and saves your API key. `run` executes any operation. `ops` shows what's available.
-
-## Quick Start (Alternative Methods)
-
-```bash
-# Interactive mode - browse and select connectors
-npx @hasna/connectors
-
-# Install specific connectors
-connectors install figma stripe github
-
-# List all 126 connectors
-connectors list
-
-# Open the auth dashboard
-connectors serve
-```
-
-## Installation
-
-```bash
-# Global install
-bun install -g @hasna/connectors
-
-# Or use npx (no install needed)
-npx @hasna/connectors
-```
-
-## Usage
-
-### Install Connectors
-
-```bash
-connectors install figma stripe github   # Install connectors
-connectors install --preset ai           # Install a preset bundle
-connectors install --category "AI & ML"  # Install entire category
-connectors install figma --overwrite     # Overwrite existing
-connectors remove figma                  # Remove a connector
-```
-
-### Browse & Search
+## Install
 
 ```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
-connectors status                        # Auth status of installed connectors
-connectors doctor                        # Health check and troubleshooting
-connectors test                          # Verify API keys with real requests
-connectors whoami                        # Show setup summary
-connectors env                           # Generate .env.example
-connectors presets                       # List preset bundles
-```
-
-### Dashboard
-
-Start a local web dashboard to manage connector authentication:
-
-```bash
-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
-```
-
-The dashboard shows all 126 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
-
-### MCP Server (for AI Agents)
-
-```bash
-connectors-mcp                           # Start MCP server on stdio
-```
-
-Add to your MCP config:
-```json
-{
-  "mcpServers": {
-    "connectors": {
-      "command": "connectors-mcp"
-    }
-  }
-}
-```
-
-Tools: `search_connectors`, `list_connectors`, `list_categories`, `connector_docs`, `connector_info`, `install_connector`, `remove_connector`, `list_installed`, `connector_auth_status`, `configure_auth`, `setup_connector`, `list_connector_operations`, `run_connector_operation`
-
-### Use Connectors (ops + run)
-
-```bash
-# Discover what a connector can do
-connectors ops stripe                    # List all operations
-connectors ops stripe products           # Detailed help for products
-
-# Execute any operation
-connectors run stripe products list --limit 5
-connectors run anthropic models
-connectors run gmail messages list --limit 10
-connectors run github repo list
-
-# One-step setup (install + auth + verify)
-connectors setup anthropic --key your-anthropic-api-key
-connectors setup stripe --key sk_test_your-key
+npm install -g @hasna/connectors
 ```
 
-### JSON Output (for scripts & agents)
-
-Every command supports `--json` for machine-readable output:
+## CLI Usage
 
 ```bash
-connectors list --json
-connectors search ai --json
-connectors info stripe --json
-connectors docs gmail --json
+connectors --help
 ```
 
-## Available Connectors (126)
-
-### AI & ML (12)
-| Connector | Description |
-|-----------|-------------|
-| anthropic | Claude AI models and API |
-| openai | GPT models, DALL-E, and Whisper |
-| xai | Grok AI models |
-| mistral | Mistral AI models |
-| googlegemini | Gemini AI models |
-| huggingface | ML models and datasets hub |
-| stabilityai | Stable Diffusion image generation |
-| midjourney | AI image generation |
-| heygen | AI video generation |
-| hedra | AI video generation |
-| elevenlabs | AI voice synthesis and cloning |
-| reducto | Document processing and extraction |
-
-### Developer Tools (9)
-| Connector | Description |
-|-----------|-------------|
-| github | Repositories, issues, PRs, and actions |
-| docker | Container management and registry |
-| sentry | Error tracking and monitoring |
-| cloudflare | DNS, CDN, and edge computing |
-| googlecloud | GCP services and APIs |
-| aws | Amazon Web Services |
-| e2b | Code interpreter sandboxes |
-| firecrawl | Web scraping and crawling |
-| shadcn | UI component registry |
-
-### Design & Content (4)
-| Connector | Description |
-|-----------|-------------|
-| figma | Design files, components, and comments |
-| webflow | Website builder and CMS |
-| wix | Website builder |
-| icons8 | Icons and illustrations |
-
-### Communication (6)
-| Connector | Description |
-|-----------|-------------|
-| gmail | Email sending and management |
-| discord | Messaging and communities |
-| twilio | SMS, voice, and messaging |
-| resend | Email API for developers |
-| zoom | Video meetings and webinars |
-| maropost | Email marketing automation |
-
-### Social Media (7)
-| Connector | Description |
-|-----------|-------------|
-| x | Posts, threads, and engagement |
-| reddit | Posts, comments, and subreddits |
-| substack | Newsletter publishing |
-| meta | Facebook and Instagram APIs |
-| snap | Snapchat marketing API |
-| tiktok | TikTok content and ads |
-| youtube | Videos, channels, and analytics |
-
-### Commerce & Finance (6)
-| Connector | Description |
-|-----------|-------------|
-| stripe | Payments, subscriptions, and billing |
-| stripeatlas | Company incorporation |
-| shopify | E-commerce platform |
-| revolut | Banking and payments |
-| mercury | Startup banking |
-| pandadoc | Document signing and proposals |
-
-### Google Workspace (8)
-| Connector | Description |
-|-----------|-------------|
-| google | Google OAuth and APIs |
-| googledrive | File storage and sharing |
-| googledocs | Document creation and editing |
-| googlesheets | Spreadsheets and data |
-| googlecalendar | Calendar and events |
-| googletasks | Task management |
-| googlecontacts | Contact management |
-| googlemaps | Maps, places, and directions |
-
-### Data & Analytics (4)
-| Connector | Description |
-|-----------|-------------|
-| exa | AI-powered web search |
-| mixpanel | Product analytics |
-| openweathermap | Weather data and forecasts |
-| brandsight | Brand monitoring |
-
-### Business Tools (4)
-| Connector | Description |
-|-----------|-------------|
-| notion | Pages, databases, blocks, and property management |
-| quo | Business quotes and invoices |
-| tinker | LLM fine-tuning and training API |
-| sedo | Domain marketplace |
+- `connectors install`
+- `connectors list`
+- `connectors search`
+- `connectors info`
+- `connectors docs`
+- `connectors remove`
+- `connectors categories`
+- `connectors auth`
+- `connectors doctor`
 
-### Patents & IP (1)
-| Connector | Description |
-|-----------|-------------|
-| uspto | US Patent and Trademark Office |
-
-### Advertising (1)
-| Connector | Description |
-|-----------|-------------|
-| xads | Twitter/X advertising |
-
-## Using Installed Connectors
-
-After installing, import from the `.connectors` directory:
-
-```typescript
-import { figma, stripe, github } from './.connectors';
-
-// Use the connectors
-const files = await figma.files.get('file-key');
-const customers = await stripe.customers.list();
-const repos = await github.repos.list();
-```
-
-Each connector provides:
-- TypeScript types
-- Multi-profile configuration
-- CLI tool
-- Programmatic API
-
-## Installing Individual Connectors
-
-You can also install connectors individually as npm packages:
+## MCP Server
 
 ```bash
-# Install individual connector packages
-bun install @hasna/connect-figma
-bun install @hasna/connect-stripe
-bun install @hasna/connect-anthropic
-```
-
-Then use them directly:
-
-```typescript
-import { Figma } from '@hasna/connect-figma';
-import { Stripe } from '@hasna/connect-stripe';
-import { Anthropic } from '@hasna/connect-anthropic';
-
-const figma = new Figma({ accessToken: 'xxx' });
-const stripe = new Stripe({ apiKey: 'sk_xxx' });
-const anthropic = new Anthropic({ apiKey: 'sk-ant-xxx' });
+connectors-mcp
 ```
 
-## Connector Structure
-
-Each connector follows a consistent structure:
-
-```
-connect-{name}/
-├── src/
-│   ├── api/           # API client modules
-│   ├── cli/           # CLI commands
-│   ├── types/         # TypeScript types
-│   └── utils/         # Configuration utilities
-├── CLAUDE.md          # Development guide
-├── AGENTS.md          # AI agent guide
-├── GEMINI.md          # Gemini guide
-├── README.md          # Usage documentation
-└── package.json
-```
-
-## Multi-Profile Configuration
-
-All connectors support multi-profile configuration:
+## REST API
 
 ```bash
-# Create profiles for different accounts
-connect-figma profile create work --api-key xxx --use
-connect-figma profile create personal --api-key yyy
-
-# Switch profiles
-connect-figma profile use work
-
-# Use profile for single command
-connect-figma -p personal files get <key>
-
-# List profiles
-connect-figma profile list
-```
-
-Configuration stored in `~/.connectors/{connector-name}/`:
-
-```
-~/.connectors/connect-figma/
-├── current_profile   # Active profile name
-└── profiles/
-    ├── default.json  # Default profile
-    └── {name}.json   # Named profiles
+connectors-serve
 ```
 
-## Development
+## Cloud Sync
 
-**Prerequisites:** [Bun](https://bun.sh/) >= 1.0.0
+This package supports cloud sync via `@hasna/cloud`:
 
 ```bash
-# Install all dependencies (dashboard deps are auto-installed via postinstall)
-bun install
-
-# Build everything (dashboard + CLI + MCP + serve)
-bun run build
-
-# Run CLI in development mode
-bun run dev
-
-# Type check the project
-bun run typecheck
-
-# Run the test suite
-bun test
+cloud setup
+cloud sync push --service connectors
+cloud sync pull --service connectors
 ```
 
-For more details on adding connectors and contributing, see [CONTRIBUTING.md](./CONTRIBUTING.md).
-
-## Contributing
+## Data Directory
 
-1. Fork the repository
-2. Create a new connector in `connectors/connect-{name}/`
-3. Follow the existing connector patterns
-4. Submit a pull request
+Data is stored in `~/.hasna/connectors/`.
 
 ## License
 
-Apache-2.0
+Apache-2.0 -- see [LICENSE](LICENSE)