Skip to content

orbio-api/orbio-openclaw

Repository files navigation

Orbio OpenClaw Integration (official)

Official Orbio integration for OpenClaw to run account discovery and export workflows directly in chat (WhatsApp, Telegram, Slack, and other OpenClaw channels).

Workspace positioning

  • Pasta do projeto: orbio-openclaw-integration/.
  • Projetos irmaos no mesmo workspace: orbio-api/ e frontend/.
  • Referencias cross-project devem usar caminho de workspace (orbio-api/..., frontend/...) ou relativo (../orbio-api/..., ../frontend/...).

This repository is focused on:

  • lead generation in Brazil
  • B2B prospecting and sales pipeline creation
  • natural-language company search
  • CNPJ-ready account exports for outbound operations

Search keywords: OpenClaw plugin, Orbio API, account discovery, lead generation, sales automation, B2B prospecting, Brazilian companies, CNPJ, WhatsApp bot, Telegram bot, Slack bot. Palavras-chave: plugin OpenClaw, Orbio API, descoberta de contas, geracao de leads, prospeccao B2B, automacao comercial, pipeline comercial, empresas brasileiras, busca CNPJ, bot para WhatsApp, bot para Telegram, bot para Slack.

GEO for agents

  • Machine-readable context for LLM crawlers: llms.txt
  • Agent contribution and guardrails: AGENTS.md
  • Plugin contract and runtime surface: orbio-openclaw-plugin/openclaw.plugin.json

Contents

  • orbio-openclaw-plugin/: npm plugin (@orbio/orbio-openclaw) with Orbio tools.
  • skill-orbio-official/: standalone skill artifact for ClawHub publication.

Quickstart

pnpm install --frozen-lockfile
pnpm verify
cd orbio-openclaw-plugin && pnpm pack --dry-run

Quality gate in pnpm verify:

  • pnpm lint
  • pnpm typecheck
  • pnpm coverage (>=95% lines/branches/functions/statements)
  • pnpm build

OpenClaw install example

plugins:
  entries:
    orbio-openclaw:
      package: "@orbio/orbio-openclaw@0.1.0"
      config:
        baseUrl: "https://api.orbioapi.com.br"
        apiKey: "${ORBIO_API_KEY}"
        workspaceId: "acme-workspace"
        channel: "slack"
        sendExecutionContext: true

Skill commands

  • /orbio search <query> [--limit N] [--with-contact]
  • /orbio export <query> [--limit N] [--format csv|html] [--with-contact]
  • /orbio export-status <export_id>

Security defaults

  • No shell execution (exec, curl, subprocesses).
  • Contact fields masked by default.
  • Contact fields only returned with explicit opt-in (--with-contact) and plan permission.
  • Plugin-side throttling in addition to backend rate limits.

Publishing

  • npm package publication workflow: .github/workflows/publish.yml
  • CI validation workflow: .github/workflows/ci.yml
  • detailed release steps: RELEASING.md
  • real-environment validation guide: REAL_ENV_TESTING.md

Contributor guardrails

  • Agent/contributor rules: AGENTS.md
  • Husky pre-commit hook: .husky/pre-commit (installed by root pnpm install)