@haxcms/migrate-gitbook
v0.0.13
Published
Migrate a Gitbook site to HAXcms.
Downloads
7
Readme
@haxcms/migrate-gitbook
Migrate a Gitbook site to HAXcms.
[](https://github.com/[object Object]/blob/master/package.json)
Usage
$ npm install -g @haxcms/migrate-gitbook
$ migrate-gitbook COMMAND
running command...
$ migrate-gitbook (-v|--version|version)
@haxcms/migrate-gitbook/0.0.13 darwin-x64 node-v12.13.0
$ migrate-gitbook --help [COMMAND]
USAGE
$ migrate-gitbook COMMAND
...
Commands
migrate-gitbook help [COMMAND]
migrate-gitbook plugins
migrate-gitbook plugins:install PLUGIN...
migrate-gitbook plugins:link PLUGIN
migrate-gitbook plugins:uninstall PLUGIN...
migrate-gitbook plugins:update
migrate-gitbook run SUMMARYFILE
migrate-gitbook help [COMMAND]
display help for migrate-gitbook
USAGE
$ migrate-gitbook help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
migrate-gitbook plugins
list installed plugins
USAGE
$ migrate-gitbook plugins
OPTIONS
--core show core plugins
EXAMPLE
$ migrate-gitbook plugins
See code: @oclif/plugin-plugins
migrate-gitbook plugins:install PLUGIN...
installs a plugin into the CLI
USAGE
$ migrate-gitbook plugins:install PLUGIN...
ARGUMENTS
PLUGIN plugin to install
OPTIONS
-f, --force yarn install with force flag
-h, --help show CLI help
-v, --verbose
DESCRIPTION
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
$ migrate-gitbook plugins:add
EXAMPLES
$ migrate-gitbook plugins:install myplugin
$ migrate-gitbook plugins:install https://github.com/someuser/someplugin
$ migrate-gitbook plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
migrate-gitbook plugins:link PLUGIN
links a plugin into the CLI for development
USAGE
$ migrate-gitbook plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
OPTIONS
-h, --help show CLI help
-v, --verbose
DESCRIPTION
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.
EXAMPLE
$ migrate-gitbook plugins:link myplugin
See code: @oclif/plugin-plugins
migrate-gitbook plugins:uninstall PLUGIN...
removes a plugin from the CLI
USAGE
$ migrate-gitbook plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
OPTIONS
-h, --help show CLI help
-v, --verbose
ALIASES
$ migrate-gitbook plugins:unlink
$ migrate-gitbook plugins:remove
See code: @oclif/plugin-plugins
migrate-gitbook plugins:update
update installed plugins
USAGE
$ migrate-gitbook plugins:update
OPTIONS
-h, --help show CLI help
-v, --verbose
See code: @oclif/plugin-plugins
migrate-gitbook run SUMMARYFILE
Describe the command here
USAGE
$ migrate-gitbook run SUMMARYFILE
ARGUMENTS
SUMMARYFILE summary.md gitbook file
OPTIONS
-d, --destination=destination [default: ./] destination directory.
-h, --help show CLI help
-v, --version show CLI version
See code: src/commands/run.js