Skip to main content

Documentation Index

Fetch the complete documentation index at: https://familyco.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

This guide is for end users who just want to use FamilyCo. If you want to develop the codebase, see Developer setup.
You do not need Node.js, pnpm, or terminal commands to use FamilyCo. The desktop release ships everything bundled.

​
1. Download a release

Grab the installer for your operating system from the releases page.
Download the .dmg file, open it, and drag FamilyCo to Applications.
If your OS shows a security warning on first launch, choose Open anyway / Run anyway. Releases are unsigned during early access.

​
2. Configure a provider

On first launch, open Settings → Providers and connect at least one AI provider (for example, OpenAI or Claude) using an API key. Mark one provider as the primary and pick a default model. The embedded server stores your local data here:
  • macOS: ~/Library/Application Support/FamilyCo/familyco.db
  • Windows: C:\Users\<user>\AppData\Roaming\FamilyCo\familyco.db
  • Linux: ~/.config/FamilyCo/familyco.db

​
3. Send your first directive

Open Chat and tell the Executive Agent what you want done. For example:
Draft a 3-week launch plan for our newsletter, propose owners, and surface any approval I need to make.
The Executive Agent will:
  1. Interpret the goal and produce a plan.
  2. Create or update Projects and Tasks.
  3. Pause into the Inbox if anything risky or ambiguous comes up.
  4. Record Audit and Budget entries throughout.

​
4. Review and approve

Use the Inbox to approve, reject, or answer clarifications. Use Budget to keep an eye on token and cost usage. Use the Audit Log to inspect any action end to end.

​
Next steps

Developer setup

Run FamilyCo from source with pnpm dev.

Configuration

All environment variables and runtime options.

Modules

Deep dives on Chat, Agents, Projects, Tasks, and more.

Skills standard

How skills are stored, discovered, and toggled.