Skip to content

dynamotn/dybatpho

Repository files navigation

dybatpho

Bash Script Coverage Status CI Latest release

dybatpho – A powerful collection of bash functions to help you build scripts efficiently, quickly, and maintainably!


🚀 Why choose dybatpho?

  • Save time: A curated set of the most popular & useful functions for working with Bash scripts.
  • Easy integration: Flexibly use as a submodule, subtree, or manual clone.
  • Battle-tested: Used in many projects, personal dotfiles, and in real CI/CD workflows.
  • Extensible: Easily add your own modules or customize to fit your needs.
  • Community-driven: Always open to feedback, suggestions, and PRs from everyone.

📖 What is dybatpho?

dybatpho is a portmanteau of đi bát phố - meaning "to wander and explore", just like this repo helps you discover and use handy bash functions freely and flexibly.

⚡️ Quick Start

  1. Add dybatpho to your project (pin the version if needed):

    • Submodule:

      git submodule add --depth 1 https://github.com/dynamotn/dybatpho.git <path>
      git submodule update <path> --remote
    • Subtree:

      git subtree add --prefix <path> https://github.com/dynamotn/dybatpho.git main --squash
      git subtree pull --prefix <path> https://github.com/dynamotn/dybatpho.git main --squash
    • Manual clone (for CI/CD, etc.):

      git clone https://github.com/dynamotn/dybatpho.git
  2. Source the logic you need:

    # Source the initialization script
    . <path-to-dybatpho>/init.sh

    See more example scripts or real-world usage in my dotfiles.

🗂 Directory Structure

.
├── doc/            # Module documentation
├── example/        # Example scripts for users
├── scripts/        # Helper scripts (test, doc generation, etc.)
├── src/            # Source code of modules
├── test/           # Unit tests
└── init.sh         # Initialization script, **must be sourced first**

📚 Contents & Featured Modules

🎯 Usage Example

# Using the log function
. dybatpho/init.sh
dybatpho::register_err_handler
dybatpho::info "Greetings from dybatpho!"

See more at example/.

💬 Contribution & Support

  • Open an Issue or Pull Request if you'd like to suggest ideas, fix bugs, or contribute new modules!
  • All feedback and contributions are welcome.

Get started with dybatpho now to optimize your workflow and save time with your Bash scripts!

Star dybatpho

About

My library for bash utility methods and tools

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  

Packages

No packages published

Languages