diff --git a/usage.md b/usage.md index 6c87cc8..938bbbc 100644 --- a/usage.md +++ b/usage.md @@ -1,38 +1,48 @@ # Warden Usage -## Common Commands +## Environment Management -Launch a shell session within the project environment's `php-fpm` container: +Starting a stopped environment: - warden shell + warden env start Stopping a running environment: warden env stop -Starting a stopped environment: +Display the resolved environment configuration in `docker-compose` format: - warden env start + warden env config -Import a database (if you don't have `pv` installed, use `cat` instead): +Tail environment nginx and php logs: - pv /path/to/dump.sql.gz | gunzip -c | warden db import + warden env logs --tail 0 -f nginx php-fpm php-debug -Monitor database processlist: +Remove volumes completely: - watch -n 3 "warden db connect -A -e 'show processlist'" + warden env down -v -Tail environment nginx and php logs: +## Shell Access - warden env logs --tail 0 -f nginx php-fpm php-debug +Launch a shell session within the project environment's `php-fpm` container: -Tail the varnish activity log: + warden shell - warden env exec -T varnish varnishlog +Launch a debug-enabled shell (Xdebug) session: -Flush varnish: + warden debug + +## Database + +Import a database (if you don't have `pv` installed, use `cat` instead): + + pv /path/to/dump.sql.gz | gunzip -c | warden db import + +Monitor database processlist: + + watch -n 3 "warden db connect -A -e 'show processlist'" - warden env exec -T varnish varnishadm 'ban req.url ~ .' +## Redis / Valkey Connect to redis/valkey: @@ -44,15 +54,23 @@ Flush redis/valkey completely: warden redis flushall warden valkey flushall -Run redis continuous stat mode +Run redis continuous stat mode: warden redis --stat -Remove volumes completely: +## Varnish - warden env down -v +Tail the varnish activity log: + + warden env exec -T varnish varnishlog + +Flush varnish: + + warden env exec -T varnish varnishadm 'ban req.url ~ .' + +## Troubleshooting -Warden troubleshooting and debug information +Warden troubleshooting and debug information: warden doctor