rbcli 0.1.10 → 0.2.0

data/examples/myscript.sh

@@ -1,23 +0,0 @@
-#!/usr/bin/env bash
-
-###
-# This is the RBCli script for the command {{**CMDNAME**}}
-###
-#
-# You can find RBCli's params, args, global_opts, and config through environment
-# variables. They are passed in the formats:
-#
-#   __PARAMS_<param_name>
-#   __ARGS_<arg_name>
-#   __GOBAL <global_opt_name>
-#   __CONFIG <config_name>
-#
-# If any of the options given had nested values in your RBCli application they
-# will be passed as JSON. You can parse them using jq ( https://stedolan.github.io/jq/ )
-#
-# If you specified any environment variables to be set manually, they will be found unmodified.
-#
-###
-#
-
-env | grep "^__PARAMS\|^__ARGS\|^__GLOBAL\|^__CONFIG"

data/examples/mytool

@@ -1,95 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rbcli'
-
-#########################
-## Configuration Block ##
-#########################
-# This block is where rbcli is configured.
-#########################
-
-Rbcli::Configurate.me do
-	scriptname __FILE__.split('/')[-1]                                     # (Required) This line identifies the tool's executable. You can change it if needed, but this should work for most cases.
-	version '0.1.0'                                                        # (Required) The version number
-	description 'This is my test CLI tool.'                                # (Requierd) A description that will appear when the user looks at the help with -h. This can be as long as needed.
-
-	log_level :info                                                        # (Optional) Set the default log_level for users. 0-5, or DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN
-	log_target 'stderr'                                                    # (Optional) Set the target for logs. Valid values are STDOUT, STDERR, or a file path (as strings)
-
-	config_userfile '/etc/mytool/config.yml', merge_defaults: true, required: false  # (Optional) Set location of user's config file. If merge_defaults=true, user settings override default settings, and if false, defaults are not loaded at all. If required=true, application will not run if file does not exist.
-	config_defaults 'defaults.yml'                                         # (Optional, Multiple) Load a YAML file as part of the default config. This can be called multiple times, and the YAML files will be merged. User config is generated from these
-	config_default :myopt, description: 'Testing this', value: true        # (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config
-
-	option :name, 'Give me your name', type: :string, default: 'Foo', required: false, permitted: ['Jack', 'Jill']  # (Optional, Multiple) Add a global CLI parameter. Supported types are :string, :boolean, :integer, :float, :date, and :io. Can be called multiple times.
-
-	autoupdate github_repo: 'akhoury6/rbcli', access_token: nil, enterprise_hostname: nil, force_update: false    # (Optional) Check for updates to this application at a GitHub repo. The repo must use version number tags in accordance to best practices: https://help.github.com/articles/creating-releases/
-	autoupdate gem: 'rbcli', force_update: false                                                                  # (Optional) Check for updates to this application through RubyGems.org.
-
-	default_action do |opts|                                               # (Optional) The default code to execute when no subcommand is given. If not present, the help is shown (same as -h)
-		puts "Hello, #{opts[:name]}."
-		puts "To see the help, use -h"
-	end
-
-	pre_hook do |opts|                                                     # (Optional) Allows providing a block of code that runs before any command
-		puts 'This is a pre-command hook. It executes before the command.'
-	end
-
-	post_hook do |opts|                                                    # (Optional) Allows providing a block of code that runs after any command
-		puts 'This is a post-command hook. It executes after the command.'
-	end
-
-	first_run halt_after_running: false do                                 # (Optional) Allows providing a block of code that executes the first time that the application is run on a given system. If `halt_after_running` is set to `true` then parsing will not continue after this code is executed. All subsequent runs will not execute this code.
-		puts "This is the first time the mytool command is run! Don't forget to generate a config file with the `-g` option before continuing."
-	end
-end
-
-###############################
-## State Configuration Block ##
-###############################
-# The state-related componets
-# are configured here.
-###############################
-Rbcli::Configurate.storage do
-	local_state '/var/mytool/localstate', force_creation: true, halt_on_error: true                                                   # (Optional) Creates a hash that is automatically saved to a file locally for state persistance. It is accessible to all commands at  Rbcli.localstate[:yourkeyhere]
-	remote_state_dynamodb table_name: 'mytable', region: 'us-east-1', force_creation: true, halt_on_error: true, locking: :auto       # (Optional) Creates a hash that is automatically saved to a DynamoDB table. It is recommended to keep halt_on_error=true when using a shared state. Locking can be one of (:manual :auto :none) -- see the README for details
-end
-
-#########################
-## Command Declaration ##
-#########################
-# With rbcli, commands are declared by subclassing
-# from Rbcli::Command. The name of the class will be
-# the command that is available to the user.
-#########################
-class Test < Rbcli::Command                                                          # Declare a new command by subclassing Rbcli::Command
-	description 'This is a short description.'                                         # (Required) Short description for the global help
-	usage 'This is some really long usage text description!'                           # (Required) Long description for the command-specific help
-	parameter :force, 'Force testing', type: :boolean, default: false, required: false # (Optional, Multiple) Add a command-specific CLI parameter. Can be called multiple times
-
-	config_defaults 'defaults.yml'                                                     # (Optional, Multiple) Load a YAML file as part of the default config. This can be called multiple times, and the YAML files will be merged. User config is generated from these
-	config_default :myopt2, description: 'Testing this again', value: true             # (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config
-
-	extern path: 'env | grep "^__PARAMS\|^__ARGS\|^__GLOBAL\|^__CONFIG"', envvars: {MYVAR: 'some_value'}     # (Required unless `action` defined) Runs a given application, with optional environment variables, when the user runs the command.
-	extern envvars: {MY_OTHER_VAR: 'another_value'} do |params, args, global_opts, config|                   # Alternate usage. Supplying a block instead of a path allows us to modify the command based on the arguments and configuration supplied by the user.
-		"echo #{params[:force].to_s}__YESSS!!!"
-	end
-
-	action do |params, args, global_opts, config|                                        # (Required unless `extern` defined) Block to execute if the command is called.
-		Rbcli::log.info { 'These logs can go to STDERR, STDOUT, or a file' }                       # Example log. Interface is identical to Ruby's logger
-		puts "\nArgs:\n#{args}"                    # Arguments that came after the command on the CLI (i.e.: `mytool test bar baz` will yield args=['bar', 'baz'])
-		puts "Params:\n#{params}"                  # Parameters, as described through the option statements above
-		puts "Global opts:\n#{global_opts}"        # Global Parameters, as descirbed in the Configurate section
-		puts "Config:\n#{config}"                  # Config file values
-		puts "LocalState:\n#{Rbcli.local_state}"   # Local persistent state storage (when available) -- if unsure use Rbcli.local_state.nil?
-		puts "RemoteState:\n#{Rbcli.remote_state}" # Remote persistent state storage (when available) -- if unsure use Rbcli.remote_state.nil?
-		puts "\nDone!!!"
-	end
-end
-
-#####################
-## Parse Statement ##
-#####################
-# When this statement is called, the CLI will be
-# parsed and code executed.
-#####################
-Rbcli.parse       # Parse CLI and execute