Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Devel #2

Merged
merged 5 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
/node_modules
oclif.manifest.json
*.tsbuildinfo
coverage


yarn.lock
Expand Down
48 changes: 38 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ $ npm install -g ketool
$ ketool COMMAND
running command...
$ ketool (--version)
ketool/0.0.0 linux-x64 node-v20.18.0
ketool/0.1.1 linux-x64 node-v20.18.0
$ ketool --help [COMMAND]
USAGE
$ ketool COMMAND
Expand All @@ -30,6 +30,7 @@ USAGE
# Commands
<!-- commands -->
* [`ketool help [COMMAND]`](#ketool-help-command)
* [`ketool ls [OBJECT]`](#ketool-ls-object)
* [`ketool mkdir DIRECTORY`](#ketool-mkdir-directory)
* [`ketool put SOURCE`](#ketool-put-source)
* [`ketool rm OBJECT`](#ketool-rm-object)
Expand All @@ -53,15 +54,42 @@ DESCRIPTION
Display help for ketool.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.15/src/commands/help.ts)_
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.16/src/commands/help.ts)_

## `ketool ls [OBJECT]`

list information about the OBJECTs.

```
USAGE
$ ketool ls [OBJECT...] [-u <value>] [-k] [-t <value>] [-c <value>] [-l]

ARGUMENTS
OBJECT... file to read

FLAGS
-c, --cwd=<value> set current working directory to VALUE
-k, --insecure allow insecure SSL connection
-l, --long use a long listing format
-t, --token=<value> API access token of the Kompira Enterprise server
-u, --baseurl=<value> base URL of the Kompira Enterprise server

DESCRIPTION
list information about the OBJECTs.

EXAMPLES
$ ketool ls
```

_See code: [src/commands/ls.ts](https://github.com/fixpoint/ketool/blob/v0.1.1/src/commands/ls.ts)_

## `ketool mkdir DIRECTORY`

Create the directories, if they do not already exist.

```
USAGE
$ ketool mkdir DIRECTORY... [-u <value>] [-t <value>] [-k] [-c <value>] [-p] [-v]
$ ketool mkdir DIRECTORY... [-u <value>] [-k] [-t <value>] [-c <value>] [-p] [-v]

ARGUMENTS
DIRECTORY... path of the directory to be created
Expand All @@ -81,15 +109,15 @@ EXAMPLES
$ ketool mkdir
```

_See code: [src/commands/mkdir.ts](https://github.com/fixpoint/ketool/blob/v0.0.0/src/commands/mkdir.ts)_
_See code: [src/commands/mkdir.ts](https://github.com/fixpoint/ketool/blob/v0.1.1/src/commands/mkdir.ts)_

## `ketool put SOURCE`

put files or directories to Kompira server

```
USAGE
$ ketool put SOURCE... [-u <value>] [-t <value>] [-k] [-d <value>] [-c <value>] [-r] [-o] [-v]
$ ketool put SOURCE... [-u <value>] [-k] [-t <value>] [-c <value>] [-d <value>] [-o] [-r] [-v]

ARGUMENTS
SOURCE... source file or directory
Expand All @@ -111,15 +139,15 @@ EXAMPLES
$ ketool put
```

_See code: [src/commands/put.ts](https://github.com/fixpoint/ketool/blob/v0.0.0/src/commands/put.ts)_
_See code: [src/commands/put.ts](https://github.com/fixpoint/ketool/blob/v0.1.1/src/commands/put.ts)_

## `ketool rm OBJECT`

Remove the directories, if they are empty.

```
USAGE
$ ketool rm OBJECT... [-u <value>] [-t <value>] [-k] [-c <value>] [-f] [-r] [-v]
$ ketool rm OBJECT... [-u <value>] [-k] [-t <value>] [-c <value>] [-f] [-r] [-v]

ARGUMENTS
OBJECT... path of the object to be removed
Expand All @@ -140,15 +168,15 @@ EXAMPLES
$ ketool rm
```

_See code: [src/commands/rm.ts](https://github.com/fixpoint/ketool/blob/v0.0.0/src/commands/rm.ts)_
_See code: [src/commands/rm.ts](https://github.com/fixpoint/ketool/blob/v0.1.1/src/commands/rm.ts)_

## `ketool rmdir DIRECTORY`

Remove the directories, if they are empty.

```
USAGE
$ ketool rmdir DIRECTORY... [-u <value>] [-t <value>] [-k] [-c <value>] [-p] [-v]
$ ketool rmdir DIRECTORY... [-u <value>] [-k] [-t <value>] [-c <value>] [-p] [-v]

ARGUMENTS
DIRECTORY... path of the directory to be removed
Expand All @@ -168,5 +196,5 @@ EXAMPLES
$ ketool rmdir
```

_See code: [src/commands/rmdir.ts](https://github.com/fixpoint/ketool/blob/v0.0.0/src/commands/rmdir.ts)_
_See code: [src/commands/rmdir.ts](https://github.com/fixpoint/ketool/blob/v0.1.1/src/commands/rmdir.ts)_
<!-- commandsstop -->
Loading
Loading