Skip to main content

compose and invoke ai agent prompts from reusable templates

Project description

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

Project details


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.4.0.tar.gz (40.2 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.4.0-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: familiar_cli-0.4.0.tar.gz
  • Upload date:
  • Size: 40.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for familiar_cli-0.4.0.tar.gz
Algorithm Hash digest
SHA256 e2904ca64a4d256a2814f728bfbae2e8533d3f6bfa1a046c04fcf9eb2eca2cf4
MD5 cd073b2d978d52085cab9a538c1f5b9d
BLAKE2b-256 3aa950cb01181fb2c9f9d32cfad066c54053cb08298fec50c99cac9d2d0306a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for familiar_cli-0.4.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.4.0-py3-none-any.whl.

File metadata

  • Download URL: familiar_cli-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 41.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for familiar_cli-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 50ae5a3c0ca64d30ba61edf52a7e69d51502c24436f19f3689798f590a43347f
MD5 180cb11ffb3c197e1f3f3c886eeb2075
BLAKE2b-256 38a89a2240582e4e4c0b83a1d93d61cac9d5958664197aec8b713ac3723e975d

See more details on using hashes here.

Provenance

The following attestation bundles were made for familiar_cli-0.4.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