Install

Requires Python 3.11+. uv is the recommended installer.

uv add redis-iris            # library, in your project
uv tool install redis-iris   # iris CLI, isolated
iris --help

pipx install redis-iris
python -m pip install redis-iris   # inside an active virtual environment

From a source checkout, uv tool install --force . installs or replaces the iris tool, and python -m redis_iris runs the CLI wherever the package is installed.

Alpha releases may change commands and output contracts. Pin a version in automation and check the release notes before upgrading.

The stack

Iris is a suite of products. Use one, or all of them.

User guides

Integrate with an existing agent

Built your stack with a popular orchestration tool? A skill lets your coding agent do the wiring.

The CLI

iris <product> <command> creates services, mints keys, and manages content. Shared options go before the product name.

iris agent-memory service create --from service.yaml --write-env .env
iris playbook faqs validate ./faqs            # offline
iris playbook faqs sync ./faqs --publish changed
iris --json --no-input playbook faqs plan ./faqs   # unattended, one JSON value on stdout
iris --profile production playbook health

Settings resolve from command options, environment variables, the selected TOML profile, shared TOML settings, then defaults. API keys belong in environment variables. Exit codes are 0 for success, 1 for operational failures, and 2 for invalid input or configuration. Help, version, completion, and local validation work without credentials or a network connection.

Guides: Set up Agent Memory, Set up Playbook, Playbook CLI, Configuration, example TOML.

Documentation

Contributing

Bug reports, documentation improvements, and new integrations are welcome. Open an issue or read the contributor guide.

task install
task check   # formatting, lint, types, offline tests, package build

Maintainers publish with the release runbook.

License

MIT.