https://github.com/moishinetzer/typapi
https://github.com/moishinetzer/typapi
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/moishinetzer/typapi
- Owner: moishinetzer
- License: mit
- Created: 2022-05-13T11:12:22.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T05:04:02.000Z (about 3 years ago)
- Last Synced: 2025-11-27T11:59:17.584Z (7 months ago)
- Language: TypeScript
- Size: 21.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
oclif-hello-world
=================
oclif example Hello World CLI
[](https://oclif.io)
[](https://npmjs.org/package/oclif-hello-world)
[](https://circleci.com/gh/oclif/hello-world/tree/main)
[](https://npmjs.org/package/oclif-hello-world)
[](https://github.com/oclif/hello-world/blob/main/package.json)
* [Usage](#usage)
* [Commands](#commands)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g typapi
$ typapi COMMAND
running command...
$ typapi (--version)
typapi/0.2.0 win32-x64 node-v17.7.2
$ typapi --help [COMMAND]
USAGE
$ typapi COMMAND
...
```
```sh-session
$ npm install -g oclif-hello-world
$ oex COMMAND
running command...
$ oex (--version)
oclif-hello-world/0.0.0 darwin-x64 node-v16.13.1
$ oex --help [COMMAND]
USAGE
$ oex COMMAND
...
```
# Commands
* [`typapi autocomplete [SHELL]`](#typapi-autocomplete-shell)
* [`typapi generate [FILE]`](#typapi-generate-file)
* [`typapi hello PERSON`](#typapi-hello-person)
* [`typapi hello world`](#typapi-hello-world)
* [`typapi help [COMMAND]`](#typapi-help-command)
* [`typapi plugins`](#typapi-plugins)
* [`typapi plugins:install PLUGIN...`](#typapi-pluginsinstall-plugin)
* [`typapi plugins:inspect PLUGIN...`](#typapi-pluginsinspect-plugin)
* [`typapi plugins:install PLUGIN...`](#typapi-pluginsinstall-plugin-1)
* [`typapi plugins:link PLUGIN`](#typapi-pluginslink-plugin)
* [`typapi plugins:uninstall PLUGIN...`](#typapi-pluginsuninstall-plugin)
* [`typapi plugins:uninstall PLUGIN...`](#typapi-pluginsuninstall-plugin-1)
* [`typapi plugins:uninstall PLUGIN...`](#typapi-pluginsuninstall-plugin-2)
* [`typapi plugins update`](#typapi-plugins-update)
## `typapi autocomplete [SHELL]`
display autocomplete installation instructions
```
USAGE
$ typapi autocomplete [SHELL] [-r]
ARGUMENTS
SHELL shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
display autocomplete installation instructions
EXAMPLES
$ typapi autocomplete
$ typapi autocomplete bash
$ typapi autocomplete zsh
$ typapi autocomplete --refresh-cache
```
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.3.0/src/commands/autocomplete/index.ts)_
## `typapi generate [FILE]`
describe the command here
```
USAGE
$ typapi generate [FILE] [-n ] [-f]
FLAGS
-f, --force
-n, --name= name to print
DESCRIPTION
describe the command here
EXAMPLES
$ typapi generate
```
_See code: [dist/commands/generate.ts](https://github.com/moishinetzer/typapi/blob/v0.2.0/dist/commands/generate.ts)_
## `typapi hello PERSON`
Say hello
```
USAGE
$ typapi hello [PERSON] -f
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from= (required) Whom 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/moishinetzer/typapi/blob/v0.2.0/dist/commands/hello/index.ts)_
## `typapi hello world`
Say hello world
```
USAGE
$ typapi hello world
DESCRIPTION
Say hello world
EXAMPLES
$ oex hello world
hello world! (./src/commands/hello/world.ts)
```
## `typapi help [COMMAND]`
Display help for typapi.
```
USAGE
$ typapi 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 typapi.
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_
## `typapi plugins`
List installed plugins.
```
USAGE
$ typapi plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ typapi plugins
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/index.ts)_
## `typapi plugins:install PLUGIN...`
Installs a plugin into the CLI.
```
USAGE
$ typapi 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
$ typapi plugins add
EXAMPLES
$ typapi plugins:install myplugin
$ typapi plugins:install https://github.com/someuser/someplugin
$ typapi plugins:install someuser/someplugin
```
## `typapi plugins:inspect PLUGIN...`
Displays installation properties of a plugin.
```
USAGE
$ typapi 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
$ typapi plugins:inspect myplugin
```
## `typapi plugins:install PLUGIN...`
Installs a plugin into the CLI.
```
USAGE
$ typapi 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
$ typapi plugins add
EXAMPLES
$ typapi plugins:install myplugin
$ typapi plugins:install https://github.com/someuser/someplugin
$ typapi plugins:install someuser/someplugin
```
## `typapi plugins:link PLUGIN`
Links a plugin into the CLI for development.
```
USAGE
$ typapi plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
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.
EXAMPLES
$ typapi plugins:link myplugin
```
## `typapi plugins:uninstall PLUGIN...`
Removes a plugin from the CLI.
```
USAGE
$ typapi plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ typapi plugins unlink
$ typapi plugins remove
```
## `typapi plugins:uninstall PLUGIN...`
Removes a plugin from the CLI.
```
USAGE
$ typapi plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ typapi plugins unlink
$ typapi plugins remove
```
## `typapi plugins:uninstall PLUGIN...`
Removes a plugin from the CLI.
```
USAGE
$ typapi plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ typapi plugins unlink
$ typapi plugins remove
```
## `typapi plugins update`
Update installed plugins.
```
USAGE
$ typapi plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
```
* [`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
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from= (required) Whom 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
$ oex plugins:install someuser/someplugin
```
## `oex plugins:link PLUGIN`
Links a plugin into the CLI for development.
```
USAGE
$ oex plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
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.
EXAMPLES
$ oex plugins:link myplugin
```
## `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.
```