-
Notifications
You must be signed in to change notification settings - Fork 6
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
5 changed files
with
48 additions
and
1,538 deletions.
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
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,245 +1,51 @@ | ||
oclif-hello-world | ||
================= | ||
# Internxt CLI | ||
|
||
oclif example Hello World CLI | ||
[![Commands Unit Tests](https://github.com/internxt/cli/actions/workflows/commands-unit-tests.yml/badge.svg)](https://github.com/internxt/cli/actions/workflows/commands-unit-tests.yml) | ||
[![CodeQL](https://github.com/internxt/cli/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/internxt/cli/actions/workflows/github-code-scanning/codeql) | ||
|
||
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) | ||
[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main) | ||
[![GitHub license](https://img.shields.io/github/license/oclif/hello-world)](https://github.com/oclif/hello-world/blob/main/LICENSE) | ||
A CLI tool to interact with yout Internxt encrypted files | ||
|
||
<!-- toc --> | ||
* [Internxt CLI](#internxt-cli) | ||
* [Usage](#usage) | ||
* [Commands](#commands) | ||
<!-- tocstop --> | ||
|
||
# Usage | ||
|
||
<!-- usage --> | ||
```sh-session | ||
$ npm install -g oclif-hello-world | ||
$ oex COMMAND | ||
$ npm install -g internxt-cli | ||
$ internxt-cli COMMAND | ||
running command... | ||
$ oex (--version) | ||
oclif-hello-world/0.0.0 darwin-x64 node-v16.13.1 | ||
$ oex --help [COMMAND] | ||
$ internxt-cli (--version) | ||
internxt-cli/0.0.0 darwin-arm64 node-v20.10.0 | ||
$ internxt-cli --help [COMMAND] | ||
USAGE | ||
$ oex COMMAND | ||
$ internxt-cli COMMAND | ||
... | ||
``` | ||
<!-- usagestop --> | ||
# Commands | ||
<!-- commands --> | ||
* [`oex hello PERSON`](#oex-hello-person) | ||
* [`oex hello world`](#oex-hello-world) | ||
* [`oex help [COMMAND]`](#oex-help-command) | ||
* [`oex plugins`](#oex-plugins) | ||
* [`oex plugins:inspect PLUGIN...`](#oex-pluginsinspect-plugin) | ||
* [`oex plugins:install PLUGIN...`](#oex-pluginsinstall-plugin) | ||
* [`oex plugins:link PLUGIN`](#oex-pluginslink-plugin) | ||
* [`oex plugins:uninstall PLUGIN...`](#oex-pluginsuninstall-plugin) | ||
* [`oex plugins update`](#oex-plugins-update) | ||
|
||
## `oex hello PERSON` | ||
|
||
Say hello | ||
|
||
``` | ||
USAGE | ||
$ oex hello [PERSON] -f <value> | ||
ARGUMENTS | ||
PERSON Person to say hello to | ||
FLAGS | ||
-f, --from=<value> (required) Who is saying hello | ||
DESCRIPTION | ||
Say hello | ||
EXAMPLES | ||
$ oex hello friend --from oclif | ||
hello friend from oclif! (./src/commands/hello/index.ts) | ||
``` | ||
|
||
_See code: [dist/commands/hello/index.ts](https://github.com/oclif/hello-world/blob/v0.0.0/dist/commands/hello/index.ts)_ | ||
|
||
## `oex hello world` | ||
|
||
Say hello world | ||
|
||
``` | ||
USAGE | ||
$ oex hello world | ||
DESCRIPTION | ||
Say hello world | ||
EXAMPLES | ||
$ oex hello world | ||
hello world! (./src/commands/hello/world.ts) | ||
``` | ||
|
||
## `oex help [COMMAND]` | ||
|
||
Display help for oex. | ||
|
||
``` | ||
USAGE | ||
$ oex help [COMMAND] [-n] | ||
ARGUMENTS | ||
COMMAND Command to show help for. | ||
FLAGS | ||
-n, --nested-commands Include all nested commands in the output. | ||
DESCRIPTION | ||
Display help for oex. | ||
``` | ||
|
||
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_ | ||
|
||
## `oex plugins` | ||
|
||
List installed plugins. | ||
|
||
``` | ||
USAGE | ||
$ oex plugins [--core] | ||
FLAGS | ||
--core Show core plugins. | ||
DESCRIPTION | ||
List installed plugins. | ||
EXAMPLES | ||
$ oex plugins | ||
``` | ||
|
||
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/index.ts)_ | ||
|
||
## `oex plugins:inspect PLUGIN...` | ||
|
||
Displays installation properties of a plugin. | ||
|
||
``` | ||
USAGE | ||
$ oex plugins:inspect PLUGIN... | ||
ARGUMENTS | ||
PLUGIN [default: .] Plugin to inspect. | ||
FLAGS | ||
-h, --help Show CLI help. | ||
-v, --verbose | ||
DESCRIPTION | ||
Displays installation properties of a plugin. | ||
EXAMPLES | ||
$ oex plugins:inspect myplugin | ||
``` | ||
|
||
## `oex plugins:install PLUGIN...` | ||
|
||
Installs a plugin into the CLI. | ||
|
||
``` | ||
USAGE | ||
$ oex plugins:install PLUGIN... | ||
ARGUMENTS | ||
PLUGIN Plugin to install. | ||
FLAGS | ||
-f, --force Run yarn install with force flag. | ||
-h, --help Show CLI help. | ||
-v, --verbose | ||
DESCRIPTION | ||
Installs a plugin into the CLI. | ||
Can be installed from npm or a git url. | ||
Installation of a user-installed plugin will override a core plugin. | ||
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command | ||
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in | ||
the CLI without the need to patch and update the whole CLI. | ||
ALIASES | ||
$ oex plugins add | ||
EXAMPLES | ||
$ oex plugins:install myplugin | ||
$ oex plugins:install https://github.com/someuser/someplugin | ||
# Commands | ||
|
||
$ oex plugins:install someuser/someplugin | ||
``` | ||
<!-- commands --> | ||
* [`internxt-cli whoami`](#internxt-cli-whoami) | ||
|
||
## `oex plugins:link PLUGIN` | ||
## `internxt-cli whoami` | ||
|
||
Links a plugin into the CLI for development. | ||
Displays the current user logged into the Internxt CLI. | ||
|
||
``` | ||
USAGE | ||
$ oex plugins:link PLUGIN | ||
ARGUMENTS | ||
PATH [default: .] path to plugin | ||
FLAGS | ||
-h, --help Show CLI help. | ||
-v, --verbose | ||
$ internxt-cli whoami | ||
DESCRIPTION | ||
Links a plugin into the CLI for development. | ||
Installation of a linked plugin will override a user-installed or core plugin. | ||
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' | ||
command will override the user-installed or core plugin implementation. This is useful for development work. | ||
Displays the current user logged into the Internxt CLI. | ||
EXAMPLES | ||
$ oex plugins:link myplugin | ||
$ internxt-cli whoami | ||
``` | ||
|
||
## `oex plugins:uninstall PLUGIN...` | ||
|
||
Removes a plugin from the CLI. | ||
|
||
``` | ||
USAGE | ||
$ oex plugins:uninstall PLUGIN... | ||
ARGUMENTS | ||
PLUGIN plugin to uninstall | ||
FLAGS | ||
-h, --help Show CLI help. | ||
-v, --verbose | ||
DESCRIPTION | ||
Removes a plugin from the CLI. | ||
ALIASES | ||
$ oex plugins unlink | ||
$ oex plugins remove | ||
``` | ||
|
||
## `oex plugins update` | ||
|
||
Update installed plugins. | ||
|
||
``` | ||
USAGE | ||
$ oex plugins update [-h] [-v] | ||
FLAGS | ||
-h, --help Show CLI help. | ||
-v, --verbose | ||
DESCRIPTION | ||
Update installed plugins. | ||
``` | ||
_See code: [src/commands/whoami.ts](https://github.com/internxt/cli/blob/v0.0.0/src/commands/whoami.ts)_ | ||
<!-- commandsstop --> |
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
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
Oops, something went wrong.