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 agent-memory service key <store-id> --actions read --name inspector --write .env.inspector
iris agent-memory memories search "how does this customer want answers" --owner cust-1042 --prompt
iris agent-playbook extraction bind <store-id> --idle-seconds 60 --enable   # FAQ proposals from sessions
iris agent-playbook faqs validate ./faqs            # offline
iris agent-playbook faqs sync ./faqs --publish changed
iris --json --no-input agent-playbook faqs plan ./faqs   # unattended, one JSON value on stdout
iris --profile production agent-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 Agent Playbook, Agent Playbook CLI, Configuration, example TOML.

Documentation

The docs are internal: read them in docs/, or render the site locally with task docs:serve.

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.