insim-cli 1.0.0__tar.gz

insim_cli-1.0.0/PKG-INFO

@@ -0,0 +1,263 @@
+Metadata-Version: 2.4
+Name: insim-cli
+Version: 1.0.0
+Summary: inSIM CLI — Control your SMS, contacts and campaigns from the command line. Built for AI agents and humans alike.
+Home-page: https://github.com/ArdaryinSIM/insim-cli
+Author: Reach Technologies SAS
+Author-email: dev@reach-technologies.com
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Topic :: Communications :: Telephony
+Classifier: Topic :: Office/Business
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.0.0
+Requires-Dist: requests>=2.28.0
+Requires-Dist: prompt-toolkit>=3.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# insim-cli
+
+**Control your SMS, contacts, and campaigns from the command line.**
+
+[![PyPI version](https://img.shields.io/pypi/v/insim-cli.svg)](https://pypi.org/project/insim-cli/)
+[![Python](https://img.shields.io/pypi/pyversions/insim-cli.svg)](https://pypi.org/project/insim-cli/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+---
+
+## Why insim-cli?
+
+**Stop switching between tabs.** Manage your entire SMS business from your terminal.
+
+- **Send SMS in seconds** — one command, done. No login pages, no clicks.
+- **AI-ready** — Claude, GPT, Gemini, and any LLM can pilot inSIM with structured JSON output.
+- **Automate your campaigns** — create lists, compose messages, and launch campaigns programmatically.
+- **Track everything** — call logs, delivery reports, click tracking, all at your fingertips.
+- **Works everywhere** — macOS, Linux, Windows. Any terminal. Any automation tool.
+
+## Quick Start (2 minutes)
+
+### 1. Install
+
+```bash
+pip install insim-cli
+```
+
+### 2. Login
+
+```bash
+insim login your@email.com --key YOUR_ACCESS_KEY
+```
+
+Your access key is in your inSIM account settings, under API.
+
+### 3. Start using
+
+```bash
+# Find a contact
+insim contacts search "John Doe"
+
+# Send an SMS
+insim sms send "+33612345678" "Hello from the command line!"
+
+# Check your stats
+insim stats overview
+```
+
+That's it. You're ready.
+
+---
+
+## What can you do?
+
+### Send SMS
+
+```bash
+# Simple message
+insim sms send "+33612345678" "Meeting confirmed for tomorrow at 10am"
+
+# With link tracking
+insim sms send "+33612345678" "Check our offer: [link]" --url "https://your-site.com/promo"
+```
+
+### Manage Contacts
+
+```bash
+# Smart search (handles typos, inversions, accents)
+insim contacts search "cecile dubois"
+
+# Find by phone number
+insim contacts find-phone "0612345678"
+
+# Tag contacts for segmentation
+insim contacts tags-add CONTACT_ID vip premium
+```
+
+### Launch Campaigns
+
+```bash
+# Create a list with all your contacts
+insim lists create "Spring Promo"
+insim lists add-all LIST_ID
+
+# Create and launch a campaign
+insim campaigns create --name "Spring Promo" --message "20% off this week!" --list LIST_ID
+insim campaigns start CAMPAIGN_ID
+```
+
+### Track Calls
+
+```bash
+# See missed calls
+insim calls list --type missed
+
+# Qualify a call
+insim calls qualify CALL_ID --option OPTION_ID --notes "Interested in premium plan"
+```
+
+### View Statistics
+
+```bash
+# Global overview
+insim stats overview
+
+# SMS sent this month
+insim stats overview --from "2026-04-01"
+```
+
+---
+
+## For AI Agents
+
+insim-cli is designed to be used by AI coding agents like **Claude Code**, **GitHub Copilot**, **Cursor**, and others.
+
+### Setup for agents
+
+```bash
+export INSIM_LOGIN="your@email.com"
+export INSIM_ACCESS_KEY="your_access_key"
+```
+
+### JSON output
+
+Add `--json` to any command for machine-readable output:
+
+```bash
+insim --json contacts search "john doe"
+insim --json sms list --limit 5
+insim --json account info
+```
+
+### AI workflow example
+
+An agent receiving "send a message to John saying meeting is confirmed":
+
+```bash
+# Step 1: Find the contact
+insim --json contacts search "john"
+# → {"contacts": [{"phone_number": "+33612345678", "score": 100}]}
+
+# Step 2: Send the SMS
+insim sms send "+33612345678" "Meeting is confirmed"
+# → SMS sent successfully!
+```
+
+### SKILL.md
+
+The package includes a comprehensive `SKILL.md` file with **25 detailed workflows** that any AI agent can read to understand exactly how to use every feature of insim-cli. The REPL mode displays the path to this file on startup.
+
+---
+
+## Interactive Mode (REPL)
+
+Run `insim` without arguments for an interactive session with **auto-completion** and **command history**:
+
+```
+$ insim
+SKILL.md: /path/to/skills/SKILL.md
+inSIM CLI — Interactive Mode
+Type commands without 'insim' prefix. Type 'help' or 'exit'.
+
+insim> contacts search "mourad"
+insim> sms send "+33664456336" "Hello!"
+insim> stats overview
+insim> exit
+```
+
+---
+
+## All Commands
+
+| Group | Commands |
+|-------|----------|
+| **Auth** | `login`, `logout`, `whoami` |
+| **Contacts** | `list`, `search`, `find-phone`, `detail`, `switch-pro`, `delete`, `tags-add`, `tags-remove`, `custom-fields` |
+| **SMS** | `list`, `detail`, `conversation`, `send` |
+| **Calls** | `list`, `qualify`, `clictocall` |
+| **Qualifications** | `list`, `options`, `options-create`, `options-update`, `options-delete`, `stats` |
+| **Account** | `info`, `webhooks-set` |
+| **Lists** | `list`, `create`, `detail`, `update`, `delete`, `add-contacts`, `remove-contacts`, `add-all` |
+| **Campaigns** | `list`, `create`, `detail`, `cancel`, `start` |
+| **Templates** | `list`, `create`, `update`, `delete`, `send` |
+| **Stats** | `overview`, `clicks` |
+
+Run `insim COMMAND --help` for details on any command.
+
+---
+
+## Configuration
+
+| Method | Priority | Description |
+|--------|----------|-------------|
+| Environment variables | Highest | `INSIM_LOGIN`, `INSIM_ACCESS_KEY` |
+| Credentials file | Lower | `~/.insim/credentials.json` (created by `insim login`) |
+
+Custom server URL:
+```bash
+export INSIM_BASE_URL="https://custom-server.com"
+```
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/ArdaryinSIM/insim-cli.git
+cd insim-cli
+pip install -e ".[dev]"
+pytest tests/ -v
+```
+
+---
+
+## About inSIM
+
+[inSIM](https://insim.app) is a SaaS platform for SMS management, CRM, and marketing campaigns. It connects to your phone via a mobile app and lets you send, receive, and track SMS from your computer.
+
+**insim-cli** is the official command-line interface, built by [Reach Technologies SAS](https://reach-technologies.com).
+
+---
+
+## License
+
+MIT

insim_cli-1.0.0/cli_anything/insim/README.md

@@ -0,0 +1,226 @@
+# insim-cli
+
+**Control your SMS, contacts, and campaigns from the command line.**
+
+[![PyPI version](https://img.shields.io/pypi/v/insim-cli.svg)](https://pypi.org/project/insim-cli/)
+[![Python](https://img.shields.io/pypi/pyversions/insim-cli.svg)](https://pypi.org/project/insim-cli/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+---
+
+## Why insim-cli?
+
+**Stop switching between tabs.** Manage your entire SMS business from your terminal.
+
+- **Send SMS in seconds** — one command, done. No login pages, no clicks.
+- **AI-ready** — Claude, GPT, Gemini, and any LLM can pilot inSIM with structured JSON output.
+- **Automate your campaigns** — create lists, compose messages, and launch campaigns programmatically.
+- **Track everything** — call logs, delivery reports, click tracking, all at your fingertips.
+- **Works everywhere** — macOS, Linux, Windows. Any terminal. Any automation tool.
+
+## Quick Start (2 minutes)
+
+### 1. Install
+
+```bash
+pip install insim-cli
+```
+
+### 2. Login
+
+```bash
+insim login your@email.com --key YOUR_ACCESS_KEY
+```
+
+Your access key is in your inSIM account settings, under API.
+
+### 3. Start using
+
+```bash
+# Find a contact
+insim contacts search "John Doe"
+
+# Send an SMS
+insim sms send "+33612345678" "Hello from the command line!"
+
+# Check your stats
+insim stats overview
+```
+
+That's it. You're ready.
+
+---
+
+## What can you do?
+
+### Send SMS
+
+```bash
+# Simple message
+insim sms send "+33612345678" "Meeting confirmed for tomorrow at 10am"
+
+# With link tracking
+insim sms send "+33612345678" "Check our offer: [link]" --url "https://your-site.com/promo"
+```
+
+### Manage Contacts
+
+```bash
+# Smart search (handles typos, inversions, accents)
+insim contacts search "cecile dubois"
+
+# Find by phone number
+insim contacts find-phone "0612345678"
+
+# Tag contacts for segmentation
+insim contacts tags-add CONTACT_ID vip premium
+```
+
+### Launch Campaigns
+
+```bash
+# Create a list with all your contacts
+insim lists create "Spring Promo"
+insim lists add-all LIST_ID
+
+# Create and launch a campaign
+insim campaigns create --name "Spring Promo" --message "20% off this week!" --list LIST_ID
+insim campaigns start CAMPAIGN_ID
+```
+
+### Track Calls
+
+```bash
+# See missed calls
+insim calls list --type missed
+
+# Qualify a call
+insim calls qualify CALL_ID --option OPTION_ID --notes "Interested in premium plan"
+```
+
+### View Statistics
+
+```bash
+# Global overview
+insim stats overview
+
+# SMS sent this month
+insim stats overview --from "2026-04-01"
+```
+
+---
+
+## For AI Agents
+
+insim-cli is designed to be used by AI coding agents like **Claude Code**, **GitHub Copilot**, **Cursor**, and others.
+
+### Setup for agents
+
+```bash
+export INSIM_LOGIN="your@email.com"
+export INSIM_ACCESS_KEY="your_access_key"
+```
+
+### JSON output
+
+Add `--json` to any command for machine-readable output:
+
+```bash
+insim --json contacts search "john doe"
+insim --json sms list --limit 5
+insim --json account info
+```
+
+### AI workflow example
+
+An agent receiving "send a message to John saying meeting is confirmed":
+
+```bash
+# Step 1: Find the contact
+insim --json contacts search "john"
+# → {"contacts": [{"phone_number": "+33612345678", "score": 100}]}
+
+# Step 2: Send the SMS
+insim sms send "+33612345678" "Meeting is confirmed"
+# → SMS sent successfully!
+```
+
+### SKILL.md
+
+The package includes a comprehensive `SKILL.md` file with **25 detailed workflows** that any AI agent can read to understand exactly how to use every feature of insim-cli. The REPL mode displays the path to this file on startup.
+
+---
+
+## Interactive Mode (REPL)
+
+Run `insim` without arguments for an interactive session with **auto-completion** and **command history**:
+
+```
+$ insim
+SKILL.md: /path/to/skills/SKILL.md
+inSIM CLI — Interactive Mode
+Type commands without 'insim' prefix. Type 'help' or 'exit'.
+
+insim> contacts search "mourad"
+insim> sms send "+33664456336" "Hello!"
+insim> stats overview
+insim> exit
+```
+
+---
+
+## All Commands
+
+| Group | Commands |
+|-------|----------|
+| **Auth** | `login`, `logout`, `whoami` |
+| **Contacts** | `list`, `search`, `find-phone`, `detail`, `switch-pro`, `delete`, `tags-add`, `tags-remove`, `custom-fields` |
+| **SMS** | `list`, `detail`, `conversation`, `send` |
+| **Calls** | `list`, `qualify`, `clictocall` |
+| **Qualifications** | `list`, `options`, `options-create`, `options-update`, `options-delete`, `stats` |
+| **Account** | `info`, `webhooks-set` |
+| **Lists** | `list`, `create`, `detail`, `update`, `delete`, `add-contacts`, `remove-contacts`, `add-all` |
+| **Campaigns** | `list`, `create`, `detail`, `cancel`, `start` |
+| **Templates** | `list`, `create`, `update`, `delete`, `send` |
+| **Stats** | `overview`, `clicks` |
+
+Run `insim COMMAND --help` for details on any command.
+
+---
+
+## Configuration
+
+| Method | Priority | Description |
+|--------|----------|-------------|
+| Environment variables | Highest | `INSIM_LOGIN`, `INSIM_ACCESS_KEY` |
+| Credentials file | Lower | `~/.insim/credentials.json` (created by `insim login`) |
+
+Custom server URL:
+```bash
+export INSIM_BASE_URL="https://custom-server.com"
+```
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/ArdaryinSIM/insim-cli.git
+cd insim-cli
+pip install -e ".[dev]"
+pytest tests/ -v
+```
+
+---
+
+## About inSIM
+
+[inSIM](https://insim.app) is a SaaS platform for SMS management, CRM, and marketing campaigns. It connects to your phone via a mobile app and lets you send, receive, and track SMS from your computer.
+
+**insim-cli** is the official command-line interface, built by [Reach Technologies SAS](https://reach-technologies.com).
+
+---
+
+## License
+
+MIT

insim_cli-1.0.0/cli_anything/insim/__init__.py

@@ -0,0 +1,2 @@
+"""inSIM CLI — Control your SMS, contacts and campaigns from the command line."""
+__version__ = "1.0.0"

insim_cli-1.0.0/cli_anything/insim/core/account.py

@@ -0,0 +1,67 @@
+"""Account info and configuration."""
+import click
+from cli_anything.insim.core.api import InsimAPIError
+from cli_anything.insim.core.auth import require_auth
+from cli_anything.insim.utils.output import output, print_error
+
+
+@click.group()
+def account():
+    """Account info and configuration."""
+    pass
+
+
+@account.command("info")
+def account_info():
+    """Show account information: login, plan, credits, options."""
+    ctx = click.get_current_context()
+    json_mode = ctx.obj.get("json", False) if ctx.obj else False
+    try:
+        api = require_auth()
+        result = api.post("/api/v2/account")
+        if json_mode:
+            output(result, json_mode=True)
+        else:
+            acct = result.get("account", {})
+            click.echo(click.style("Account Information", bold=True))
+            click.echo(f"  {click.style('Login', fg='cyan')}: {acct.get('login', '')}")
+            click.echo(f"  {click.style('Plan', fg='cyan')}: {acct.get('plan', '')}")
+            click.echo(f"  {click.style('Credits', fg='cyan')}: {acct.get('credits', '')}")
+            options = acct.get("options", {})
+            if options:
+                click.echo(f"  {click.style('Options', fg='cyan')}:")
+                for key, val in options.items():
+                    click.echo(f"    {key}: {val}")
+    except InsimAPIError as e:
+        print_error(e.error_code, str(e), e.field, e.extra)
+        raise SystemExit(1)
+
+
+@account.command("webhooks-set")
+@click.option("--sms", default="", help="Incoming SMS webhook URL.")
+@click.option("--dlr", default="", help="Delivery status webhook URL.")
+@click.option("--clicks", default="", help="Link clicks webhook URL.")
+@click.option("--calls", default="", help="Call events webhook URL.")
+@click.option("--qualif", default="", help="Call qualifications webhook URL.")
+def account_webhooks_set(sms, dlr, clicks, calls, qualif):
+    """Set account webhook URLs."""
+    ctx = click.get_current_context()
+    json_mode = ctx.obj.get("json", False) if ctx.obj else False
+    try:
+        api = require_auth()
+        result = api.post("/api/v2/account/webhooks", {
+            "webhooks": {
+                "incoming_sms": sms,
+                "delivery_status": dlr,
+                "link_clicks": clicks,
+                "call_events": calls,
+                "call_qualifications": qualif,
+            },
+        })
+        if json_mode:
+            output(result, json_mode=True)
+        else:
+            click.echo(click.style("Webhooks updated.", fg="green"))
+    except InsimAPIError as e:
+        print_error(e.error_code, str(e), e.field, e.extra)
+        raise SystemExit(1)

insim_cli-1.0.0/cli_anything/insim/core/api.py

@@ -0,0 +1,68 @@
+"""HTTP client for inSIM API v2."""
+import requests
+from typing import Any
+
+
+class InsimAPIError(Exception):
+    """Error returned by the inSIM API."""
+    def __init__(self, message: str, error_code: str = "", status: int = 0, field: str = "", extra: dict | None = None):
+        self.error_code = error_code
+        self.status = status
+        self.field = field
+        self.extra = extra or {}
+        super().__init__(message)
+
+
+class InsimAPI:
+    """Client for inSIM API v2."""
+
+    def __init__(self, base_url: str, login: str, access_key: str):
+        self.base_url = base_url.rstrip("/")
+        self.login = login
+        self.access_key = access_key
+        self.session = requests.Session()
+        self.session.headers.update({
+            "Content-Type": "application/json",
+            "User-Agent": "insim-cli/1.0.0",
+        })
+
+    def post(self, endpoint: str, data: dict | None = None) -> dict:
+        """POST to an API v2 endpoint with automatic auth injection."""
+        payload = {
+            "login": self.login,
+            "accessKey": self.access_key,
+        }
+        if data:
+            payload.update(data)
+
+        url = f"{self.base_url}{endpoint}"
+
+        try:
+            resp = self.session.post(url, json=payload, timeout=60, verify=False)
+        except requests.ConnectionError:
+            raise InsimAPIError(f"Cannot connect to {self.base_url}. Is the server running?")
+        except requests.Timeout:
+            raise InsimAPIError("Request timed out after 30 seconds.")
+
+        try:
+            body = resp.json()
+        except ValueError:
+            raise InsimAPIError(f"Invalid response from server (HTTP {resp.status_code})")
+
+        if not body.get("success", False):
+            extra = {}
+            if body.get("error_code") == "LICENSE_REQUIRED":
+                extra = {
+                    "subscription_type": body.get("subscription_type", ""),
+                    "upgrade_url": body.get("upgrade_url", ""),
+                    "feature": body.get("feature", ""),
+                }
+            raise InsimAPIError(
+                message=body.get("error", "Unknown error"),
+                error_code=body.get("error_code", "UNKNOWN"),
+                status=resp.status_code,
+                field=body.get("field", ""),
+                extra=extra,
+            )
+
+        return body

insim_cli-1.0.0/cli_anything/insim/core/auth.py

@@ -0,0 +1,74 @@
+"""Authentication: login, logout, credentials storage."""
+import json
+import os
+from pathlib import Path
+from typing import Optional
+from cli_anything.insim.core.api import InsimAPI, InsimAPIError
+
+CREDENTIALS_DIR = Path.home() / ".insim"
+CREDENTIALS_FILE = CREDENTIALS_DIR / "credentials.json"
+DEFAULT_BASE_URL = "https://www.insim.app"
+
+
+def get_base_url() -> str:
+    return os.environ.get("INSIM_BASE_URL", DEFAULT_BASE_URL)
+
+
+def save_credentials(login: str, access_key: str, base_url: str = "") -> None:
+    CREDENTIALS_DIR.mkdir(parents=True, exist_ok=True)
+    data = {"login": login, "accessKey": access_key}
+    if base_url:
+        data["base_url"] = base_url
+    CREDENTIALS_FILE.write_text(json.dumps(data, indent=2))
+
+
+def load_credentials() -> Optional[dict]:
+    # Priority 1: environment variables
+    env_login = os.environ.get("INSIM_LOGIN")
+    env_key = os.environ.get("INSIM_ACCESS_KEY")
+    if env_login and env_key:
+        return {"login": env_login, "accessKey": env_key}
+
+    # Priority 2: credentials file
+    if CREDENTIALS_FILE.exists():
+        try:
+            return json.loads(CREDENTIALS_FILE.read_text())
+        except (json.JSONDecodeError, OSError):
+            return None
+
+    return None
+
+
+def remove_credentials() -> bool:
+    if CREDENTIALS_FILE.exists():
+        CREDENTIALS_FILE.unlink()
+        return True
+    return False
+
+
+def login(email: str, access_key: str) -> dict:
+    """Validate credentials against the API and save them."""
+    base_url = get_base_url()
+    api = InsimAPI(base_url, email, access_key)
+    result = api.post("/api/v2/account")
+    save_credentials(email, access_key, base_url)
+    return result.get("account", {})
+
+
+def require_auth() -> InsimAPI:
+    """Return an authenticated API client or raise an error."""
+    creds = load_credentials()
+    if not creds:
+        raise InsimAPIError(
+            "Not logged in. Run: insim login YOUR_EMAIL --key YOUR_ACCESS_KEY",
+            error_code="NOT_AUTHENTICATED",
+        )
+    base_url = creds.get("base_url", get_base_url())
+    return InsimAPI(base_url, creds["login"], creds["accessKey"])
+
+
+def whoami() -> dict:
+    """Return account info for the current user."""
+    api = require_auth()
+    result = api.post("/api/v2/account")
+    return result.get("account", {})