From 850a98dce493352169066f64cc25e0c5e1ad4c29 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Oufella?=
 <jerome.oufella@savoirfairelinux.com>
Date: Sat, 24 Feb 2024 22:44:19 -0500
Subject: [PATCH] doc: document 'cqfd shell'

---
 CHANGELOG.md |  1 +
 README.md    | 11 +++++++++++
 2 files changed, 12 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5b4ad46..2b93ffe 100644
--- 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
index 0be8d49..162875f 100644
--- 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