:orphan:

.. title:: CONFIG_MCUMGR_CMD_SHELL_MGMT

.. kconfig:: CONFIG_MCUMGR_CMD_SHELL_MGMT

CONFIG_MCUMGR_CMD_SHELL_MGMT
############################

*Enable mcumgr handlers for shell management*

Type: ``bool``

Help
====

.. code-block:: none

    Enables mcumgr handlers for shell management. The handler will utilize
    the dummy backend to execute shell commands and capture the output to
    an internal memory buffer. This way, there is no interaction with
    physical interfaces outside of the scope of the user.
    It is possible to use additional shell backends in coordination
    with this handler and they will not interfere.
    The SHELL_BACKEND_DUMMY_BUF_SIZE will affect how many characters
    will be returned from command output, if your output gets cut, then
    increase the value. Remember to set MCUMGR_BUF_SIZE accordingly.

Direct dependencies
===================

\ :kconfig:`SHELL <CONFIG_SHELL>` && \ :kconfig:`MCUMGR <CONFIG_MCUMGR>`

*(Includes any dependencies from ifs and menus.)*

Defaults
========

No defaults. Implicitly defaults to ``n``.

Symbols selected by this symbol
===============================

- \ :kconfig:`SHELL_BACKEND_DUMMY <CONFIG_SHELL_BACKEND_DUMMY>`

Kconfig definition
==================



At ``<Zephyr Subsystem>/mgmt/mcumgr/Kconfig:126``

Included via ``Kconfig:8`` → ``Kconfig.zephyr:44`` → ``<Zephyr Subsystem>/Kconfig:35`` → ``<Zephyr Subsystem>/mgmt/Kconfig:9``

Menu path: (Top) → Sub Systems and OS Services → Device Management → mcumgr Support → Command Handlers

.. code-block:: kconfig

    config MCUMGR_CMD_SHELL_MGMT
    	bool "Enable mcumgr handlers for shell management"
    	select SHELL_BACKEND_DUMMY
    	depends on SHELL && MCUMGR
    	help
    	  Enables mcumgr handlers for shell management. The handler will utilize
    	  the dummy backend to execute shell commands and capture the output to
    	  an internal memory buffer. This way, there is no interaction with
    	  physical interfaces outside of the scope of the user.
    	  It is possible to use additional shell backends in coordination
    	  with this handler and they will not interfere.
    	  The SHELL_BACKEND_DUMMY_BUF_SIZE will affect how many characters
    	  will be returned from command output, if your output gets cut, then
    	  increase the value. Remember to set MCUMGR_BUF_SIZE accordingly.

*(The 'depends on' condition includes propagated dependencies from ifs and menus.)*