Skip to main content
The Famulor CLI brings the complete REST API to your terminal. Create assistants, start calls, run campaigns, manage leads and phone numbers, and read call history with one tool. Everything you can do through the API, you can script, run in CI, or hand to a coding agent.
The CLI is a public preview (version 0.x). Command names follow the API and may still change before 1.0. A renamed command keeps working for at least one minor version.

​
Requirements

  • Node.js 22 or newer.
  • A workspace plan with API Access, the same requirement as the REST API.
  • An API key from Settings → API & MCP.

​
Quickstart

1

Install

2

Log in

Create an API key under Settings → API & MCP, then run:
Paste the key when asked. The input stays hidden, and the key is saved in your system keychain.
3

Run your first commands

​
How commands work

Every operation in the API reference is one command. The command name is the operation ID in kebab case, so Start an outbound call (createCall) is famulor create-call.
  • Path parameters are arguments: famulor get-assistant <id>.
  • Query parameters and body fields are options in kebab case: assistant_id becomes --assistant-id.
  • Options are typed and checked before anything is sent: numbers must be numbers, choices must be allowed values, and required fields must be present.

​
Learn more

Log in and workspaces

Keychain storage, CI keys, one profile per workspace and white-label domains.

Commands and output

Request bodies, file uploads, tables, JSON Lines, pagination and downloads.

Scripts, CI and coding agents

Safe automation, exit codes, jq pipelines and the command schema for agents.

Reference

Global options, environment variables, exit codes and troubleshooting.
Working inside an AI assistant such as Claude or ChatGPT instead of a terminal? Connect it through the MCP server. It offers the same capabilities as tools.