Getting Started
1. Installation
Download the latest
.dmg from the Download page. Drag Familiar to your Applications folder and launch it.
2. Setup Inference
Open Settings and add your API keys for providers like OpenAI, Anthropic, or Gemini. If you're using Ollama, ensure it's running locally.
3. Your First Agent
Click "New Agent" and define an objective. Familiar will help you draft a Scope Document before it begins any work.
Key Concepts
Scope Documents
The single source of truth for an agent. It contains the objective, the current plan, and the permissions granted to the agent.
Agent States
Agents can be Idle, Running, Waiting for Approval, or Paused. You have full control over the execution lifecycle.
Permissions
Tools are restricted by default. Agents must request permission in the Scope Document to use specific capabilities like shell access.
The Audit Log
Every single thought, tool call, and response is logged in real-time. You can audit exactly what happened and why.
Advanced Usage
Sub-Agents
Learn how to delegate complex tasks to specialized sub-agents that report back to their parent.
Scheduling & Cron
Automate recurring workflows by attaching schedules to your agents.
Local-Only Mode
Configure Familiar to work entirely offline using local providers like Ollama.
Support
For bug reports or feature requests, please use the feedback button within the app or visit our community channels.