foxreach-cli 0.1.0__tar.gz

foxreach_cli-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,46 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

foxreach_cli-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+dist/
+build/
+*.egg-info/
+__pycache__/
+*.pyc
+.venv/

foxreach_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 FoxReach
+
+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.

foxreach_cli-0.1.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: foxreach-cli
+Version: 0.1.0
+Summary: CLI for the FoxReach cold email outreach API
+Project-URL: Homepage, https://foxreach.io
+Project-URL: Documentation, https://docs.foxreach.io/sdks/cli
+Project-URL: Repository, https://github.com/foxreach/foxreach-cli
+Project-URL: Changelog, https://docs.foxreach.io/changelog
+Author-email: FoxReach <dev@foxreach.io>
+License: MIT
+License-File: LICENSE
+Keywords: cli,cold-email,email,foxreach,outreach
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: Email
+Requires-Python: >=3.9
+Requires-Dist: click>=8.0
+Requires-Dist: foxreach>=0.1.0
+Requires-Dist: rich>=13.0
+Description-Content-Type: text/markdown
+
+# FoxReach CLI
+
+Command-line interface for the [FoxReach](https://foxreach.io) cold email outreach API.
+
+## Installation
+
+```bash
+pip install foxreach-cli
+```
+
+## Setup
+
+```bash
+# Save your API key
+foxreach config set-key
+# Enter: otr_your_api_key
+
+# Verify
+foxreach config show
+```
+
+You can also use environment variables:
+
+```bash
+export FOXREACH_API_KEY=otr_your_api_key
+export FOXREACH_BASE_URL=https://api.foxreach.io/api/v1  # optional
+```
+
+## Usage
+
+### Leads
+
+```bash
+foxreach leads list
+foxreach leads list --search "jane" --status active
+foxreach leads get cld_abc123
+foxreach leads create --email jane@example.com --first-name Jane --company "Acme"
+foxreach leads update cld_abc123 --company "New Corp"
+foxreach leads delete cld_abc123
+```
+
+### Campaigns
+
+```bash
+foxreach campaigns list
+foxreach campaigns list --status active
+foxreach campaigns get cmp_xyz789
+foxreach campaigns create --name "Q1 Outreach" --daily-limit 100
+foxreach campaigns update cmp_xyz789 --daily-limit 200
+foxreach campaigns start cmp_xyz789
+foxreach campaigns pause cmp_xyz789
+foxreach campaigns add-leads cmp_xyz789 --lead-ids cld_1,cld_2,cld_3
+foxreach campaigns add-accounts cmp_xyz789 --account-ids acc_1
+foxreach campaigns delete cmp_xyz789
+```
+
+### Sequences
+
+```bash
+foxreach sequences list --campaign cmp_xyz789
+foxreach sequences create --campaign cmp_xyz789 --subject "Hi {{firstName}}" --body "Hello!"
+foxreach sequences update --campaign cmp_xyz789 --sequence seq_1 --delay-days 3
+foxreach sequences delete --campaign cmp_xyz789 --sequence seq_1
+```
+
+### Templates
+
+```bash
+foxreach templates list
+foxreach templates get tpl_abc123
+foxreach templates create --name "Follow-up" --body "Hi {{firstName}}, just checking in."
+foxreach templates update tpl_abc123 --name "New Follow-up"
+foxreach templates delete tpl_abc123
+```
+
+### Email Accounts
+
+```bash
+foxreach accounts list
+foxreach accounts get acc_abc123
+foxreach accounts delete acc_abc123
+```
+
+### Inbox
+
+```bash
+foxreach inbox list
+foxreach inbox list --unread --category interested
+foxreach inbox get rpl_abc123
+foxreach inbox update rpl_abc123 --read --category qualified
+```
+
+### Analytics
+
+```bash
+foxreach analytics overview
+foxreach analytics campaign cmp_xyz789
+```
+
+## JSON Output
+
+Add `--json` to any command to get raw JSON output for scripting:
+
+```bash
+foxreach leads list --json | jq '.data[].email'
+foxreach campaigns get cmp_xyz789 --json
+```
+
+## Configuration
+
+Config is stored at `~/.foxreach/config.json`. Environment variables take precedence:
+
+| Setting | Env Var | Config Key |
+|---------|---------|------------|
+| API Key | `FOXREACH_API_KEY` | `api_key` |
+| Base URL | `FOXREACH_BASE_URL` | `base_url` |

foxreach_cli-0.1.0/README.md

@@ -0,0 +1,116 @@
+# FoxReach CLI
+
+Command-line interface for the [FoxReach](https://foxreach.io) cold email outreach API.
+
+## Installation
+
+```bash
+pip install foxreach-cli
+```
+
+## Setup
+
+```bash
+# Save your API key
+foxreach config set-key
+# Enter: otr_your_api_key
+
+# Verify
+foxreach config show
+```
+
+You can also use environment variables:
+
+```bash
+export FOXREACH_API_KEY=otr_your_api_key
+export FOXREACH_BASE_URL=https://api.foxreach.io/api/v1  # optional
+```
+
+## Usage
+
+### Leads
+
+```bash
+foxreach leads list
+foxreach leads list --search "jane" --status active
+foxreach leads get cld_abc123
+foxreach leads create --email jane@example.com --first-name Jane --company "Acme"
+foxreach leads update cld_abc123 --company "New Corp"
+foxreach leads delete cld_abc123
+```
+
+### Campaigns
+
+```bash
+foxreach campaigns list
+foxreach campaigns list --status active
+foxreach campaigns get cmp_xyz789
+foxreach campaigns create --name "Q1 Outreach" --daily-limit 100
+foxreach campaigns update cmp_xyz789 --daily-limit 200
+foxreach campaigns start cmp_xyz789
+foxreach campaigns pause cmp_xyz789
+foxreach campaigns add-leads cmp_xyz789 --lead-ids cld_1,cld_2,cld_3
+foxreach campaigns add-accounts cmp_xyz789 --account-ids acc_1
+foxreach campaigns delete cmp_xyz789
+```
+
+### Sequences
+
+```bash
+foxreach sequences list --campaign cmp_xyz789
+foxreach sequences create --campaign cmp_xyz789 --subject "Hi {{firstName}}" --body "Hello!"
+foxreach sequences update --campaign cmp_xyz789 --sequence seq_1 --delay-days 3
+foxreach sequences delete --campaign cmp_xyz789 --sequence seq_1
+```
+
+### Templates
+
+```bash
+foxreach templates list
+foxreach templates get tpl_abc123
+foxreach templates create --name "Follow-up" --body "Hi {{firstName}}, just checking in."
+foxreach templates update tpl_abc123 --name "New Follow-up"
+foxreach templates delete tpl_abc123
+```
+
+### Email Accounts
+
+```bash
+foxreach accounts list
+foxreach accounts get acc_abc123
+foxreach accounts delete acc_abc123
+```
+
+### Inbox
+
+```bash
+foxreach inbox list
+foxreach inbox list --unread --category interested
+foxreach inbox get rpl_abc123
+foxreach inbox update rpl_abc123 --read --category qualified
+```
+
+### Analytics
+
+```bash
+foxreach analytics overview
+foxreach analytics campaign cmp_xyz789
+```
+
+## JSON Output
+
+Add `--json` to any command to get raw JSON output for scripting:
+
+```bash
+foxreach leads list --json | jq '.data[].email'
+foxreach campaigns get cmp_xyz789 --json
+```
+
+## Configuration
+
+Config is stored at `~/.foxreach/config.json`. Environment variables take precedence:
+
+| Setting | Env Var | Config Key |
+|---------|---------|------------|
+| API Key | `FOXREACH_API_KEY` | `api_key` |
+| Base URL | `FOXREACH_BASE_URL` | `base_url` |

foxreach_cli-0.1.0/foxreach_cli/__init__.py

@@ -0,0 +1,3 @@
+"""FoxReach CLI — command-line interface for the FoxReach API."""
+
+__version__ = "0.1.0"

foxreach_cli-0.1.0/foxreach_cli/client_factory.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+import sys
+
+from foxreach import FoxReach
+
+from . import config as cfg
+from .output import print_error
+
+
+def get_client() -> FoxReach:
+    api_key = cfg.get_api_key()
+    if not api_key:
+        print_error("No API key configured. Run: foxreach config set-key")
+        sys.exit(1)
+
+    kwargs = {"api_key": api_key}
+    base_url = cfg.get_base_url()
+    if base_url:
+        kwargs["base_url"] = base_url
+
+    return FoxReach(**kwargs)

foxreach_cli-0.1.0/foxreach_cli/commands/accounts.py

@@ -0,0 +1,87 @@
+from __future__ import annotations
+
+import sys
+from dataclasses import asdict
+
+import click
+
+from foxreach import FoxReachError
+
+from ..client_factory import get_client
+from ..output import print_detail, print_error, print_json, print_meta, print_success, print_table
+
+
+@click.group()
+def accounts() -> None:
+    """Manage email accounts."""
+
+
+@accounts.command("list")
+@click.option("--page", default=1, type=int)
+@click.option("--limit", default=50, type=int)
+@click.option("--json", "as_json", is_flag=True, help="Output as JSON")
+def accounts_list(page: int, limit: int, as_json: bool) -> None:
+    """List email accounts."""
+    client = get_client()
+    try:
+        result = client.email_accounts.list(page=page, page_size=limit)
+    except FoxReachError as e:
+        print_error(str(e))
+        sys.exit(1)
+
+    if as_json:
+        print_json({"data": [asdict(a) for a in result.data], "meta": asdict(result.meta)})
+        return
+
+    if not result.data:
+        click.echo("No email accounts found.")
+        return
+
+    print_table(
+        result.data,
+        ["ID", "Email", "Display Name", "Active", "Daily Limit", "Sent Today", "Health"],
+        {
+            "ID": "id", "Email": "email", "Display Name": "display_name",
+            "Active": "is_active", "Daily Limit": "daily_limit",
+            "Sent Today": "sent_today", "Health": "health_score",
+        },
+    )
+    print_meta(result.meta)
+
+
+@accounts.command("get")
+@click.argument("account_id")
+@click.option("--json", "as_json", is_flag=True, help="Output as JSON")
+def accounts_get(account_id: str, as_json: bool) -> None:
+    """Get an email account by ID."""
+    client = get_client()
+    try:
+        account = client.email_accounts.get(account_id)
+    except FoxReachError as e:
+        print_error(str(e))
+        sys.exit(1)
+
+    if as_json:
+        print_json(account)
+        return
+
+    print_detail(account, [
+        "id", "email", "display_name", "provider", "is_active",
+        "daily_limit", "sent_today", "warmup_enabled",
+        "health_score", "bounce_rate", "reply_rate",
+        "connection_status", "created_at",
+    ])
+
+
+@accounts.command("delete")
+@click.argument("account_id")
+@click.confirmation_option(prompt="Are you sure you want to delete this email account?")
+def accounts_delete(account_id: str) -> None:
+    """Delete an email account."""
+    client = get_client()
+    try:
+        client.email_accounts.delete(account_id)
+    except FoxReachError as e:
+        print_error(str(e))
+        sys.exit(1)
+    print_success(f"Email account deleted: {account_id}")

foxreach_cli-0.1.0/foxreach_cli/commands/analytics.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+
+import sys
+from dataclasses import asdict
+
+import click
+
+from foxreach import FoxReachError
+
+from ..client_factory import get_client
+from ..output import print_detail, print_error, print_json, print_table
+
+
+@click.group()
+def analytics() -> None:
+    """View analytics and stats."""
+
+
+@analytics.command("overview")
+@click.option("--json", "as_json", is_flag=True, help="Output as JSON")
+def analytics_overview(as_json: bool) -> None:
+    """Show dashboard overview stats."""
+    client = get_client()
+    try:
+        stats = client.analytics.overview()
+    except FoxReachError as e:
+        print_error(str(e))
+        sys.exit(1)
+
+    if as_json:
+        print_json(stats)
+        return
+
+    print_detail(stats, [
+        "total_accounts", "active_accounts",
+        "total_campaigns", "active_campaigns",
+        "total_leads", "total_sent", "total_replies",
+        "reply_rate", "account_health_avg",
+    ])
+
+
+@analytics.command("campaign")
+@click.argument("campaign_id")
+@click.option("--json", "as_json", is_flag=True, help="Output as JSON")
+def analytics_campaign(campaign_id: str, as_json: bool) -> None:
+    """Show campaign analytics."""
+    client = get_client()
+    try:
+        stats = client.analytics.campaign(campaign_id)
+    except FoxReachError as e:
+        print_error(str(e))
+        sys.exit(1)
+
+    if as_json:
+        print_json(stats)
+        return
+
+    print_detail(stats, [
+        "sent", "delivered", "bounced", "replied", "opened",
+        "reply_rate", "bounce_rate",
+    ])
+
+    if stats.daily_stats:
+        click.echo("\nDaily Stats:")
+        print_table(
+            stats.daily_stats,
+            ["Date", "Sent", "Delivered", "Bounced", "Replied", "Opened"],
+            {"Date": "date", "Sent": "sent", "Delivered": "delivered", "Bounced": "bounced", "Replied": "replied", "Opened": "opened"},
+        )