timesheeter-cli v0.2.2
TimesheetERP
TimesheetERP is an open source ERP created primarily for developers. Besides being made for a need, it is a project made mostly for fun. But feel free to use it.
The primary goal was to be able to use this ERP via the CLI to not lose productivity by switching tool too often.
At the moment it includes the possibility to create timers to identify what time is spent on each task and to assign times to different projects.
Technology
This repository is the CLI client part of the application and was written with Typescript ❤ using the oclif framework and run on NodeJS. It uses the JS client library.
Server
Running the server is needed to use this CLI as nothing is stored locally.
Usage
This is a hobby projet and not a production ready solution, there are certainly bugs. Do not hesitate to open issues if you encounter some.
$ npm install -g timesheeter-cli
$ tser COMMAND
running command...
$ tser (-v|--version|version)
timesheeter-cli/0.2.2 linux-x64 node-v16.14.2
$ tser --help [COMMAND]
USAGE
$ tser COMMAND
...Commands
tser autocomplete [SHELL]tser clocks:createtser clocks:deletetser clocks:edittser clocks:listtser clocks:resettser clocks:starttser clocks:stoptser configtser help [COMMAND]tser logintser projects:createtser projects:deletetser projects:edittser projects:listtser times:createtser times:deletetser times:edittser times:list
tser autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ tser autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ tser autocomplete
$ tser autocomplete bash
$ tser autocomplete zsh
$ tser autocomplete --refresh-cacheSee code: @oclif/plugin-autocomplete
tser clocks:create
create a clock
USAGE
$ tser clocks:create
OPTIONS
-n, --name=name name of the clock
-s, --start Start the clock after creation
--stop-all Stop all other clocks
ALIASES
$ tser clock:create
$ tser clk:createSee code: src/commands/clocks/create.ts
tser clocks:delete
delete a clock
USAGE
$ tser clocks:delete
OPTIONS
--force
--id=id Id of the clock
ALIASES
$ tser clock:delete
$ tser clk:deleteSee code: src/commands/clocks/delete.ts
tser clocks:edit
edit a clock
USAGE
$ tser clocks:edit
OPTIONS
--id=id Id of the clock
ALIASES
$ tser clock:edit
$ tser clk:editSee code: src/commands/clocks/edit.ts
tser clocks:list
list clocks
USAGE
$ tser clocks:list
OPTIONS
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
ALIASES
$ tser clock:list
$ tser clk:listSee code: src/commands/clocks/list.ts
tser clocks:reset
reset a clock
USAGE
$ tser clocks:reset
OPTIONS
-s, --start Start the clock after reset
--all Reset all clocks
--id=id Id of the clock
ALIASES
$ tser clock:reset
$ tser clk:resetSee code: src/commands/clocks/reset.ts
tser clocks:start
start a clock
USAGE
$ tser clocks:start
OPTIONS
--id=id Id of the clock
--stop-all Stop all other clocks
ALIASES
$ tser clock:start
$ tser clk:startSee code: src/commands/clocks/start.ts
tser clocks:stop
stop a clock
USAGE
$ tser clocks:stop
OPTIONS
--all Stop all clocks
--id=id Id of the clock
ALIASES
$ tser clock:stop
$ tser clk:stopSee code: src/commands/clocks/stop.ts
tser config
Configure the client
USAGE
$ tser configSee code: src/commands/config.ts
tser help [COMMAND]
display help for tser
USAGE
$ tser help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLISee code: @oclif/plugin-help
tser login
Login to TimeSheetER
USAGE
$ tser login
OPTIONS
-a, --account=accountSee code: src/commands/login.ts
tser projects:create
create a project
USAGE
$ tser projects:create
OPTIONS
-h, --hourRate=hourRate hour rate the project
-n, --name=name name of the project
ALIASES
$ tser project:create
$ tser prj:createSee code: src/commands/projects/create.ts
tser projects:delete
delete a project
USAGE
$ tser projects:delete
OPTIONS
--force
--id=id Id of the project
ALIASES
$ tser project:delete
$ tser prj:deleteSee code: src/commands/projects/delete.ts
tser projects:edit
edit a project
USAGE
$ tser projects:edit
OPTIONS
--id=id Id of the project
ALIASES
$ tser project:edit
$ tser prj:editSee code: src/commands/projects/edit.ts
tser projects:list
list projects
USAGE
$ tser projects:list
OPTIONS
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
ALIASES
$ tser project:list
$ tser prj:listSee code: src/commands/projects/list.ts
tser times:create
add a time to a project
USAGE
$ tser times:create
OPTIONS
-p, --project-id=project-id Id of the project
--date=date time's date
--description=description time's description
--duration=duration time's duration in decimal
--today add time for today
ALIASES
$ tser time:createSee code: src/commands/times/create.ts
tser times:delete
edit a time
USAGE
$ tser times:delete
OPTIONS
-p, --project-id=project-id Id of the project
-t, --time-id=time-id Id of the time
--force
ALIASES
$ tser time:deleteSee code: src/commands/times/delete.ts
tser times:edit
edit a time
USAGE
$ tser times:edit
OPTIONS
-p, --project-id=project-id Id of the project
-t, --time-id=time-id Id of the time
ALIASES
$ tser time:editSee code: src/commands/times/edit.ts
tser times:list
get times for a project
USAGE
$ tser times:list
OPTIONS
-e, --end=end End date of the query
-p, --project-id=project-id Id of the project
-s, --start=start Start date of the query
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
ALIASES
$ tser time:listSee code: src/commands/times/list.ts