|
1 | | -## Sneak Peek (Beta release targeted on May 19th for Windows, Mac and Linux) |
| 1 | +# CmdCompass: Your Command-Line Compass (executable will be released in 6 hours after some testing) |
| 2 | +<img src="https://github.com/johnwangwyx/cmdCompass/assets/78456315/2c58004e-4d2f-4982-bda3-ed53ad6d7c79" height="150"> |
| 3 | + |
| 4 | +## Overview |
| 5 | + |
| 6 | +cmdCompass is a desktop application that helps you manage and organize your command line commands. |
| 7 | + |
| 8 | +**Key Features:** |
| 9 | + |
| 10 | +* **Collections:** Group related commands into collections for easy access. |
| 11 | +* **Tags:** Categorize commands using tags with customizable colors. |
| 12 | +* **Command Templates:** Define commands with variables for dynamic replacement. |
| 13 | +* **Man (Manual) Page Integration:** View man pages directly within the app. Support automatic Highlighting for your command options. |
| 14 | +* **Comments:** Add notes and descriptions to commands for better understanding. |
| 15 | +* **Dark/Light Mode:** Choose your preferred theme. |
| 16 | +* **Cross-Platform:** Works on Windows, and macOS. (Linux support will be added by May 26th) |
| 17 | + |
| 18 | +## Screenshots |
| 19 | + |
2 | 20 | ### Feature: Command templating for variables replacement |
3 | 21 |  |
4 | 22 | ### Feature: Automatic Man Page Option Hightling |
5 | | -<img src="https://github.com/johnwangwyx/cmdCompass/assets/78456315/ef61b501-7186-4e1a-afa8-8837871b3810" width="600"> |
| 23 | + |
| 24 | + |
| 25 | + |
6 | 26 |
|
7 | 27 | ### Support 1000+ Cached Core Utility Man pages for instant Lookup. (With the ability to get ~90000 Man pages from ~60000 packages from download and converted to HTML) |
8 | 28 |
|
9 | | - |
| 29 | +<img src="https://github.com/johnwangwyx/cmdCompass/assets/78456315/7f1c15be-61a0-4d0c-98ea-3d450357916d" width="600"> |
| 30 | + |
| 31 | +## User Installation |
| 32 | + |
| 33 | +### Mac |
| 34 | +The tool uses [GNU Roff](https://www.gnu.org/software/groff/) to convert downloaded man pages to HTML. |
| 35 | + |
| 36 | +Please install groff by: |
| 37 | + |
| 38 | +`brew install groff` |
| 39 | + |
| 40 | +TBC |
| 41 | + |
| 42 | +### Windows |
| 43 | +TBC |
| 44 | + |
10 | 45 |
|
| 46 | +## Contributing |
11 | 47 |
|
| 48 | +Contributions are welcome! Please feel free to open issues or submit pull requests. The tool is still in early stage so please bear with me. :) |
| 49 | +A detailed breakdown of the components and dev instruction will be shortly uploaded to the readme. |
0 commit comments