ORANGEHRM(1)

✨ ORANGEHRM ✨

okay bestie, so this is orangehrm — a command line client for OrangeHRM 💖 she's your little terminal bestie for clocking in and out of the OrangeHRM system, and honestly? iconic.

---

🦋 SYNOPSYS 🦋

orangehrm [OPTION...]

---

🌸 DESCRIPTION 🌸

So basically: set or show your time sheet in the OrangeHRM system. That's the whole vibe. 💅

---

🎀 OPTIONS 🎀

And here's the tea: if you run her with zero options, she just shows you the time sheet for the current month. no cap, that's the default behavior. ✨

💜 Options for configuration

these can be pulled straight from your configuration file, so you don't gotta type them every single time 🫶

• --url _URL_ — the base URL where your OrangeHRM instance is living.
• --username _USER_ — the user name you're logging in as. if you don't specify it, she'll ask you when she needs it.
• --password _PASSWORD_ — the password to use. same deal: if it's not specified, she'll ask when needed.

🌈 Options for showing a time sheet

• --year _NUMBER_ — year of the Gregorian calendar, default is today.
• --month _NUMBER_ — month of the year, and listen, it counts from 1. default is today.

🧚 Options for filling a time sheet

• --year _NUMBER_ — year of the Gregorian calendar, default is today.
• --month _NUMBER_ — month of the year, counts from 1, default is today.
• --day _NUMBER_ — day of the month, counts from 1, default is today.
• --from _HH::MM_, --from boot, --from now — beginning of working time. use boot for boot time, use now for the current time. (yes the colons really are doubled in HH::MM, that's not a typo bestie, that's just how she is 😭)
• --to _HH::MM_, --to boot, --to now — end of working time. use boot for boot time, use now for current time.
• --break _HH:MM_ — a vacant part in the working time, for the purpose of a working break.
• --doctor _HH:MM_ — a vacant part in the working time, for the purpose of a medical check.
• --comment _STRING_ — a free comment for the day.
• --trip — specify if you're on a business trip on this day.
• --work — the negation of --trip. working hours are filled as at-work by default. this option is only useful to flip the trip state back to work when you're using --amend.
• --amend — partial modification. with this, only records with an explicit option get changed. by default (no --amend), unspecified arguments reset the corresponding records back to their default values. ⚠️ so like, know which mode you're in, okay?

👑 Options for submitting a time sheet

• --submit — submit the current month's time sheet for review. go get that approval, queen. 🔥
• --year _NUMBER_ — year of the Gregorian calendar, default is today.
• --month _NUMBER_ — month of the year, counts from 1, default is today.
• --comment _STRING_ — a free comment to the submission.

💀 Options for debugging

• --debug — dump the sent HTTP requests and other useful data. perfect for when something is giving mystery and you need receipts.

⭐ Other options

• --help — show the program manual.
• --version — show the program version.

---

🍓 FILES 🍓

🫶 ~/.orangehrm

your user configuration, and here's exactly what it looks like:

url = https://redhat.orangehrm.com/
samlidp = https://saml.redhat.com/
samlout = https://example.redhat.com/bye
#username = ppisar
#password = Foo

and the juicy part: if the LWP::Authen::Negotiate Perl module is installed, and a valid Kerberos ticket granting ticket is available, then you don't need a user name and password in the configuration at all. ✨ automatic. slay.

---

💖 COPYRIGHT 💖

Copyright © 2012, 2013, 2014, 2015, 2017, 2019 Petr Písař <ppisar@redhat.com>.

---

🌸 LICENSE 🌸

This is free software. You may redistribute copies of it under the terms of the GNU General Public License <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.

not me being legally required to tell you there's NO WARRANTY 😭 fr fr, read the license bestie.

---

and that's the whole page, periodt. 💅 this version lives with perl v5.42.0, dated 2025-07-25 — mwah, go log those hours 🎀🦋💜