Agentf

Agentf is a Ruby CLI and installer for running multi-agent development workflows with shared Redis memory.

It helps you install provider manifests, run workflows, inspect memory, and expose tools via MCP.

1. Install prerequisites

• Ruby 3.3+
• Redis Stack (required for RedisJSON + RediSearch)

docker run -d -p 6379:6379 redis/redis-stack:latest

2. Install the gem (local development)

bundle exec rake install

Or install the released gem:

gem install agentf

3. Verify install

agentf version
agentf help

Set environment variables (or create a .env file). Example:

export REDIS_URL=redis://localhost:6379
export AGENTF_PROJECT_NAME=my-project

Install provider manifests (example providers shown):

agentf install --provider=opencode,copilot --scope=local

Try useful commands after install:

agentf memory recent -n 5
agentf code glob "lib/**/*.rb"
agentf metrics summary -n 100
agentf mcp-server

• agentf install install provider manifests from agent metadata
• agentf update regenerate manifests when gem version changes
• agentf memory ... inspect/search/add memory entries
• agentf code ... explore project files and patterns
• agentf architecture ... analyze layer distribution
• agentf metrics ... inspect workflow quality and provider parity
• agentf mcp-server run MCP server over stdio
• agentf help show command help

For command details, run:

agentf <command> help

• REDIS_URL Redis connection string (default: redis://localhost:6379)
• AGENTF_PROJECT_NAME project key used for memory isolation
• AGENTF_METRICS_ENABLED enable/disable metrics (default: true)
• AGENTF_WORKFLOW_CONTRACT_ENABLED enable/disable workflow stage checks (default: true)
• AGENTF_WORKFLOW_CONTRACT_MODE workflow stage mode: advisory|enforcing|off (default: advisory)
• AGENTF_AGENT_CONTRACT_ENABLED enable/disable per-agent pre/post checks (default: true)
• AGENTF_AGENT_CONTRACT_MODE per-agent mode: advisory|enforcing|off (default: enforcing)
• AGENTF_GEM_PATH optional gem root hint for OpenCode plugin binary resolution

If Redis requires auth, include credentials in REDIS_URL (example: redis://:password@localhost:6379).

• Security guidance: docs/security.md
• RubyGems package: https://rubygems.org/gems/agentf

Run dependencies and the test suite locally:

bundle install
bundle exec rspec spec/

When making changes to the CLI or gemspec use bundle exec rake install to install the locally built gem into your system Ruby gems for manual testing.

MIT