madewithlove/htaccess-cli repository overview

⁠htaccess CLI

A CLI tool to test how .htaccess files behave

⁠Installation

To start performing analysis on your code, require htaccess CLI in Composer:

composer require --dev madewithlove/htaccess-cli

Composer will install htaccess-cli's executable in its bin-dir which defaults to vendor/bin.

⁠Usage

If your .htaccess file lives in your root directory, you can run the cli tool using

htaccess http://localhost/foo

Where the url is the request url you want to test your .htaccess file with.

⁠Usage through Docker

# install the container
docker pull madewithlove/htaccess-cli:latest

# run the htaccess tester in the current folder
docker run --rm -v $PWD:/app madewithlove/htaccess-cli [url] <options>

⁠CLI Options

The following options are available:

-r, --referrer[=REFERRER]          The referrer header, used as HTTP_REFERER in apache
-s, --server-name[=SERVER-NAME]    The configured server name, used as SERVER_NAME in apache
-e, --expected-url[=EXPECTED-URL]  When configured, errors when the output url does not equal this url
-h, --help                         Display a help message

⁠Note

The tool simulates only one pass through the server, while Apache will do multiple if you get back on the same domain. This is a feature we might still add in the future, but it's a limitation for now.