Skip to content

Commit 1f217a9

Browse files
authored
Merge pull request #50 from lbajsarowicz/docs/reorganize-usage-by-service
docs: reorganize usage page by service type
2 parents 28183cd + 694cfcf commit 1f217a9

1 file changed

Lines changed: 37 additions & 19 deletions

File tree

usage.md

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,48 @@
11
# Warden Usage
22

3-
## Common Commands
3+
## Environment Management
44

5-
Launch a shell session within the project environment's `php-fpm` container:
5+
Starting a stopped environment:
66

7-
warden shell
7+
warden env start
88

99
Stopping a running environment:
1010

1111
warden env stop
1212

13-
Starting a stopped environment:
13+
Display the resolved environment configuration in `docker-compose` format:
1414

15-
warden env start
15+
warden env config
1616

17-
Import a database (if you don't have `pv` installed, use `cat` instead):
17+
Tail environment nginx and php logs:
1818

19-
pv /path/to/dump.sql.gz | gunzip -c | warden db import
19+
warden env logs --tail 0 -f nginx php-fpm php-debug
2020

21-
Monitor database processlist:
21+
Remove volumes completely:
2222

23-
watch -n 3 "warden db connect -A -e 'show processlist'"
23+
warden env down -v
2424

25-
Tail environment nginx and php logs:
25+
## Shell Access
2626

27-
warden env logs --tail 0 -f nginx php-fpm php-debug
27+
Launch a shell session within the project environment's `php-fpm` container:
2828

29-
Tail the varnish activity log:
29+
warden shell
3030

31-
warden env exec -T varnish varnishlog
31+
Launch a debug-enabled shell (Xdebug) session:
3232

33-
Flush varnish:
33+
warden debug
34+
35+
## Database
36+
37+
Import a database (if you don't have `pv` installed, use `cat` instead):
38+
39+
pv /path/to/dump.sql.gz | gunzip -c | warden db import
40+
41+
Monitor database processlist:
42+
43+
watch -n 3 "warden db connect -A -e 'show processlist'"
3444

35-
warden env exec -T varnish varnishadm 'ban req.url ~ .'
45+
## Redis / Valkey
3646

3747
Connect to redis/valkey:
3848

@@ -44,15 +54,23 @@ Flush redis/valkey completely:
4454
warden redis flushall
4555
warden valkey flushall
4656

47-
Run redis continuous stat mode
57+
Run redis continuous stat mode:
4858

4959
warden redis --stat
5060

51-
Remove volumes completely:
61+
## Varnish
5262

53-
warden env down -v
63+
Tail the varnish activity log:
64+
65+
warden env exec -T varnish varnishlog
66+
67+
Flush varnish:
68+
69+
warden env exec -T varnish varnishadm 'ban req.url ~ .'
70+
71+
## Troubleshooting
5472

55-
Warden troubleshooting and debug information
73+
Warden troubleshooting and debug information:
5674

5775
warden doctor
5876

0 commit comments

Comments
 (0)