doc: document 'cqfd shell'

savoirfairelinux · Feb 25, 2024 · 850a98d · 850a98d
1 parent 0e1704e
commit 850a98d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## Version 5.5.0-dev (coming soon)
 
+* Add the `shell` command.
 * Pre-existing (custom) Docker images can now be used.
 * bash-completion config is back up to date.
 * Misc. fixes.

diff --git a/README.md b/README.md
@@ -225,6 +225,17 @@ The `-c` option allows appending the command of a cqfd run for temporary develop
     $ cqfd -b centos7 -c "clean"
     $ cqfd -b centos7 -c "TRACING=1"
 
+### Running a shell in the container ###
+
+You can use the `shell` command to quickly pop a shell in your defined
+container. The shell to be launched (default `/bin/sh`) can be customized using
+the `CQFD_SHELL` environment variable.
+
+Example:
+
+    fred@host:~/project$ cqfd shell
+    fred@container:~/project$
+
 ### Other command-line options ###
 
 In some conditions you may want to use alternate cqfd filenames and / or an