command-book 8.1.0

CLI to save and run commands with interactive parameters

Command Book (bb)

CLI to save, search and run custom commands with interactive parameters.

Installation

pip install command-book
bb --install-completion
# reload console

Usage

bb                      # Open the interactive fuzzy menu
bb add                  # Register a new command
bb list                 # List all saved commands
bb run <name>           # Run a command (prompts for parameters if needed)
bb remove <name>        # Delete a command
bb edit <name>          # Open the command in $EDITOR
bb search <term>        # Search by name, description or tag
bb tags                 # List all available tags
bb config               # Show or edit the config file
bb examples             # Show examples
bb --install-completion # Install shell completion

Command format

Commands use placeholders {{name}}, {{name::default}}, {{name_required}!},{{name_required::default}!} and more.

[commands.ssh-server]
cmd = "ssh {{user::root}}@{{host}} -p {{port::22}}"
description = "Connect to a server via SSH"
tags = ["ssh", "infra"]

Storage

Commands are saved to ~/.config/command_book/commands.toml.

Language

By default the language is detected from the LANG environment variable. Override it with CB_LANG:

CB_LANG=en bb   # English
CB_LANG=es bb   # Spanish

Development

Install

git clone https://github.com/tiyujopite/command_book
cd command-book
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"

Run tests

pytest --cov=command_book --cov-report=term-missing

Linting

flake8 command_book/