kingoftime-cli/README.md

93 lines
1.6 KiB
Markdown
Raw Normal View History

2023-04-14 13:54:48 +00:00
King of Time CLI
2023-04-14 13:13:50 +00:00
=================
<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
2023-04-14 13:54:48 +00:00
TODO add instructions for setting tokens.
2023-04-14 13:13:50 +00:00
<!-- usage -->
```sh-session
$ npm install -g kingoftime-cli
$ kot COMMAND
running command...
$ kot (--version)
kingoftime-cli/0.0.0 darwin-x64 node-v18.15.0
$ kot --help [COMMAND]
USAGE
$ kot COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`kot checkin`](#kot-checkin)
* [`kot checkout`](#kot-checkout)
2023-04-14 13:13:50 +00:00
* [`kot help [COMMANDS]`](#kot-help-commands)
## `kot checkin`
2023-04-14 13:13:50 +00:00
Check in
2023-04-14 13:13:50 +00:00
```
USAGE
$ kot checkin --token <value> --user-token <value>
2023-04-14 13:13:50 +00:00
FLAGS
--token=<value> (required) Defaults to the KINGOFTIME_TOKEN environment variable.
--user-token=<value> (required) Defaults to the KINGOFTIME_USER_TOKEN environment variable.
2023-04-14 13:13:50 +00:00
DESCRIPTION
Check in
2023-04-14 13:13:50 +00:00
EXAMPLES
2023-04-14 13:54:48 +00:00
$ kot checkin
2023-04-14 13:13:50 +00:00
```
## `kot checkout`
2023-04-14 13:13:50 +00:00
Check out
2023-04-14 13:13:50 +00:00
```
USAGE
$ kot checkout --token <value> --user-token <value>
2023-04-14 13:54:48 +00:00
FLAGS
--token=<value> (required) Defaults to the KINGOFTIME_TOKEN environment variable.
--user-token=<value> (required) Defaults to the KINGOFTIME_USER_TOKEN environment variable.
2023-04-14 13:13:50 +00:00
DESCRIPTION
Check out
2023-04-14 13:13:50 +00:00
EXAMPLES
2023-04-14 13:54:48 +00:00
$ kot checkout
2023-04-14 13:13:50 +00:00
```
## `kot help [COMMANDS]`
Display help for kot.
```
USAGE
$ kot help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for kot.
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
<!-- commandsstop -->
2023-04-14 14:22:39 +00:00
## Credits
Inspired by https://github.com/inabajunmr/kotrcli