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.5.0.tar.gz (41.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.5.0-py3-none-any.whl (42.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for familiar_cli-0.5.0.tar.gz
Algorithm Hash digest
SHA256 1ac2d85cbec6fdbcfd42e92e5a2e146e5f8f116a21729240fa1ae5b8e551ce1e
MD5 07584d867e17e0ae21e4fc97699e5f96
BLAKE2b-256 6caf2e6874627e48a72d26d24086f449a3086abf1309430ac290b8c873b54a87

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for familiar_cli-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aaf226719b1410b09deb98ea71bfab448aa85888bddb8964014721ed4794c185
MD5 c08ff3d14356127785bf35bcc643b3b8
BLAKE2b-256 bdcb1ce664916e83412770755037fd156296c2e68d12442872ddbda0bbf5bf10

See more details on using hashes here.

Provenance

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