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 -->
|
2023-04-14 13:54:48 +00:00
|
|
|
* [`kot checkin [FILE]`](#kot-checkin-file)
|
|
|
|
|
* [`kot checkout [FILE]`](#kot-checkout-file)
|
2023-04-14 13:13:50 +00:00
|
|
|
* [`kot help [COMMANDS]`](#kot-help-commands)
|
|
|
|
|
|
2023-04-14 13:54:48 +00:00
|
|
|
## `kot checkin [FILE]`
|
2023-04-14 13:13:50 +00:00
|
|
|
|
2023-04-14 13:54:48 +00:00
|
|
|
describe the command here
|
2023-04-14 13:13:50 +00:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
USAGE
|
2023-04-14 13:54:48 +00:00
|
|
|
$ kot checkin [FILE] [-n <value>] [-f]
|
2023-04-14 13:13:50 +00:00
|
|
|
|
|
|
|
|
ARGUMENTS
|
2023-04-14 13:54:48 +00:00
|
|
|
FILE file to read
|
2023-04-14 13:13:50 +00:00
|
|
|
|
|
|
|
|
FLAGS
|
2023-04-14 13:54:48 +00:00
|
|
|
-f, --force
|
|
|
|
|
-n, --name=<value> name to print
|
2023-04-14 13:13:50 +00:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
2023-04-14 13:54:48 +00:00
|
|
|
describe the command here
|
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
|
|
|
```
|
|
|
|
|
|
2023-04-14 13:54:48 +00:00
|
|
|
## `kot checkout [FILE]`
|
2023-04-14 13:13:50 +00:00
|
|
|
|
2023-04-14 13:54:48 +00:00
|
|
|
describe the command here
|
2023-04-14 13:13:50 +00:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
USAGE
|
2023-04-14 13:54:48 +00:00
|
|
|
$ kot checkout [FILE] [-n <value>] [-f]
|
|
|
|
|
|
|
|
|
|
ARGUMENTS
|
|
|
|
|
FILE file to read
|
|
|
|
|
|
|
|
|
|
FLAGS
|
|
|
|
|
-f, --force
|
|
|
|
|
-n, --name=<value> name to print
|
2023-04-14 13:13:50 +00:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
2023-04-14 13:54:48 +00:00
|
|
|
describe the command here
|
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
|
