Developers / CLI

QuiQSol CLI

The quiqsol command line for scripts, CI jobs and terminal agents: leads, deals, tickets, invoices and every agent tool, with JSON output.

1 min read
On this page

The quiqsol command ships in the @quiqsol/mcp package on npm, the same package that runs the MCP server. It uses an AI agent key, so it can do exactly what that key's scopes allow. It needs Node.js 18 or later.

1. Install and sign in

npm install -g @quiqsol/mcp
quiqsol login
quiqsol whoami

quiqsol login saves your key in ~/.config/quiqsol/config.json with owner-only permissions. Create the key first under Settings, Developer Platform, as an AI agent key with the scopes you need. In CI, set QUIQSOL_API_KEY instead; it overrides the saved login, as does QUIQSOL_API_URL.

2. Run commands

quiqsol leads list --status NEW --limit 10
quiqsol leads create --first-name Ada --last-name Obi --email ada@example.com --source WEBSITE
quiqsol deals pipeline
quiqsol deals move <dealId> "Proposal sent"
quiqsol tickets list --status OPEN --mine
quiqsol tickets reply <ticketId> --body "Your refund was processed today."
quiqsol inbox list --channel whatsapp --unread
quiqsol invoices create --contact-id <contactId> --item "Website design:1:450000" --due-date 2026-11-30
quiqsol invoices send <invoiceId>
quiqsol analytics overview --days 30

3. Call any tool by name

quiqsol tools
quiqsol call crm_list_deals '{"stage":"Negotiation","limit":5}'

quiqsol tools lists every tool your key can use.

What does it print?

JSON on stdout: readable in a terminal, compact when piped.

What stops a script from messaging customers by mistake?

Commands that reach a customer show a preview and ask first. In a script they print the preview and exit with code 3 unless you pass --yes.

Exit codeMeaning
0Done
1Error, with the message on stderr
2Usage error
3Preview only, nothing was sent

Can I use it from code?

Yes. The package exports a client:

const { QuiqsolClient } = require('@quiqsol/mcp');
const quiqsol = new QuiqsolClient({ apiKey: process.env.QUIQSOL_API_KEY });

See Connect QuiQSol to AI agents for Claude, ChatGPT and Cursor.