Skip to content
arifinsiddiqzisanPublic

About

A terminal-based command manager with an interactive TUI for storing, searching, and executing your personal CLI commands.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

CmdBook

CmdBook is a terminal-based command manager that helps you organize, search, and execute your frequently used CLI commands through an interactive TUI (Text User Interface).

It is designed for developers and Linux users who frequently customize their workflow and want a reliable way to store and reuse commands.


Preview

Interface

Interface

Add Command

Add Command

Edit Command

Edit Command

Manual View

Manual

Themes

Themes


Features

  • Interactive TUI with keyboard navigation
  • Add, edit, and delete commands
  • Run commands directly from the interface
  • Persistent storage using JSON
  • Lightweight and fast
  • Clean and minimal interface
  • Automatic data directory creation (no manual setup required)

Keybindings

Key Action
Up / Down Navigate
Enter Select
Ctrl + A Add command
Ctrl + E Edit command
Ctrl + D Delete
Ctrl + R Run command

Use Cases

  • Store frequently used Linux commands
  • Manage development shortcuts
  • Keep track of automation scripts
  • Build a personal command knowledge base

Installation

Linux (Manual Installation)

git clone https://github.com/arifinsiddiqzisan/cmdbook.git
cd cmdbook
pip install textual rich
sudo mv cmdbook.py /usr/local/bin/cmdbook
sudo chmod +x /usr/local/bin/cmdbook
cmdbook

On first run, CmdBook will automatically create the required data directory.


Linux (User-only Installation)

mkdir -p ~/.local/bin
mv cmdbook.py ~/.local/bin/cmdbook
chmod +x ~/.local/bin/cmdbook
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
cmdbook

Windows Installation

  1. Clone the repository:
git clone https://github.com/arifinsiddiqzisan/cmdbook.git
cd cmdbook
  1. Install dependencies:
pip install textual rich
  1. Create a tools directory:
mkdir C:\tools
  1. Move the script:
move cmdbook.py C:\tools\cmdbook.py
  1. Create a batch file (cmdbook.bat) inside C:\tools\:
@echo off
python C:\tools\cmdbook.py %*
  1. Add C:\tools to Environment Variables:
  • Open System Properties
  • Go to Environment Variables
  • Edit Path
  • Add: C:\tools
  1. Run:
cmdbook

CmdBook will automatically create its data directory on first run.


Requirements

  • Python 3
  • pip

Linux:

sudo apt install python3-pip
pip install textual rich

Windows:

pip install textual rich

Data Storage

CmdBook stores all commands in an OS-specific location:

Linux:

~/.cmdbook/commands.json

Windows:

C:\Users\YourName\cmdbook\commands.json

The directory and file are created automatically on first run.


Example Entry

Name: pyenv
Command: pyenv
Description: Manage Python virtual environments

Tech Stack

  • Python
  • Textual
  • Rich

Philosophy

CmdBook is built with a simple idea:

Your terminal should remember what you forget.

Instead of searching for commands repeatedly, store them once and access them instantly.


License

MIT License


Contributing

Contributions are welcome. You can:

  • Open issues
  • Suggest features
  • Submit pull requests

Author

Arifin Siddiq Zisan

About

A terminal-based command manager with an interactive TUI for storing, searching, and executing your personal CLI commands.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages