xaffinity-cli-usage

Manage Affinity CRM data via xaffinity CLI with read-only and JSON defaults.

1|2|Updated Feb 2, 2026
One-click install
npx skills add https://github.com/oneryalcin/affinity-sdk --skill xaffinity-cli-usage
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: xaffinity-cli-usage
Source: https://github.com/oneryalcin/affinity-sdk/tree/main/plugins/xaffinity-cli/.claude-plugin/skills/xaffinity-cli-usage
Command: npx skills add https://github.com/oneryalcin/affinity-sdk --skill xaffinity-cli-usage

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill guides and enforces safe, efficient usage of the xaffinity CLI to manage Affinity CRM data, reducing user errors and API misuse.

Core Features & Use Cases

  • Guided CLI workflows for searching, retrieving, exporting, and listing people, companies, opportunities, lists, and CRM data from Affinity.
  • Safety-first behavior: API key verification, consistent use of --readonly and --json, and prompts/confirmation for destructive actions.
  • Real-world scenarios: exporting contact lists to CSV, auditing data, or quickly retrieving entity details via the command line.

Quick Start

Run API key verification first: xaffinity config check-key --json. If configured, perform a read-only query such as xaffinity person ls --json to locate entities or export data as needed.

Frequently Asked Questions about xaffinity-cli-usage

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I export Affinity CRM data to CSV from the command line?

You can export Affinity CRM data to CSV by running guided xaffinity CLI commands to list and retrieve people, companies, or opportunities. The skill defaults to --readonly and --json to ensure safe data exports without risking unintended write operations.

What is the safest way to search and retrieve Affinity contact details via CLI?

The safest way to search Affinity contact details is using xaffinity commands with --readonly and --json flags enabled by default. Users must first verify their API key with xaffinity config check-key --json before performing any read-only queries.

Can I perform write operations on Affinity CRM records using xaffinity?

Yes, write operations on Affinity CRM records are supported but require explicit confirmation for destructive actions. The CLI defaults to read-only mode to prevent accidental data modification during standard search, retrieval, and listing workflows.

How do I audit Affinity CRM opportunities and lists without modifying data?

You can audit Affinity CRM opportunities and lists by executing read-only CLI commands appended with --readonly and --json. This approach retrieves entity details and exports data safely without triggering any destructive write operations.

Do I need to configure an API key before using xaffinity CLI commands?

Yes, you must configure and verify an API key before using xaffinity CLI commands. The initial required step is running xaffinity config check-key --json to validate your setup before querying people, companies, or opportunities.

What should I do if I need to prevent accidental data loss when managing Affinity CRM entities?

To prevent accidental data loss when managing Affinity CRM entities, the xaffinity CLI enforces explicit confirmation prompts for destructive actions. It defaults to --readonly mode, ensuring standard search and export tasks cannot modify your CRM data.