Skip to content
familiarfamiliarfamiliar

Getting started

  1. Download familiar-workspace-<version>.zip from github.com/familiar-md/familiar/releases and unzip it. It holds one folder, familiar-workspace/, and the license.
  2. Rename familiar-workspace/ to your project’s name, and move it where you want it. That folder is the project. docs/using-familiar.md shows its layout. familiar reads and writes only inside this folder.
  3. If you already have source material, put it in 1-Inputs/Sources/, 1-Inputs/Admin/ or 1-Inputs/Templates/ before your first session.
  4. Open your agent with that folder as the working folder. Its entry file (CLAUDE.md, AGENTS.md or GEMINI.md) is already in the folder. You do not need to point the agent at anything else.

Already have a project folder? Put the workspace inside it, one level down, beside your other files. Open the agent in the workspace folder, not the outer one. familiar works only inside the workspace. You move files across yourself: sources in, finished drafts out. Where things live shows both layouts.