@smartgraph/cli
v0.1.3
Published
oclif example Hello World CLI
Downloads
11
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g @smartgraph/cli
$ smartgraph COMMAND
running command...
$ smartgraph (--version)
@smartgraph/cli/0.1.3 darwin-x64 node-v16.14.2
$ smartgraph --help [COMMAND]
USAGE
$ smartgraph COMMAND
...
Commands
smartgraph codegen [URL]
smartgraph help [COMMAND]
smartgraph plugins
smartgraph plugins:install PLUGIN...
smartgraph plugins:inspect PLUGIN...
smartgraph plugins:install PLUGIN...
smartgraph plugins:link PLUGIN
smartgraph plugins:uninstall PLUGIN...
smartgraph plugins:uninstall PLUGIN...
smartgraph plugins:uninstall PLUGIN...
smartgraph plugins update
smartgraph codegen [URL]
describe the command here
USAGE
$ smartgraph codegen [URL] [-l <value>] [-o <value>] [-h <value>] [-f] [-g]
FLAGS
-f, --force
-g, --smartgraph
-h, --header=<value>... header
-l, --link=<value> [default: http://localhost:4200/api/graphql] link
-o, --out=<value> [default: ./] out
DESCRIPTION
describe the command here
EXAMPLES
$ smartgraph codegen
See code: dist/commands/codegen.ts
smartgraph help [COMMAND]
Display help for smartgraph.
USAGE
$ smartgraph 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 smartgraph.
See code: @oclif/plugin-help
smartgraph plugins
List installed plugins.
USAGE
$ smartgraph plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ smartgraph plugins
See code: @oclif/plugin-plugins
smartgraph plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ smartgraph 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
$ smartgraph plugins add
EXAMPLES
$ smartgraph plugins:install myplugin
$ smartgraph plugins:install https://github.com/someuser/someplugin
$ smartgraph plugins:install someuser/someplugin
smartgraph plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ smartgraph 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
$ smartgraph plugins:inspect myplugin
smartgraph plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ smartgraph 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
$ smartgraph plugins add
EXAMPLES
$ smartgraph plugins:install myplugin
$ smartgraph plugins:install https://github.com/someuser/someplugin
$ smartgraph plugins:install someuser/someplugin
smartgraph plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ smartgraph 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
$ smartgraph plugins:link myplugin
smartgraph plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ smartgraph plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ smartgraph plugins unlink
$ smartgraph plugins remove
smartgraph plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ smartgraph plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ smartgraph plugins unlink
$ smartgraph plugins remove
smartgraph plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ smartgraph plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ smartgraph plugins unlink
$ smartgraph plugins remove
smartgraph plugins update
Update installed plugins.
USAGE
$ smartgraph plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.