{"id":15487764,"url":"https://github.com/ahmadawais/ramadan-cli","last_synced_at":"2026-02-18T20:19:30.754Z","repository":{"id":42489231,"uuid":"258596649","full_name":"ahmadawais/ramadan-cli","owner":"ahmadawais","description":"CLI to check Sehar and Iftar times in Ramadan anywhere in the world. ","archived":false,"fork":false,"pushed_at":"2026-02-18T15:42:15.000Z","size":17281,"stargazers_count":206,"open_issues_count":0,"forks_count":23,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-18T18:25:57.789Z","etag":null,"topics":["cli","ramadan"],"latest_commit_sha":null,"homepage":"https://x.com/MrAhmadAwais/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ahmadawais.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":"contributing.md","funding":".github/funding.yml","license":"license","code_of_conduct":"code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"custom":["https://github.com/ahmadawais/sponsor","https://NodeCLI.com","https://VSCode.pro"]}},"created_at":"2020-04-24T18:48:50.000Z","updated_at":"2026-02-18T18:25:52.000Z","dependencies_parsed_at":"2022-09-03T08:41:06.324Z","dependency_job_id":null,"html_url":"https://github.com/ahmadawais/ramadan-cli","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"purl":"pkg:github/ahmadawais/ramadan-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadawais%2Framadan-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadawais%2Framadan-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadawais%2Framadan-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadawais%2Framadan-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ahmadawais","download_url":"https://codeload.github.com/ahmadawais/ramadan-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadawais%2Framadan-cli/sbom","scorecard":{"id":171942,"data":{"date":"2025-08-11","repo":{"name":"github.com/ahmadawais/ramadan-cli","commit":"6c8d47ee72a35dce818b09ef981651bb685019d5"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.2,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":1,"reason":"Found 3/30 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: license:0","Info: FSF or OSI recognized license: MIT License: license:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 3 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-16T16:46:36.356Z","repository_id":42489231,"created_at":"2025-08-16T16:46:36.356Z","updated_at":"2025-08-16T16:46:36.356Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29594248,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T18:54:29.675Z","status":"ssl_error","status_checked_at":"2026-02-18T18:50:50.517Z","response_time":162,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","ramadan"],"created_at":"2024-10-02T06:41:40.151Z","updated_at":"2026-02-18T20:19:30.745Z","avatar_url":"https://github.com/ahmadawais.png","language":"TypeScript","funding_links":["https://github.com/ahmadawais/sponsor","https://NodeCLI.com","https://VSCode.pro"],"categories":["TypeScript"],"sub_categories":[],"readme":"[![ramadan-cli](https://raw.githubusercontent.com/ahmadawais/ramadan-cli/refs/heads/main/.github/cover.png)](https://x.com/MrAhmadAwais/)\n\n# ramadan-cli 🌙\n\n[![DOWNLOADS](https://img.shields.io/npm/dt/ramadan-cli?label=npm\u0026colorA=151B23\u0026colorB=81F096\u0026style=for-the-badge)](https://www.npmjs.com/package/ramadan-cli)\n[![Node.js CLI](https://img.shields.io/badge/-NodeCLI.com-gray.svg?colorB=81F096\u0026style=for-the-badge)](https://NodeCLI.com/?utm_source=FOSS)\n[![Follow @MrAhmadAwais on X](https://img.shields.io/badge/FOLLOW%20%40MrAhmadAwais-gray.svg?colorA=151B23\u0026colorB=81F096\u0026style=for-the-badge)](https://x.com/mrahmadawais/)\n\n\u003e Ramadan-first CLI for Sehar and Iftar timings in your terminal.\n\nBuilt for humans and agents.\n\n## Why You'll Like It\n\n- 🌙 Ramadan-only output focused on Sehar/Iftar\n- 📍 Auto first-run setup (city, country, method, school, timezone)\n- 🌐 Auto-detect location via IP provider fallbacks\n- 🧭 Auto-recommend method and school by country\n- ⏱ Auto timezone detection for accurate countdowns\n- ✨ Highlights current + next Sehar/Iftar with countdown\n- 🗓 `-a, --all` for complete Ramadan month\n- 🔢 `-n, --number` for a specific roza day\n- 🧪 Custom first roza override (`--first-roza-date`)\n- 🧹 One-command reset (`reset`)\n\n[![ramadan-cli](https://raw.githubusercontent.com/ahmadawais/ramadan-cli/refs/heads/main/.github/ramadan.gif)](https://x.com/MrAhmadAwais/)\n\n\n## Install\n\n```sh\nnpx ramadan-cli\n\n# or install globally and use alias\nnpm install -g ramadan-cli@latest\nroza\n```\n\n\n## Agent Usage\n\nInstall this repo as an agent skill package:\n\n```sh\nnpx skills add ahmadawais/ramadan-cli\n```\n\n## Usage\n\n```sh\n# Show Sehar and Iftar times for today.\nnpx ramadan-cli\nroza\n\n# City examples.\nnpx ramadan-cli sf\nnpx ramadan-cli \"San Francisco\"\nnpx ramadan-cli lahore\nnpx ramadan-cli vancouver\n\n# Full Ramadan month.\nnpx ramadan-cli sf --all\nroza \"San Francisco\" -a\n\n# Specific roza.\nroza -n 10\nroza \"dera ghazi khan\" -n 10\n\n# Set custom first roza date (stored).\nroza --first-roza-date 2026-02-19\n\n# Clear custom first roza date.\nroza --clear-first-roza-date\n\n# Reset saved config (location + settings + overrides).\nroza reset\n\n# Non-interactive config (no prompts).\nramadan-cli config --city \"San Francisco\" --country \"United States\" --method 2 --school 0 --timezone \"America/Los_Angeles\"\nramadan-cli config --show\nramadan-cli config --clear\n```\n\n## CLI Surface\n\n```sh\nramadan-cli [city] [options]\nramadan-cli reset\nramadan-cli config [options]\n```\n\nNotes:\n\n- No `today` subcommand; default run is today view.\n- Passing a city is one-off and does not replace saved default location.\n\n## Output Semantics\n\n- `Sehar` = `Fajr`\n- `Iftar` = `Maghrib`\n- Time output is 12-hour (`AM/PM`)\n\n## Flags and Arguments\n\nGlobal/main command flags (`ramadan-cli [city]`):\n\n| Flag | Type | Default | Behavior |\n| --- | --- | --- | --- |\n| `[city]` | `string` | saved location | One-off lookup; does not overwrite saved default |\n| `-c, --city \u003ccity\u003e` | `string` | none | Same as city arg |\n| `-a, --all` | `boolean` | `false` | Show all Ramadan rows |\n| `-n, --number \u003c1-30\u003e` | `number` | none | Show specific roza |\n| `-p, --plain` | `boolean` | `false` | Plain text output without ASCII banner |\n| `-j, --json` | `boolean` | `false` | JSON-only output for scripts |\n| `--first-roza-date \u003cYYYY-MM-DD\u003e` | `string` | stored/API | Persist custom first roza date |\n| `--clear-first-roza-date` | `boolean` | `false` | Clear custom first roza date and use API Ramadan date |\n| `-v, --version` | `boolean` | n/a | Print version only |\n| `-h, --help` | `boolean` | n/a | Show help |\n\nConfig flags (`ramadan-cli config`):\n\n| Flag | Type | Behavior |\n| --- | --- | --- |\n| `--city \u003ccity\u003e` | `string` | Save city |\n| `--country \u003ccountry\u003e` | `string` | Save country |\n| `--latitude \u003clatitude\u003e` | `number` | Save latitude (`-90..90`) |\n| `--longitude \u003clongitude\u003e` | `number` | Save longitude (`-180..180`) |\n| `--method \u003cid\u003e` | `number` | Save method (`0..23`) |\n| `--school \u003cid\u003e` | `number` | Save school (`0=Shafi`, `1=Hanafi`) |\n| `--timezone \u003ctimezone\u003e` | `string` | Save timezone |\n| `--show` | `boolean` | Print saved config |\n| `--clear` | `boolean` | Clear saved config |\n\nReset command:\n\n- `ramadan-cli reset` clears saved location, method, school, timezone, and custom first roza date.\n\n## Aliases\n\n- `roza` (same CLI)\n- `ramadan-cli`\n- `ramzan`\n- `ramazan`\n- `ramadan`\n\n## I/O Contract\n\n- `stdout`:\n  - primary data output (table/plain/json)\n  - version output (`-v`) prints version only\n- `stderr`:\n  - runtime and validation errors\n- `--json`:\n  - prints structured JSON only to `stdout` on success\n  - prints structured JSON error payload to `stderr` on failure:\n    - `{\"ok\":false,\"error\":{\"code\":\"...\",\"message\":\"...\"}}`\n- Exit codes:\n  - `0` success\n  - `1` runtime/validation/network/data failure\n  - invalid usage parsing is handled by Commander defaults\n\n## Interactivity and Safety\n\n- On first run (TTY), CLI launches interactive setup with Clack prompts.\n- If `--json` is used and no config exists, interactive setup is skipped.\n- Config changes are explicit via `config`, `reset`, and first-roza flags.\n- No stdin input contract yet. Input is args/flags only.\n\n## Config and Precedence\n\nData sources:\n\n- flags/args (`city`, `--first-roza-date`, `--clear-first-roza-date`, mode flags)\n- saved config (from first-run setup or `ramadan-cli config`)\n- IP geolocation fallback when no saved config\n\nResolution behavior:\n\n- One-off city arg/flag wins for that invocation but is not persisted.\n- `--clear-first-roza-date` takes precedence over `--first-roza-date` if both are provided.\n- Recommended method/school are auto-applied when using default/unset settings.\n- `RAMADAN_CLI_CONFIG_DIR` controls where config is stored (useful for agent/test isolation).\n\n## Development\n\n```sh\npnpm install\npnpm typecheck\npnpm test\npnpm build\npnpm lint\n```\n## API\n\nPowered by [Aladhan Prayer Times API](https://aladhan.com/prayer-times-api)\n\n## License\n\nMIT - [Ahmad Awais](https://x.com/MrAhmadAwais)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmadawais%2Framadan-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fahmadawais%2Framadan-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmadawais%2Framadan-cli/lists"}