Skip to main content

cmdhelp

This is a simple cli tool to store commands in a sqlite database which is written in GO. A simple cli tool to store and retrieve data such as example commands.

The commands are stored in a sqlite database. User can add various example commands for each individual tool.

How to build

Github Source for cmdhelp

Want to download the pre build binary and use it download from the release

Install in linux cmdhelp

go install github.com/secopsbear/cmdhelp@latest

To generate binaries Makefile is provided

Build for linux

make build_linux

Build for window

Generate an executable cmdhelp.exe for windows environment.

make build_windows

Setup and Initialize the database

The database is created in the .cmdhelp of the users home folder with init subcommand. It creates a cmdhelp.db database with table helpcommands where all the commands are stored.

cmdhelp init

cmdhelp database initialization

Add a new commands to database

Select New command and enter the brief description about the command and the command

cmdhelp add

Add new command

list all the commands

This command lists all commands stored in the database.

cmdhelp list

list commands

Add new command to existing tool

Add command to the existing tool in the database. The same command cmdhelp add is used to enter the data by selecting the right tool.

Add command to the existing tool

command lookup

lookup with parameter

This subcommand lookup help to search for the commands associated with tool

cmdhelp lookup <lookup-tool>

lookup

lookup without parameter

Search for the commands for the tool without passing the parameter.

cmdhelp lookup

lookup without parameter

delete command

Delete the command from the tool.

cmdhelp delete

delete command

Find a bug?

If you found an issue or would like to submit an improvement to this project, please submit an issue using the issues tab above.