create-swyft-bot
TypeScript icon, indicating that this package has built-in type declarations

0.1.2 • Public • Published

create-swyft-bot

create-swyft-bot CLI

Usage

$ npm install -g create-swyft-bot
$ create-swyft-bot COMMAND
running command...
$ create-swyft-bot (--version)
create-swyft-bot/0.1.2 win32-x64 node-v16.20.0
$ create-swyft-bot --help [COMMAND]
USAGE
  $ create-swyft-bot COMMAND
...

Commands

create-swyft-bot autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ create-swyft-bot autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ create-swyft-bot autocomplete

  $ create-swyft-bot autocomplete bash

  $ create-swyft-bot autocomplete zsh

  $ create-swyft-bot autocomplete powershell

  $ create-swyft-bot autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

create-swyft-bot commands

list all the commands

USAGE
  $ create-swyft-bot commands [--json] [-h] [--hidden] [--tree] [--columns <value> | -x] [--sort <value>]
    [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -h, --help         Show CLI help.
  -x, --extended     show extra columns
  --columns=<value>  only show provided columns (comma-separated)
  --csv              output is csv format [alias: --output=csv]
  --filter=<value>   filter property by partial string matching, ex: name=foo
  --hidden           show hidden commands
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --output=<option>  output in a more machine friendly format
                     <options: csv|json|yaml>
  --sort=<value>     property to sort by (prepend '-' for descending)
  --tree             show tree of commands

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  list all the commands

See code: @oclif/plugin-commands

create-swyft-bot create NAME

Generate a Discord bot

USAGE
  $ create-swyft-bot create NAME -t <value> -p <value> [-o <value>]

ARGUMENTS
  NAME  Bot name

FLAGS
  -o, --out=<value>     [default: .] Output directory
  -p, --prefix=<value>  (required) Bot command prefix
  -t, --token=<value>   (required) Discord bot token

DESCRIPTION
  Generate a Discord bot

EXAMPLES
  $ create-swyft-bot create discord-bot --token "bot token" --name "bot name" --prefix "prefix" --out "output directory"

See code: dist/commands/create/index.ts

create-swyft-bot help [COMMANDS]

Display help for create-swyft-bot.

USAGE
  $ create-swyft-bot help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for create-swyft-bot.

See code: @oclif/plugin-help

create-swyft-bot plugins

List installed plugins.

USAGE
  $ create-swyft-bot plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ create-swyft-bot plugins

See code: @oclif/plugin-plugins

create-swyft-bot plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ create-swyft-bot 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
  $ create-swyft-bot plugins add

EXAMPLES
  $ create-swyft-bot plugins:install myplugin 

  $ create-swyft-bot plugins:install https://github.com/someuser/someplugin

  $ create-swyft-bot plugins:install someuser/someplugin

create-swyft-bot plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ create-swyft-bot plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

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

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ create-swyft-bot plugins:inspect myplugin

create-swyft-bot plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ create-swyft-bot 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
  $ create-swyft-bot plugins add

EXAMPLES
  $ create-swyft-bot plugins:install myplugin 

  $ create-swyft-bot plugins:install https://github.com/someuser/someplugin

  $ create-swyft-bot plugins:install someuser/someplugin

create-swyft-bot plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ create-swyft-bot 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
  $ create-swyft-bot plugins:link myplugin

create-swyft-bot plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ create-swyft-bot plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ create-swyft-bot plugins unlink
  $ create-swyft-bot plugins remove

create-swyft-bot plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ create-swyft-bot plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ create-swyft-bot plugins unlink
  $ create-swyft-bot plugins remove

create-swyft-bot plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ create-swyft-bot plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ create-swyft-bot plugins unlink
  $ create-swyft-bot plugins remove

create-swyft-bot plugins update

Update installed plugins.

USAGE
  $ create-swyft-bot plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

create-swyft-bot update [CHANNEL]

update the create-swyft-bot CLI

USAGE
  $ create-swyft-bot update [CHANNEL] [-a] [-v <value> | -i] [--force]

FLAGS
  -a, --available        Install a specific version.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
  --force                Force a re-download of the requested version.

DESCRIPTION
  update the create-swyft-bot CLI

EXAMPLES
  Update to the stable channel:

    $ create-swyft-bot update stable

  Update to a specific version:

    $ create-swyft-bot update --version 1.0.0

  Interactively select version:

    $ create-swyft-bot update --interactive

  See available versions:

    $ create-swyft-bot update --available

See code: @oclif/plugin-update

create-swyft-bot create NAME

Generate a Discord bot

USAGE
  $ create-swyft-bot create NAME -t <value> -p <value> [-o <value>]

ARGUMENTS
  NAME  Bot name

FLAGS
  -o, --out=<value>     [default: .] Output directory
  -p, --prefix=<value>  (required) Bot command prefix
  -t, --token=<value>   (required) Discord bot token

DESCRIPTION
  Generate a Discord bot

EXAMPLES
  $ my-discord-bot generate discord-bot --token "their token" --name "bot name" --prefix "prefix" --out "output directory"
  Generated Discord bot files successfully!

See code: dist/commands/create/index.ts

create-swyft-bot help [COMMANDS]

Display help for create-swyft-bot.

USAGE
  $ create-swyft-bot help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for create-swyft-bot.

See code: @oclif/plugin-help

create-swyft-bot plugins

List installed plugins.

USAGE
  $ create-swyft-bot plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ create-swyft-bot plugins

See code: @oclif/plugin-plugins

create-swyft-bot plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ create-swyft-bot 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
  $ create-swyft-bot plugins add

EXAMPLES
  $ create-swyft-bot plugins:install myplugin 

  $ create-swyft-bot plugins:install https://github.com/someuser/someplugin

  $ create-swyft-bot plugins:install someuser/someplugin

create-swyft-bot plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ create-swyft-bot plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

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

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ create-swyft-bot plugins:inspect myplugin

create-swyft-bot plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ create-swyft-bot 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
  $ create-swyft-bot plugins add

EXAMPLES
  $ create-swyft-bot plugins:install myplugin 

  $ create-swyft-bot plugins:install https://github.com/someuser/someplugin

  $ create-swyft-bot plugins:install someuser/someplugin

create-swyft-bot plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ create-swyft-bot 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
  $ create-swyft-bot plugins:link myplugin

create-swyft-bot plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ create-swyft-bot plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ create-swyft-bot plugins unlink
  $ create-swyft-bot plugins remove

create-swyft-bot plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ create-swyft-bot plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ create-swyft-bot plugins unlink
  $ create-swyft-bot plugins remove

create-swyft-bot plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ create-swyft-bot plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ create-swyft-bot plugins unlink
  $ create-swyft-bot plugins remove

create-swyft-bot plugins update

Update installed plugins.

USAGE
  $ create-swyft-bot plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

Readme

Keywords

Package Sidebar

Install

npm i create-swyft-bot

Weekly Downloads

0

Version

0.1.2

License

MIT

Unpacked Size

32.8 kB

Total Files

12

Last publish

Collaborators

  • swyftpain