Skip to content

sanjbabu/nr-funbucks

 
 

Repository files navigation

Funbucks

Funbucks is tool for generating Fluent Bit configurations that is powered using oclif.

It is not recommended that the tool be installed at this time.

Example 1: Generate for a server

$ ./bin/dev gen -l -s localhost -c deploy_1:inputPath//metrics/\* -c output_kinesis/true -c output_local_lambda/

Example 2: Generate for a server (local testing and override some context variables)

$ ./bin/dev gen -l -s localhost -c deploy_1:inputPath//metrics/\* -c output_kinesis/true -c output_local_lambda/

oclif Version CircleCI Downloads/week License

Usage

$ npm install -g nr-funbucks
$ nr-funbucks COMMAND
running command...
$ nr-funbucks (--version)
nr-funbucks/1.0.0 darwin-x64 node-v17.8.0
$ nr-funbucks --help [COMMAND]
USAGE
  $ nr-funbucks COMMAND
...

Commands

nr-funbucks gen

generate fluentbit configuration

USAGE
  $ nr-funbucks gen -s <value> [-l] [-a <value>] [-c <value>] [-m]

FLAGS
  -a, --app=<value>         app to limit rendering to
  -c, --context=<value>...  [default: ] context override. Examples: appPathJq//tmp/jq, deploy_1:inputPath//tmp/file
  -l, --local               render for local lambda usage
  -m, --multiple            render output in multiple agents if necessary
  -s, --server=<value>      (required) server to render the config for

DESCRIPTION
  generate fluentbit configuration

EXAMPLES
  $ nr-funbucks gen

See code: dist/commands/gen.ts

nr-funbucks help [COMMAND]

Display help for nr-funbucks.

USAGE
  $ nr-funbucks 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 nr-funbucks.

See code: @oclif/plugin-help

nr-funbucks plugins

List installed plugins.

USAGE
  $ nr-funbucks plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ nr-funbucks plugins

See code: @oclif/plugin-plugins

nr-funbucks plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ nr-funbucks plugins:install myplugin 

  $ nr-funbucks plugins:install https://github.com/someuser/someplugin

  $ nr-funbucks plugins:install someuser/someplugin

nr-funbucks plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

nr-funbucks plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ nr-funbucks plugins:install myplugin 

  $ nr-funbucks plugins:install https://github.com/someuser/someplugin

  $ nr-funbucks plugins:install someuser/someplugin

nr-funbucks plugins:link PLUGIN

Links a plugin into the CLI for development.

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

nr-funbucks plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ nr-funbucks plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ nr-funbucks plugins unlink
  $ nr-funbucks plugins remove

nr-funbucks plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ nr-funbucks plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ nr-funbucks plugins unlink
  $ nr-funbucks plugins remove

nr-funbucks plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ nr-funbucks plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ nr-funbucks plugins unlink
  $ nr-funbucks plugins remove

nr-funbucks plugins update

Update installed plugins.

USAGE
  $ nr-funbucks plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 38.7%
  • Nunjucks 32.1%
  • Lua 18.1%
  • Shell 8.2%
  • JavaScript 2.7%
  • Batchfile 0.2%