Shell

fm shell¶

Spawn shell for the bench or execute a command.

Supports interactive shells, single command execution (-c), heredoc or piped input, and bench-console mode which runs Python code inside an initialized Frappe context.

Usage:

$ fm shell BENCHNAME [OPTIONS]

Arguments:

• BENCHNAME: Name of the bench.

Options:

• --command: Execute command and exit [default: -c]
• --user: User to connect as
• --service: Service to connect to
• --shell-path: Shell path (e.g., /bin/bash, /bin/sh)
• --run: Use 'docker compose run --rm'
• --bench-console: Open bench console with Frappe context (interactive IPython or execute code via -c/stdin)
• --site: Site name for bench console (defaults to benchname if not specified)

Examples¶

Open interactive shell as frappe user¶

Opens an interactive shell into the frappe service as the frappe user. Useful for ad-hoc debugging.

fm shell mybench

Open shell as root user¶

Starts a shell session in the container as the root user. Use with caution for administrative tasks.

fm shell mybench --user root

Execute single command¶

Runs a single command inside the service and exits with the command's exit code.

fm shell mybench -c "bench --version"

Execute commands from heredoc¶

Sends a heredoc to the container and executes the provided commands non-interactively.

fm shell mybench <<'EOF'
ls -la
bench --version
EOF

Open shell in nginx container¶

Opens a shell session inside the nginx container for debugging webserver configuration.

fm shell mybench --service nginx --user nginx

Run command with passthrough syntax¶

Passes through arguments after '--' directly to the container's shell or compose command.

fm shell mybench -- bench migrate

Open interactive bench console with IPython¶

Opens an IPython console with Frappe initialized so you can interact with frappe APIs.

fm shell mybench --bench-console

Open bench console for specific site¶

Opens the bench console for a specific site; useful when the bench hosts multiple sites.

fm shell mybench --bench-console --site mysite.localhost

Execute Python code in Frappe context¶

Executes a single Python statement inside the Frappe context and prints the result.

fm shell mybench --bench-console -c "import frappe; print(frappe.__version__)"

Execute Python script from heredoc in Frappe context¶

Executes a multi-line Python script inside the Frappe context provided via heredoc.

fm shell mybench --bench-console <<'EOF'
import frappe
print(frappe.__version__)
EOF

Execute Python script file in Frappe context¶

Reads a Python script from a file and executes it inside the bench's Frappe context.

fm shell mybench --bench-console < script.py