Prompt¶
cmd2
issues a configurable prompt before soliciting user input.
Customizing the Prompt¶
This prompt can be configured by setting the cmd2.Cmd.prompt
instance
attribute. This contains the string which should be printed as a prompt
for user input. See the Pirate example for the simple use case of statically
setting the prompt.
Continuation Prompt¶
When a user types a
Multiline Command
it may span more than one line of input. The prompt for the first line of input
is specified by the cmd2.Cmd.prompt
instance attribute. The prompt for
subsequent lines of input is defined by the
cmd2.Cmd.continuation_prompt
attribute.See the Initialization example
for a demonstration of customizing the continuation prompt.
Updating the prompt¶
If you wish to update the prompt between commands, you can do so using one of the Application Lifecycle Hooks such as a Postcommand hook. See PythonScripting for an example of dynamically updating the prompt.
Asynchronous Feedback¶
cmd2
provides two functions to provide asynchronous feedback to the user
without interfering with the command line. This means the feedback is provided
to the user when they are still entering text at the prompt. To use this
functionality, the application must be running in a terminal that supports
VT100 control characters and readline. Linux, Mac, and Windows 10 and greater
all support these.
cmd2
also provides a function to change the title of the terminal window.
This feature requires the application be running in a terminal that supports
VT100 control characters. Linux, Mac, and Windows 10 and greater all support
these.
The easiest way to understand these functions is to see the AsyncPrinting example for a demonstration.