commands.md

Commands

This document describing commands that can be used in local shell or inside symfony container shell.

Local shell (Makefile)

This environment comes with "Makefile" and it allow to simplify using some functionality. In order to use command listed bellow just use next syntax in your local shell: make {command name}. Next commands available for this environment:

make build                      # Build dev environment
make build-test                 # Build test or continuous integration environment
make build-staging              # Build staging environment
make build-prod                 # Build prod environment

make start                      # Start dev environment
make start-test                 # Start test or continuous integration environment
make start-staging              # Start staging environment
make start-prod                 # Start prod environment

make stop                       # Stop dev environment
make stop-test                  # Stop test or continuous integration environment
make stop-staging               # Stop staging environment
make stop-prod                  # Stop prod environment

make restart                    # Stop and start dev environment
make restart-test               # Stop and start test or continuous integration environment
make restart-staging            # Stop and start staging environment
make restart-prod               # Stop and start prod environment

make env-staging                # Create cached config file .env.local.php (usually for staging environment)
make env-prod                   # Create cached config file .env.local.php (usually for prod environment)

make ssh                        # Enter symfony container shell
make ssh-nginx                  # Enter nginx container shell
make ssh-supervisord            # Enter supervisord container shell (cron jobs running there, etc...)
make ssh-mysql                  # Enter mysql container shell
make ssh-rabbitmq               # Enter rabbitmq container shell

make exec                       # Exucute some command defined in cmd="..." variable inside symfony container shell
make exec-bash                  # Execute several commands defined in cmd="..." variable inside symfony container shell

make report-prepare             # Create /reports/coverage folder, will be used for report after running tests
make report-clean               # Delete all reports in /reports/ folder

make wait-for-db                # Checking MySQL database availability, currently using for CircleCI (see /.circleci folder)

make composer-install-no-dev    # Installing composer dependencies for prod environment (without dev tools)
make composer-install           # Installing composer dependencies for dev environment
make composer-update            # Update composer dependencies

make info                       # Display information about symfony version and php version

make logs                       # Display logs for symfony container. Use ctrl+c in order to exit
make logs-nginx                 # Display logs for nginx container. Use ctrl+c in order to exit
make logs-supervisord           # Display logs for supervisord container. Use ctrl+c in order to exit
make logs-mysql                 # Display logs for mysql container. Use ctrl+c in order to exit
make logs-rabbitmq              # Display logs for rabbitmq container. Use ctrl+c in order to exit

make drop-migrate               # Drop databases (main and for tests) and run all migrations
make migrate                    # Run all migrations for databases (main and for tests)
make migrate-no-test            # Run all migrations for main database

make fixtures                   # Run all fixtures for test database without --append option (tables will be dropped and recreated)

make messenger-setup-transports # Initialize transports for Messenger component

make phpunit                    # Run all tests
make report-code-coverage       # Update code coverage report on https://coveralls.io (COVERALLS_REPO_TOKEN should be set on CI side)

make ecs                        # Run The Easiest Way to Use Any Coding Standard
make ecs-fix                    # Run The Easiest Way to Use Any Coding Standard to fix issues
make phpcs                      # Run PHP CodeSniffer
make phpmetrics                 # Generates PhpMetrics static analysis
make phpcpd                     # Run php copy/paste detector
make phpmd                      # Run php mess detector
make phpstan                    # Run php static analysis tool
make phpinsights                # Run phpinsights PHP quality checks

Symfony container shell

Inside symfony container shell available "native" symfony commands with their description and, in additional, custom commands. In order to enter inside symfony container shell please use next command on your local shell:

make ssh

After above command you will be inside symfony container and for display list of available commands please use next command:

./bin/console

Custom commands in symfony container shell

./bin/console db:wait                    # Waits for database availability (1 mins max)
./bin/console messenger:setup-transports # Initialize transports for Messenger component