Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/omidfi/moro
[DEPRECATED/DON'T USE] Simple CLI tool for tracking work hours. Note: Heavy changes are happening in this repository. Docs might not be up to date, and things might be broken. Only the released NPM version is stable.
https://github.com/omidfi/moro
cli nodejs time-tracker time-tracking
Last synced: 23 days ago
JSON representation
[DEPRECATED/DON'T USE] Simple CLI tool for tracking work hours. Note: Heavy changes are happening in this repository. Docs might not be up to date, and things might be broken. Only the released NPM version is stable.
- Host: GitHub
- URL: https://github.com/omidfi/moro
- Owner: getmoro
- License: mit
- Created: 2017-03-02T16:14:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T20:57:01.000Z (6 months ago)
- Last Synced: 2024-06-16T05:28:53.557Z (5 months ago)
- Topics: cli, nodejs, time-tracker, time-tracking
- Language: TypeScript
- Homepage: https://moro.js.org
- Size: 5 MB
- Stars: 467
- Watchers: 8
- Forks: 43
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-cli-apps - moro - Simple tool for tracking work hours. (Productivity / Time Tracking)
- fucking-awesome-cli-apps - moro - Simple tool for tracking work hours. (Productivity / Time Tracking)
README
# Moro (DEPRECATED / USE AT YOUR OWN RISK)
A command line tool for tracking work hours, as simple as it can get.
[](#backers) [](#sponsors) [](https://npmjs.org/moro) [](https://greenkeeper.io/) [](#contributors)
## Demo
## 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:
```bash
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](https://github.com/albacoretuna/moro/releases) 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
```bash
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](https://github.com/albacoretuna/moro/blob/master/DOCUMENTATION.md)
- Or check this screen recording: [link](https://asciinema.org/a/106792)
## 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](https://github.com/kentcdodds/all-contributors#emoji-key)):
| [
Nick Okapi](http://omid.fi)
[💬](#question-albacoretuna "Answering Questions") [🐛](https://github.com/albacoretuna/moro/issues?q=author%3Aalbacoretuna "Bug reports") [💻](https://github.com/albacoretuna/moro/commits?author=albacoretuna "Code") [📖](https://github.com/albacoretuna/moro/commits?author=albacoretuna "Documentation") [👀](#review-albacoretuna "Reviewed Pull Requests") [⚠️](https://github.com/albacoretuna/moro/commits?author=albacoretuna "Tests") | [
Mario](https://github.com/mario-s)
[💻](https://github.com/albacoretuna/moro/commits?author=mario-s "Code") [📖](https://github.com/albacoretuna/moro/commits?author=mario-s "Documentation") [⚠️](https://github.com/albacoretuna/moro/commits?author=mario-s "Tests") | [
Karl Fleischmann](https://twitter.com/fleischie28)
[💻](https://github.com/albacoretuna/moro/commits?author=fleischie "Code") [📖](https://github.com/albacoretuna/moro/commits?author=fleischie "Documentation") [⚠️](https://github.com/albacoretuna/moro/commits?author=fleischie "Tests") | [
Niloofar Motamed](https://niloofarmotamed.com)
[📖](https://github.com/albacoretuna/moro/commits?author=niloomotita "Documentation") | [
Wolf-Rost](https://github.com/Wolf-Rost)
[📖](https://github.com/albacoretuna/moro/commits?author=Wolf-Rost "Documentation") | [
Henri Koski](https://github.com/heppu)
[📖](https://github.com/albacoretuna/moro/commits?author=heppu "Documentation") | [
Olavi Haapala](https://twitter.com/0lpeh)
[📖](https://github.com/albacoretuna/moro/commits?author=olpeh "Documentation") [🐛](https://github.com/albacoretuna/moro/issues?q=author%3Aolpeh "Bug reports") |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| [
Walid Mani](https://github.com/Flouss)
[💻](https://github.com/albacoretuna/moro/commits?author=Flouss "Code") |
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!
## Contributors
This project exists thanks to all the people who contribute. [[Contribute]](CONTRIBUTING.md). 
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/moro#backer)]
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/moro#sponsor)]
