Installation Guide¶

Quick Start¶

Clone and Run¶

git clone https://github.com/phdsystems/12factor-kit.git
cd 12factor-kit
./bin/twelve-factor-reviewer /path/to/project

Installation Methods¶

Method 1: Local Installation¶

# Clone this repository
git clone https://github.com/phdsystems/12factor-kit.git
cd 12factor-kit

# Make the tool executable
chmod +x bin/twelve-factor-reviewer

# Run directly
./bin/twelve-factor-reviewer /path/to/project

# Or add to PATH (optional)
export PATH="$PATH:$(pwd)/bin"
twelve-factor-reviewer /path/to/project

Method 2: System-wide Installation¶

# Clone and install
git clone https://github.com/phdsystems/12factor-kit.git
cd 12factor-kit

# Install to /usr/local/bin
sudo ./install.sh

# Now use from anywhere
twelve-factor-reviewer /path/to/project

Method 3: Docker Installation¶

# Using pre-built image (when available)
docker pull phdsystems/12factor-reviewer
docker run -v $(pwd):/project phdsystems/12factor-reviewer

# Or build locally
git clone https://github.com/phdsystems/12factor-kit.git
cd 12factor-kit
docker build -t 12factor-reviewer .
docker run -v $(pwd):/project 12factor-reviewer

Method 4: npm Installation (when published)¶

# Global installation
npm install -g 12factor-reviewer

# Run assessment
twelve-factor-reviewer /path/to/project

Verification¶

After installation, verify it works:

# Show help
twelve-factor-reviewer --help

# Run on current directory
twelve-factor-reviewer .

Updating¶

For Git installations¶

cd 12factor-kit
git pull origin main

For system-wide installations¶

cd 12factor-kit
git pull origin main
sudo ./install.sh

For Docker¶

docker pull phdsystems/12factor-reviewer

Uninstallation¶

Remove local installation¶

rm -rf 12factor-kit

Remove system-wide installation¶

sudo rm /usr/local/bin/twelve-factor-reviewer

Remove Docker image¶

docker rmi 12factor-reviewer

Troubleshooting¶

Permission Denied¶

chmod +x bin/twelve-factor-reviewer

Command Not Found¶

Add to PATH:

export PATH="$PATH:/path/to/12factor-kit/bin"

Docker Volume Issues¶

Use absolute paths:

docker run -v $(pwd):/project 12factor-reviewer