Skip to content

Commit 0067c7e

Browse files
committed
Improved the organization of how cmd2's features are highlighted in the README.md
1 parent ea41dde commit 0067c7e

1 file changed

Lines changed: 45 additions & 17 deletions

File tree

‎README.md‎

Lines changed: 45 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -92,26 +92,54 @@ to build a more complete application.
9292

9393
### Give users a capable interface from day one
9494

95-
- Context-aware [tab completion](https://cmd2.readthedocs.io/en/latest/features/completion/) for
96-
commands, subcommands, options, choices, file paths, and custom data sources.
97-
- Generated, categorized [help](https://cmd2.readthedocs.io/en/latest/features/help/) that stays in
98-
sync with each command's argument parser.
99-
- Editable and optionally persistent
100-
[history](https://cmd2.readthedocs.io/en/latest/features/history/), multiline commands,
101-
configurable prompts, runtime settings, and built-in editor support.
102-
- [Aliases, macros, and shortcuts](https://cmd2.readthedocs.io/en/latest/features/shortcuts_aliases_macros/)
103-
that let users adapt repetitive workflows without application changes.
104-
- [Pipes and output redirection](https://cmd2.readthedocs.io/en/latest/features/redirection/), shell
105-
commands, clipboard integration, and styled terminal output.
95+
- **Tab completion:** provide context-aware completion for commands, subcommands, options, choices,
96+
file paths, and custom data sources, with descriptive hints for completion candidates. Learn more
97+
about [completion](https://cmd2.readthedocs.io/en/latest/features/completion/).
98+
- **History:** search, edit, rerun, save, and optionally persist previously entered commands. Users
99+
also get familiar navigation and reverse search such as <kbd>Ctrl</kbd>+<kbd>R</kbd>. Learn more
100+
about [history](https://cmd2.readthedocs.io/en/latest/features/history/).
101+
- **Unicode:** accept Unicode in commands, arguments, file names, and output, and run UTF-8 command
102+
scripts for applications used in any language. Learn more about
103+
[command scripts](https://cmd2.readthedocs.io/en/latest/features/scripting/#command-scripts).
104+
- **Shell shortcuts and hotkeys:** use familiar Readline-style keyboard shortcuts for navigating and
105+
editing the command line, including Emacs-style bindings provided by `prompt-toolkit`. Learn more
106+
about [keyboard shortcuts](https://cmd2.readthedocs.io/en/latest/features/history/#for-users).
107+
- **Help:** generate discoverable, categorized help for commands, subcommands, and arguments
108+
directly from their argument parsers. Learn more about
109+
[help](https://cmd2.readthedocs.io/en/latest/features/help/).
110+
- **Rich UI/UX:** offer syntax highlighting, Fish-style history suggestions, multiline input,
111+
configurable prompts, completion menus, themes, and an optional bottom toolbar. Learn more about
112+
[prompts and toolbars](https://cmd2.readthedocs.io/en/latest/features/prompt/) and
113+
[themes](https://cmd2.readthedocs.io/en/latest/features/theme/).
106114

107115
### Grow from exploration to automation
108116

109-
An interactive session does not have to become a dead end. Users can replay commands from history,
110-
save and run command scripts, execute Python scripts, pass startup commands from the shell, or use a
111-
Python API exposed by the application. The commands they discover interactively become the same
112-
commands they automate later. See the
113-
[scripting guide](https://cmd2.readthedocs.io/en/latest/features/scripting/) for the available
114-
approaches.
117+
- **Shell scripting:** automate the same commands users run interactively by passing them as command
118+
arguments or standard input from shell scripts. Learn more about
119+
[automating cmd2 applications](https://cmd2.readthedocs.io/en/latest/features/os/#automating-cmd2-apps-from-other-cliclu-tools).
120+
- **Python scripting:** run Python scripts inside the application for loops, branching, complex
121+
control flow, and integration with the application's commands and data. Learn more about
122+
[Python scripts](https://cmd2.readthedocs.io/en/latest/features/scripting/#python-scripts).
123+
- **Run shell commands:** execute operating-system commands without leaving the application, using
124+
the built-in `shell` command or its `!` shortcut. Learn more about
125+
[OS integration](https://cmd2.readthedocs.io/en/latest/features/os/#executing-os-commands-from-within-cmd2).
126+
- **Redirect output:** send command output to files or the clipboard, or pipe it through one or more
127+
shell commands. Learn more about
128+
[output redirection and pipes](https://cmd2.readthedocs.io/en/latest/features/redirection/).
129+
- **Aliases, macros, and shortcuts:** let users customize names, parameterized commands, and terse
130+
shortcuts for repetitive workflows without changing the application. Learn more about
131+
[aliases, macros, and shortcuts](https://cmd2.readthedocs.io/en/latest/features/shortcuts_aliases_macros/).
132+
- **Startup scripts:** initialize an application consistently by running saved commands every time
133+
it starts. Learn more about
134+
[startup commands and scripts](https://cmd2.readthedocs.io/en/latest/features/startup_commands/).
135+
- **Embedded Python and IPython shells:** drop into an interactive Python or IPython session for
136+
experimentation, debugging, object introspection, and access to application state. Learn more
137+
about
138+
[embedded Python shells](https://cmd2.readthedocs.io/en/latest/features/embedded_python_shells/).
139+
- **Color, style, and tables:** produce readable output with Rich colors and styles, custom themes,
140+
paging, and flexible table layouts. Learn more about
141+
[generating output](https://cmd2.readthedocs.io/en/latest/features/generating_output/) and
142+
[creating tables](https://cmd2.readthedocs.io/en/latest/features/table_creation/).
115143

116144
## Installation
117145

0 commit comments

Comments
 (0)