Skip to main content

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] [--version] [--debug] {conjure,invoke,list,lint} ...

conjure and invoke familiars

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

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --debug               show full traceback on error

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

lint conjurings and invocations, including local .familiar/ overrides:

familiar lint

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

familiar_cli-0.6.0.tar.gz (46.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

familiar_cli-0.6.0-py3-none-any.whl (44.4 kB view details)

Uploaded Python 3

File details

Details for the file familiar_cli-0.6.0.tar.gz.

File metadata

  • Download URL: familiar_cli-0.6.0.tar.gz
  • Upload date:
  • Size: 46.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for familiar_cli-0.6.0.tar.gz
Algorithm Hash digest
SHA256 7ebe9084770c45301cb5f25d3ccd95aae40dbd3f5a559c7ed05200985a4bf542
MD5 57c23f7273f6e46c635a9790e36476a6
BLAKE2b-256 8e5e2836ae8be493a691d86fe2603b6ad9e5db39cfb46739c98b73b0d27488b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for familiar_cli-0.6.0.tar.gz:

Publisher: publish.yml on cyberwitchery/familiar

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file familiar_cli-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: familiar_cli-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 44.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for familiar_cli-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 42c7881c674436cb54cad53807ac569e6ab3ed55a9af996a65e5d0fe8b27a09e
MD5 82cd254aade6cf2836d0bc57e8cfaa9f
BLAKE2b-256 c6fcb27291d7e6d3469cf4f46f7e1128c1f68f9c5030f92a7a6697133ae70c8b

See more details on using hashes here.

Provenance

The following attestation bundles were made for familiar_cli-0.6.0-py3-none-any.whl:

Publisher: publish.yml on cyberwitchery/familiar

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page