Skip to content

cyberwitchery/familiar

Repository files navigation

familiar

pypi docs

compose and invoke ai agent prompts from reusable conjurings and invocations.

ships with a standard set of conjurings and invocations, or bring your own (mine are very much wip).

installation

pip install familiar-cli

usage

usage: familiar [-h] {conjure,invoke,list} ...

conjure and invoke familiars

positional arguments:
  {conjure,invoke,list}
    conjure             compose system instructions for an agent
    invoke              render an invocation and run the agent
    list                list available conjurings or invocations

options:
  -h, --help            show this help message and exit

conjure conjurings to create system instructions for an agent:

familiar conjure codex rust infra sec

save composed conjurings as a reusable subagent:

familiar conjure claude python sec --save-subagent
familiar conjure codex rust infra --save-subagent --subagent-name ship_ops

save an invocation as a reusable skill:

familiar invoke claude code-review --save-skill
familiar invoke codex refactor src/foo.py --save-skill --skill-name cleanup_refactor

invoke an action prompt:

familiar invoke codex bootstrap-rust myapp lib 1.78 mit

run in a separate git worktree to avoid interfering with local changes:

familiar invoke --worktree codex bootstrap-rust myapp lib

list available conjurings and invocations:

familiar list

customization

add your own conjurings and invocations by creating files in .familiar/ in your repo:

.familiar/
  conjurings/
    myprofile.md      # new conjuring
    rust.md           # override built-in
  invocations/
    my-task.md        # new invocation

local files take precedence over built-ins.

plugins

add new agents via plugins:

pip install familiar-gemini
familiar invoke gemini bootstrap-python myapp cli

see the plugin docs for creating your own.

placeholders

invocations support placeholders:

  • $1, $2, ... - positional arguments
  • $ARGUMENTS - all positional arguments joined
  • {{key}} - named arguments passed via --kv key=value

documentation

full docs at familiar.readthedocs.io.

license

mit

About

summons friendly sprites

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors