moro

    5.1.0 • Public • Published

    Moro

    A command line tool for tracking work hours, as simple as it can get.

    Backers on Open Collective Sponsors on Open Collective Downloads Greenkeeper badge All Contributors

    Demo

    alt tag

    Install

    If you have node and npm

    You need node version 10 or higher (we haven't tested lower versions)

    To install just type this into command line:

    npm install -g moro
     
    # or if you are using yarn, it works too 
    yarn global add  moro

    You are done installing Moro!

    (alternative install method) Download the compiled binary file

    We recommend installing moro using npm but if you don't have node and npm on your machine, you can download the executable files from releases page for Linux, Mac and Windows.

    Remember to copy ./lib/config.json to your home directory and rename it to

    ~/.moro-config.json
    

    Then you can copy the downloaded executable file to your path, for example to /bin and start using moro just like the nomral installation.

    Update

    npm update -g moro

    Usage

    1. Run moro hi when starting your working day. Moro registers that time as your clock in time.
    2. Run moro bye when ending your working day. Moro Registers that time as your clock out time.

    That's it! Moro prints on the screen how many hours you have worked.

    Invoke $:moro report at any time to see how long you have worked on the current day.

    To see the full report of previous days run moro report --all.

    Learn more:

    Those two steps above should be all you need to know about Moro, but there are 3 ways to learn more:

    • $: moro --help
    • See the documentation: link
    • Or check this screen recording: link

    Frequently Asked Questions (FAQ)

    Click to open FAQ

    Q: I forgot to run moro in the morning, so my clock in time is not saved. Can I adjust it now? A: yes! for example, if you started work at 09:30 run $: moro hi 09:30

    What does moro mean?

    Moro means hello in Finnish.

    Contributing

    Open an issue, or make a pull request. We love contributions.

    Development

    Clone this repo, and then inside the folder run:

    npm link
    

    This will install moro globally but using the files inside the project folder. You can now change the files and run moro in your command line to see the effects.

    To run tests

    npm test
    

    Code of conduct

    Code is important but people are more important. If you like to contribute to Moro please read and follow our code of conduct found in this file: CODE_OF_CONDUCT.md

    Contributors

    Thanks goes to these wonderful people (emoji key):


    Nick Okapi

    💬 🐛 💻 📖 👀 ⚠️

    Mario

    💻 📖 ⚠️

    Karl Fleischmann

    💻 📖 ⚠️

    Niloofar Motamed

    📖

    Wolf-Rost

    📖

    Henri Koski

    📖

    Olavi Haapala

    📖 🐛

    Walid Mani

    💻

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Contributors

    This project exists thanks to all the people who contribute. [Contribute].

    Backers

    Thank you to all our backers! 🙏 [Become a backer]

    Sponsors

    Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

    Install

    npm i moro

    DownloadsWeekly Downloads

    14

    Version

    5.1.0

    License

    MIT

    Unpacked Size

    60.6 kB

    Total Files

    24

    Last publish

    Collaborators

    • omidfi