This repository has been archived by the owner on Feb 21, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
57 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,58 @@ | ||
# hrflow | ||
HR Flow CLI | ||
|
||
[HR Flow](https://hrflow.accountor.fi/) CLI | ||
|
||
## Usage | ||
|
||
`hrflow help` | ||
|
||
### Creating Reports | ||
|
||
``` | ||
NAME: | ||
hrflow report - add a new hour report | ||
USAGE: | ||
hrflow report [command options] [arguments...] | ||
OPTIONS: | ||
--duration value, -d value number of hours to report, formatted as 8h30m. Will be ignored if both start and end time are defined. (default: "8h") | ||
--start TIME, -s TIME Set workday start to TIME. (default: now - HOURS) | ||
--end TIME, -e TIME Set workday end to TIME. (default: now) | ||
--project PROJECT, -p PROJECT which PROJECT to assign to the report. (default: none) | ||
--comment COMMENT, -c COMMENT assign a COMMENT to the report. (default: empty) | ||
--date DATE DATE for the report, format 'd.M.' (years not supported) (default: today) | ||
--help, -h show help (default: false) | ||
``` | ||
|
||
#### Quickly Reporting 8 Hours | ||
|
||
Running `hrflow report` will report an 8 hour workday ending at current time. | ||
|
||
## Installation | ||
|
||
Create a file for the login at `~/.hrflow` with the contents: | ||
|
||
``` | ||
username: USERNAME | ||
password: PASSWORD | ||
``` | ||
|
||
### Homebrew (macOS and Linux) | ||
|
||
``` | ||
brew tap myyra/hrflow https://github.com/myyra/hrflow | ||
brew install hrflow | ||
``` | ||
|
||
### Go | ||
|
||
Make sure Go is installed on your machine and `$GOPATH/bin` is in you `$PATH`. Then run | ||
|
||
``` | ||
go get -u github.com/myyra/hrflow | ||
``` | ||
|
||
### Binary | ||
|
||
Binaries are available from the [Releases](https://github.com/myyra/hrflow/releases) page. |