packdir-cli v0.1.5

Packdir cli (pd)

Command line tool to manage files and generate epub books for markdown files.

• Usage
• Commands

Usage

$ npm install -g packdir-cli
$ pd COMMAND
running command...
$ pd (--version)
packdir-cli/0.1.4 linux-x64 node-v14.15.1
$ pd --help [COMMAND]
USAGE
  $ pd COMMAND
...

Commands

• pd gen [FILE]
• pd hello PERSON
• pd hello world
• pd help [COMMAND]
• pd init [FILE]
• pd list [FILE]
• pd open FILENAME
• pd plugins
• pd plugins:inspect PLUGIN...
• pd plugins:install PLUGIN...
• pd plugins:link PLUGIN
• pd plugins:uninstall PLUGIN...
• pd plugins update

pd gen [FILE]

Create an EPUB book.

USAGE
  $ pd gen [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  Create an EPUB book.

EXAMPLES
  $ pd gen

See code: dist/commands/gen.ts

pd hello PERSON

Say hello

USAGE
  $ pd hello [PERSON] -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (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

pd hello world

Say hello world

USAGE
  $ pd hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ oex hello world
  hello world! (./src/commands/hello/world.ts)

pd help [COMMAND]

Display help for pd.

USAGE
  $ pd 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 pd.

See code: @oclif/plugin-help

pd init [FILE]

Init to create packdir.json

USAGE
  $ pd init [FILE] [-y]

FLAGS
  -y, --yes

DESCRIPTION
  Init to create packdir.json

EXAMPLES
  $ pd init

See code: dist/commands/init.ts

pd list [FILE]

List all ebooks.

USAGE
  $ pd list [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  List all ebooks.

EXAMPLES
  $ pd list

See code: dist/commands/list.ts

pd open FILENAME

Open an file with default application.

USAGE
  $ pd open [FILENAME] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  Open an file with default application.

EXAMPLES
  $ pd open

See code: dist/commands/open.ts

pd plugins

List installed plugins.

USAGE
  $ pd plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ pd plugins

See code: @oclif/plugin-plugins

pd plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ pd 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
  $ pd plugins:inspect myplugin

pd plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ pd 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
  $ pd plugins add

EXAMPLES
  $ pd plugins:install myplugin 

  $ pd plugins:install https://github.com/someuser/someplugin

  $ pd plugins:install someuser/someplugin

pd plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ pd 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
  $ pd plugins:link myplugin

pd plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ pd plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ pd plugins unlink
  $ pd plugins remove

pd plugins update

Update installed plugins.

USAGE
  $ pd plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.