Bigin CRM CLI for Openclaw

A secure CLI tool to manage Zoho Bigin CRM pipelines, contacts, and accounts via AI agents.

ingodibella
v2.0.0
Mar 3, 2026
0
828
0

Install & Download

1. ClawHub CLI

The fastest way to install a skill directly from the registry.

npx clawhub@latest install bigin

2. Manual Installation

Copy the skill folder to one of these locations

Global
~/.openclaw/skills/
Workspace
<project>/skills/

Priority: Workspace > Local > Bundled

3. Prompt Installation

Copy this prompt to OpenClaw to install it automatically.

Help me install bigin using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).

Prefer to download?

Get the raw skill files in a ZIP archive.

What is Bigin CRM CLI?

The Bigin CRM Skill provides a powerful command-line interface for interacting with Zoho Bigin, a streamlined CRM for small businesses. It enables AI agents to seamlessly bridge the gap between communication and data management by abstracting the Bigin v2 API into simple bash commands. This skill is a core part of the Openclaw Skills ecosystem, designed to handle complex CRM logic like OAuth token management, automatic pagination, and environment-based security guardrails.

By leveraging this skill, developers can automate repetitive sales tasks, maintain clean data records, and give their AI agents the ability to query real-time pipeline status. It treats security as a priority, implementing a read-only default state that requires explicit permission for any write or delete operations.

Bigin CRM CLI Use Cases

  • Automating deal stage updates and pipeline transitions during sales cycles.
  • Searching for customer contact information or company accounts during support interactions.
  • Adding detailed notes and logs to CRM records directly from a terminal or agent workflow.
  • Synchronizing product data and deal associations for reporting purposes.
  • Discovering organizational CRM layouts and custom field definitions through Openclaw Skills.

How Bigin CRM CLI Works

  1. The AI agent executes the bigin.sh script with a specific command such as deals, contacts, or accounts.
  2. The system validates the local OAuth credentials stored in the user directory to establish a secure connection.
  3. The skill automatically refreshes the access token if it has expired to ensure uninterrupted service.
  4. For data retrieval, the CLI requests specific fields to comply with Bigin v2 API requirements, providing a clean JSON response.
  5. For modifications, the script checks for the BIGIN_WRITE environment variable to prevent unauthorized data changes.
  6. The response is parsed by the AI agent, allowing it to provide accurate CRM updates or insights based on Openclaw Skills logic.

Bigin CRM CLI Setup

To get started with this skill, ensure your environment has curl, jq, and python3 installed. Follow these steps for installation:

  1. Configure your OAuth credentials in ~/.bigin-oauth.json as detailed in the technical documentation.
  2. Initialize your local metadata map to sync your specific CRM layout:
bash scripts/bigin.sh map
  1. To enable write operations for your agent, set the following environment variable:
export BIGIN_WRITE=1

Bigin CRM CLI Data Schema & Taxonomy

The skill organizes data using a local mapping system and strictly follows the Zoho Bigin v2 module naming convention. Key data structures include:

  • Module Mapping:

    UI Name API Module Name
    Deals Pipelines
    Companies Accounts
    Contacts Contacts
  • Metadata: The bigin-map.json file tracks sub-pipelines, deal stages, and custom field definitions.

  • Date Format: All date-related data must be provided in YYYY-MM-DD format to ensure API compatibility.

Bigin CRM CLI Advanced Features

  • Environment-based guardrails that protect against accidental record deletion or unauthorized updates.
  • Automatic schema discovery that maps unique organization stages and fields to the local environment.
  • Built-in pagination support that manages large datasets by tracking the more_records flag.
  • A raw API escape hatch allowing power users to send custom GET/PUT requests directly to Bigin.
  • Smart search behavior that automatically switches between criteria-based and word-based searching based on field searchability.

SKILL.md


Loading

Related Openclaw Skills

METADATA

Github Stars: 0
forks: 0

Featured*