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

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.3.1.tar.gz (38.4 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.3.1-py3-none-any.whl (40.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: familiar_cli-0.3.1.tar.gz
  • Upload date:
  • Size: 38.4 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.3.1.tar.gz
Algorithm Hash digest
SHA256 ba3017251b3907fd091ac73ea30391f4c832562b3060b10124b9e73f780b1e0e
MD5 21bf449a2dcb23ba92beda64c1e92366
BLAKE2b-256 4ffc8ef83c642fa85bd205608ec8842e0886db2dcb877beef8b23b4c0a37a99b

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: familiar_cli-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 40.4 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.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6b906432824909f149eb39914f974f038004dfe6ca0fb76baeb0492617cd677b
MD5 20e75e0745a26bd0f9bd2bfd264e815b
BLAKE2b-256 3a70c7678eb3de6eccf9c8b16c70b26a5aa8854930d4ac82ca7fc6feae7d7327

See more details on using hashes here.

Provenance

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