Startup Commands
cmd2 provides a couple different ways for running commands immediately after your application
starts up:
- Commands at Invocation
- Startup Script
Commands run as part of a startup script are always run immediately after the application finishes initializing so they are guaranteed to run before any Commands At Invocation.
Commands At Invocation
By default, users can send commands to your app as you invoke it by including them as extra
arguments to the program. cmd2 interprets each argument as a separate command, so you should
enclose each command in quotation marks if it is more than a one-word command. You can use either
single or double quotes for this purpose.
$ uv run examples/cmd_as_argument.py "say hello" "say Gracie" quit
hello
Gracie
You can end your commands with a quit command so that your cmd2 application runs like a
non-interactive command-line utility (CLU). This means that it can then be scripted from an external
application and easily used in automation.
Note
If you wish to disable cmd2's consumption of command-line arguments, you can do so by setting the allow_cli_args argument of your cmd2.Cmd class instance to False.
This would be useful, for example, if you wish to use something like argparse to parse the overall command line arguments
for your application:
Tip
If you want to use something like argparse to parse the overall command line arguments for your application
but still want to be able to pass any extra arguments to your application as commands, then see the if __name__ == "__main__": block at the end of the
argparse_example.py example.
This can be run like so:
Startup Script
You can execute commands from an initialization script by passing a file path to the
startup_script argument to the cmd2.Cmd.__init__() method like so:
This text file should contain a Command Script. See the getting_started.py example for a demonstration.
You can silence a startup script's output by setting silence_startup_script to True:
Warning
Anything written to stderr will still print for a "silenced" startup script. Additionally, a startup script cannot be silenced if
allow_redirection is False since silencing works by redirecting a script's output to os.devnull.