diff options
Diffstat (limited to 'docs/migrating/why.rst')
| -rw-r--r-- | docs/migrating/why.rst | 36 |
1 files changed, 20 insertions, 16 deletions
diff --git a/docs/migrating/why.rst b/docs/migrating/why.rst index 5445b03f..a166d648 100644 --- a/docs/migrating/why.rst +++ b/docs/migrating/why.rst @@ -32,18 +32,6 @@ further modifications. Migrating to ``cmd2`` will also open many additional doors for making it possible for developers to provide a top-notch interactive command-line experience for their users. -``cmd2`` provides a full-featured framework for creating professional-quality -interactive command-line applications. A few of the highlights of ``cmd2`` -include: - -* Applications created are full-featured shells in their own right with ability - to call shell commands, redirect command output, pipe command output to shell - commands, etc. -* Superior tab-completion capabilities, especially when using included argparse - decorators -* Both Python and ASCII text application scripting is built-in -* Ability to run non-interactively for automation purposes - Free Features ------------- @@ -51,10 +39,18 @@ Free Features After switching from cmd_ to ``cmd2``, your application will have the following new features and capabilities, without you having to do anything: -- More robust :ref:`features/history:History`. Both cmd_ and ``cmd2`` have readline - history, but ``cmd2`` also has a robust ``history`` command which allows you - to edit prior commands in a text editor of your choosing, re-run multiple - commands at a time, and save prior commands as a script to be executed later. +- More robust :ref:`features/history:History`. Both cmd_ and ``cmd2`` have + readline history, but ``cmd2`` also has a robust ``history`` command which + allows you to edit prior commands in a text editor of your choosing, re-run + multiple commands at a time, and save prior commands as a script to be + executed later. + +- Users can redirect output to a file or pipe it to some other operating system + command. You did remember to use ``self.stdout`` instead of ``sys.stdout`` in + all of your print functions, right? If you did, then this will work out of + the box. If you didn't, you'll have to go back and fix them. Before you do, + you might consider the various ways ``cmd2`` has of + :ref:`features/generating_output:Generating Output`. - Users can load script files, which contain a series of commands to be executed. @@ -76,3 +72,11 @@ new features and capabilities, without you having to do anything: ``cmd2``-based app. The transcript can be played back into the app as a unit test. + +Next Steps +---------- + +In addition to the features you get with no additional work, ``cmd2`` offers a +broad range of additional capabilties which can be easily added to your +application. :ref:`migrating/next_steps:Next Steps` has some ideas of where +you can start, or you can dig in to all the :ref:`features/index:Features`. |