deep-breath-cli 1.0.0

A command-line tool designed to help you relax from your terminal.

Deep Breath CLI

Deep Breath CLI is a command-line tool designed to help you relax, regain focus, and boost your energy—right from your terminal.

🌬️ What is Deep Breath CLI?

Whether you're coding, studying, or just need a quick break, Deep Breath CLI offers guided breathing exercises with visual progress bars and calming colors. With simple commands, you can access different breathing patterns to help you reset and recharge.

🚀 Features

• Multiple breathing patterns (4-7-8, Box breathing)
• Visual progress bars with calming colors
• Customizable session lengths and cycles
• Track your progress with detailed statistics
• Create, modify, and delete custom breathing patterns
• Clear, distraction-free interface
• Easy preset management

🛠️ Installation

Install from PyPI:

pip install deep-breath-cli

⚡️ Usage

Start a breathing session

# Default session (4 cycles of 4-7-8 pattern)
breath start

# Custom number of cycles
breath start --cycle 8

# Different breathing pattern
breath start --pattern "4-4-4-4"

# Use a custom pattern
breath start --pattern "my-custom"

# Combined options
breath start --cycle 6 --pattern "4-4-4-4"

View available patterns (including custom ones)

breath presets

Output:

Available breathing patterns:
  4-7-8: 4s Breathe in..., 7s Hold..., 8s Breathe out... (built-in)
  4-4-4-4: 4s Breathe in..., 4s Hold..., 4s Breathe out..., 4s Hold... (built-in)
  my-custom: 3s Breathe in..., 5s Hold..., 4s Breathe out... (custom)

You can use these patterns with the --pattern option.

Track your progress

Monitor your breathing journey with detailed statistics:

breath stats

Example output:

Your Breathing Stats
            Total sessions: 7
            Total time: 2 minutes
            Favorite pattern: 4-4-4-4 (2 sessions)
            Current streak: 2 days

Custom patterns

Create your own breathing patterns tailored to your needs:

Create a new pattern

breath create-pattern "my-custom"

This will guide you through an interactive process to define each phase of your breathing pattern.

Modify an existing pattern

breath modify-pattern "my-custom"

Delete a pattern

breath delete-pattern "my-custom"

Get help

breath --help
breath start --help

🌟 Breathing Patterns

• 4-7-8: Relaxation pattern (inhale 4s, hold 7s, exhale 8s)
• 4-4-4-4: Box breathing for focus (inhale 4s, hold 4s, exhale 4s, hold 4s)
• Custom patterns: Create your own with any number of phases and durations

🤔 Why use Deep Breath CLI?

• Quick: Take a break without leaving your terminal
• Effective: Scientifically-backed breathing techniques
• Customizable: Choose the pattern and duration that fits your needs
• Progress tracking: Monitor your breathing journey with detailed statistics
• Distraction-free: Clear your mind with simple, focused interface

🛠️ Development

Setup (with uv, which I used to develop this package)

git clone https://github.com/weart99/deep-breath-cli
cd deep-breath-cli
uv sync --extra dev

Running tests

uv run pytest tests/ --cov=src

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests and ensure they pass
5. Submit a pull request

📄 License

MIT Licence

Authors

@weart99

---

Take a deep breath, and let's get started! 🌬️