Installation

Requirements

• PHP 8.3 or higher
• Composer 2.0 or higher
• AWS credentials configured (for AWS vaults) - see AWS Authentication

Installation Options

PHP Applications (Recommended)

For PHP projects, install Keep as a dependency to ensure it's available across all environments:

composer require --dev stechstudio/keep

Run commands using:

./vendor/bin/keep [command]

This approach ensures Keep is automatically available on other developer machines, staging, and production servers when dependencies are installed.

Tip: Add an alias to your shell profile:

alias keep="./vendor/bin/keep"

Non-PHP Applications or Global Use

For Node.js, Python, Ruby, or other non-PHP applications, install Keep globally:

composer global require stechstudio/keep

Add Composer's global bin to your $PATH:

export PATH="$PATH:$HOME/.composer/vendor/bin"

Note: Global installation requires manual setup on each machine and environment where Keep is needed.

Verify Installation

keep --version

Next Steps

Configure your first project.