calendarN

README

CalendarN

A powerful CLI tool for working with Nepali (Bikram Sambat) and English (Gregorian) calendars.

Quick Start

# Install via Homebrew
brew tap samit22/calendarN https://github.com/samit22/calendarN
brew install calendarn

# View today's date
calendarN today

# Convert English to Nepali
calendarN convert etn 2024-12-25

# Convert Nepali to English
calendarN convert nte 2081-09-10

Table of Contents

• Features
• Installation
• Usage
  • Today
  • Calendars
  • Date Conversion
  • Countdown
• Supported Date Range
• Development
• Contributing
• License

Features

Feature	Description
View Calendars	Display Nepali (BS) and English calendars
Date Conversion	Convert dates between Nepali and English (both directions)
Countdowns	Create and manage countdowns to important dates
Year Progress	Track year progress with visual progress bars
Beautiful Output	Colorful terminal output with Devanagari support

Installation

Homebrew (Recommended)

brew tap samit22/calendarN https://github.com/samit22/calendarN
brew install calendarn

# Upgrade to latest
brew upgrade calendarn

Go Install

go install github.com/samit22/calendarN@latest

Build from Source

git clone https://github.com/samit22/calendarN.git
cd calendarN
make build
./calendarN --help

Manual Download

Download the latest release from the Releases page.

Usage

Today

Display today's date in both Nepali and English with year progress.

calendarN today           # Full output with progress bar
calendarN today -m        # Minified output
calendarN today -j        # JSON format

Example Output:

$ calendarN today -m
बुधवार, २५ पुष, २०८१ | Wednesday, 25 December, 2024

Calendars

Nepali Calendar

calendarN nep             # Current month
calendarN nep 2081-09     # Specific year and month (BS)

English Calendar

calendarN eng             # Current month
calendarN eng 2024-12     # Specific year and month

Date Conversion

Convert dates between English (Gregorian) and Nepali (Bikram Sambat) calendars.

English to Nepali (etn)

$ calendarN convert etn 2024-12-25
Eng: 2024-12-25 => 2081-09-10 || २०८१-०९-१०

Nepali to English (nte)

$ calendarN convert nte 2081-09-10
Nep: 2081-09-10 => 2024-12-25

Countdown

Create and manage countdowns to important dates.

Create Countdown

calendarN countdown 2025-01-01                       # Quick countdown
calendarN countdown -n "New Year" 2025-01-01 -s      # Named and saved
calendarN countdown -n "Meeting" 2025-01-15 14:30:00 -s  # With time

Flags:

Flag	Description
-n, --name	Name for the countdown
-r, --run	Run for n seconds (default: 5, use -1 for infinite)
-s, --save	Save the countdown
-o, --overwrite	Overwrite existing countdown

Manage Countdowns

calendarN countdown all              # List all saved
calendarN countdown show -n "Name"   # Show specific
calendarN countdown delete -n "Name" # Delete

Version

calendarN version

Supported Date Range

Calendar	Range
Nepali (BS)	2000 BS - 2090 BS
English (AD)	1944 AD onwards

Development

git clone https://github.com/samit22/calendarN.git
cd calendarN

make test         # Run tests
make build        # Build binary
make release-all  # Cross-compile for all platforms

Requirements: Go 1.21+

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Ensure test coverage is adequate (80%+)
4. Commit your changes (git commit -m 'Add amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a Pull Request

For bugs or feature requests, please create an issue.

License

MIT License - see LICENSE for details.

Author

Samit Ghimire - info@samitghimire.com.np

Documentation

Overview

Copyright © 2022 Samit info@samitghimire.com.np

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.