rbcli 0.1.10 → 0.2.0

data/lib/rbcli-tool/mdless_fix.rb

@@ -1,3 +1,23 @@
+##################################################################################
+#     RBCli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2018 Andrew Khoury                                           #
+#                                                                                #
+#     This program is free software: you can redistribute it and/or modify       #
+#     it under the terms of the GNU General Public License as published by       #
+#     the Free Software Foundation, either version 3 of the License, or          #
+#     (at your option) any later version.                                        #
+#                                                                                #
+#     This program is distributed in the hope that it will be useful,            #
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of             #
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              #
+#     GNU General Public License for more details.                               #
+#                                                                                #
+#     You should have received a copy of the GNU General Public License          #
+#     along with this program.  If not, see <https://www.gnu.org/licenses/>.     #
+#                                                                                #
+#     For questions regarding licensing, please contact andrew@blacknex.us        #
+##################################################################################
+
 require 'mdless'
 
 def class_exists?(class_name)

data/lib/rbcli-tool/project.rb

@@ -1,3 +1,23 @@
+##################################################################################
+#     RBCli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2018 Andrew Khoury                                           #
+#                                                                                #
+#     This program is free software: you can redistribute it and/or modify       #
+#     it under the terms of the GNU General Public License as published by       #
+#     the Free Software Foundation, either version 3 of the License, or          #
+#     (at your option) any later version.                                        #
+#                                                                                #
+#     This program is distributed in the hope that it will be useful,            #
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of             #
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              #
+#     GNU General Public License for more details.                               #
+#                                                                                #
+#     You should have received a copy of the GNU General Public License          #
+#     along with this program.  If not, see <https://www.gnu.org/licenses/>.     #
+#                                                                                #
+#     For questions regarding licensing, please contact andrew@blacknex.us        #
+##################################################################################
+
 module RBCliTool
 	class Project
 
@@ -22,10 +42,11 @@ module RBCliTool
 				application/commands
 				application/commands/scripts
 				config
-				default_user_configs
+				userconf
 				exe
 				hooks
 				spec
+				lib
 			).each do |folder|
 				FileUtils.mkdir_p "#{@dest}/#{folder}"
 				FileUtils.touch "#{@dest}/#{folder}/.keep"
@@ -38,7 +59,11 @@ module RBCliTool
 			# Create files for Gem package
 			Dir.entries(src).each do |file|
 				next if File.directory? "#{src}/#{file}"
-				RBCliTool.cp_file "#{src}/#{file}", "#{@dest}/", @template_vars
+				if file == "untitled.gemspec"
+					RBCliTool.cp_file "#{src}/#{file}", "#{@dest}/#{@template_vars[:cmdname]}.gemspec", @template_vars
+				else
+					RBCliTool.cp_file "#{src}/#{file}", "#{@dest}/", @template_vars
+				end
 			end
 
 			# Create default config

data/lib/rbcli-tool/util.rb

@@ -1,3 +1,23 @@
+##################################################################################
+#     RBCli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2018 Andrew Khoury                                           #
+#                                                                                #
+#     This program is free software: you can redistribute it and/or modify       #
+#     it under the terms of the GNU General Public License as published by       #
+#     the Free Software Foundation, either version 3 of the License, or          #
+#     (at your option) any later version.                                        #
+#                                                                                #
+#     This program is distributed in the hope that it will be useful,            #
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of             #
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              #
+#     GNU General Public License for more details.                               #
+#                                                                                #
+#     You should have received a copy of the GNU General Public License          #
+#     along with this program.  If not, see <https://www.gnu.org/licenses/>.     #
+#                                                                                #
+#     For questions regarding licensing, please contact andrew@blacknex.us        #
+##################################################################################
+
 require 'erb'
 
 module RBCliTool

data/lib/rbcli-tool.rb

@@ -1,3 +1,23 @@
+##################################################################################
+#     RBCli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2018 Andrew Khoury                                           #
+#                                                                                #
+#     This program is free software: you can redistribute it and/or modify       #
+#     it under the terms of the GNU General Public License as published by       #
+#     the Free Software Foundation, either version 3 of the License, or          #
+#     (at your option) any later version.                                        #
+#                                                                                #
+#     This program is distributed in the hope that it will be useful,            #
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of             #
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              #
+#     GNU General Public License for more details.                               #
+#                                                                                #
+#     You should have received a copy of the GNU General Public License          #
+#     along with this program.  If not, see <https://www.gnu.org/licenses/>.     #
+#                                                                                #
+#     For questions regarding licensing, please contact andrew@blacknex.us        #
+##################################################################################
+
 ###########
 ## RBCLI ##
 ###########

data/lib/rbcli.rb

@@ -1,3 +1,23 @@
+##################################################################################
+#     RBCli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2018 Andrew Khoury                                           #
+#                                                                                #
+#     This program is free software: you can redistribute it and/or modify       #
+#     it under the terms of the GNU General Public License as published by       #
+#     the Free Software Foundation, either version 3 of the License, or          #
+#     (at your option) any later version.                                        #
+#                                                                                #
+#     This program is distributed in the hope that it will be useful,            #
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of             #
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              #
+#     GNU General Public License for more details.                               #
+#                                                                                #
+#     You should have received a copy of the GNU General Public License          #
+#     along with this program.  If not, see <https://www.gnu.org/licenses/>.     #
+#                                                                                #
+#     For questions regarding licensing, please contact andrew@blacknex.us        #
+##################################################################################
+
 ###########
 ## RBCLI ##
 ###########

data/lib-sh/lib-rbcli.sh

@@ -1,4 +1,23 @@
 #!/usr/bin/env bash
+##################################################################################
+#     RBCli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2018 Andrew Khoury                                           #
+#                                                                                #
+#     This program is free software: you can redistribute it and/or modify       #
+#     it under the terms of the GNU General Public License as published by       #
+#     the Free Software Foundation, either version 3 of the License, or          #
+#     (at your option) any later version.                                        #
+#                                                                                #
+#     This program is distributed in the hope that it will be useful,            #
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of             #
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              #
+#     GNU General Public License for more details.                               #
+#                                                                                #
+#     You should have received a copy of the GNU General Public License          #
+#     along with this program.  If not, see <https://www.gnu.org/licenses/>.     #
+#                                                                                #
+#     For questions regarding licensing, please contact andrew@blacknex.us        #
+##################################################################################
 
 ## Log message
 function message {

data/rbcli.gemspec

@@ -1,3 +1,22 @@
+##################################################################################
+#     RBCli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2018 Andrew Khoury                                           #
+#                                                                                #
+#     This program is free software: you can redistribute it and/or modify       #
+#     it under the terms of the GNU General Public License as published by       #
+#     the Free Software Foundation, either version 3 of the License, or          #
+#     (at your option) any later version.                                        #
+#                                                                                #
+#     This program is distributed in the hope that it will be useful,            #
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of             #
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              #
+#     GNU General Public License for more details.                               #
+#                                                                                #
+#     You should have received a copy of the GNU General Public License          #
+#     along with this program.  If not, see <https://www.gnu.org/licenses/>.     #
+#                                                                                #
+#     For questions regarding licensing, please contact andrew@blacknex.us        #
+##################################################################################
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -7,10 +26,10 @@ Gem::Specification.new do |spec|
 	spec.name          = 'rbcli'
 	spec.version       = Rbcli::VERSION
 	spec.authors       = ['Andrew Khoury']
-	spec.email         = ['akhoury@live.com']
+	spec.email         = ['andrew@blacknex.us']
 
-	spec.summary       = %q{A CLI Framework for Ruby}
-	spec.description   = %q{RBCli is a framework to quickly develop command-line tools.}
+	spec.summary       = %q{A CLI Application/Tooling Framework for Ruby}
+	spec.description   = %q{RBCli is a framework to quickly develop command-line tools and applications.}
 	spec.homepage      = 'https://github.com/akhoury6/rbcli'
 	spec.license       = 'MIT'
 

data/skeletons/project/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at akhoury@live.com. All
+reported by contacting the project team at andrew@blacknex.us. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/skeletons/project/README.md

@@ -1,6 +1,6 @@
 # <%= @vars[:cmdname] %>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem.
+Welcome to your new application! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem.
 
 You'll find your gem's Command Line entrypoint under the file `exe/<%= @vars[:cmdname] %>`, although you shouldn't need to edit this file. Instead, follow these steps to get up and running quickly:
 
@@ -18,6 +18,21 @@ TODO: Delete the text above and write your README!
 
 <%= @vars[:description] %>
 
+## Installation
+
+To install this application from source, clone this repo and run:
+
+```bash
+gem build <%= @vars[:cmdname] %>.gemspec
+gem install <%= @vars[:cmdname] %>-*.gem
+```
+
+To install this application from Rubygems.org, run:
+
+```bash
+gem install <%= @vars[:cmdname] %>
+```
+
 ## Development
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `config/version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
@@ -28,4 +43,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 
 ## Code of Conduct
 
-Everyone interacting in the Untitled project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/untitled/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Untitled project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/<%= @vars[:cmdname] %>/blob/master/CODE_OF_CONDUCT.md).

data/skeletons/project/application/commands/command.erb

@@ -5,16 +5,18 @@
 # from Rbcli::Command. The name of the class will be
 # the command that is available to the user.
 #########################
-class <%= @vars[:name].capitalize %> < Rbcli::Command                                                          # Declare a new command by subclassing Rbcli::Command
-	description '<%= @vars[:description] %>'                                         # (Required) Short description for the global help
-	usage '<%= @vars[:usage_text] %>'                           # (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
+class <%= @vars[:name].capitalize %> < Rbcli::Command                                 # Declare a new command by subclassing Rbcli::Command
+	description '<%= @vars[:description] %>'                                            # (Required) Short description for the global help
+	usage <<-EOF
+<%= @vars[:usage_text] %>
+EOF                                                                                   # (Required) Long description for the command-specific help
+	parameter :force, 'Force testing', short: 'f', type: :boolean, default: false, required: false  # (Optional, Multiple) Add a command-specific CLI parameter. Uses the same format as options (see application/options.rb for help)
 
-	config_default :myopt2, description: 'My Option #2', default: 'Default Value Here'           # (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config.
-	# Alternatively, you can simply create a yaml file in the `default_user_configs` directory in your project that specifies the default values of all options
+	config_default :myopt2, description: 'My Option #2', default: 'Default Value Here'  # (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config.
+                                                                                      # Alternatively, you can simply create a yaml file in the `default_user_configs` directory in your project that specifies the default values of all options
 
-	action do |params, args, global_opts, config|                                        # (Required) 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
+	action do |params, args, global_opts, config|                                       # (Required) 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

data/skeletons/project/application/commands/script.erb

@@ -16,7 +16,9 @@ class <%= @vars[:name].capitalize %> < Rbcli::Command
 <% if @vars[:no_script] -%>
 	extern path: 'path/to/application', envvars: {MYVAR: 'some_value'}                               # (Required) 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. This allows passing config settings as command line arguments to external applications. The block must return a string, which is the command to be executed.
-	#	"echo 'Forcing something: #{params[:force].to_s}'"
+	#	cmd = '/path/to/application'
+	#	cmd += ' --test-script foo --ignore-errors' if params[:force]
+	#	cmd
 	#end
 <% else -%>
 	extern path: :default                                                              # (Required): Do not edit this line. Do delete it if you wish to manually specify a script path and set environment variables.

data/skeletons/project/application/commands/scripts/script.sh

@@ -8,8 +8,8 @@
 source $(echo $(cd "$(dirname $(gem which rbcli))/../lib-sh" && pwd)/lib-rbcli.sh)
 #
 # The `rbcli` function is actually a wrapper around `jq` (https://stedolan.github.io/jq/). It can automatically
-# jq on users' machines if running Linux or OSX, and users have sudo access. If not, users must install it manually.
-# This is because behind the scenes, RBCli passes in the variable data by populating evironment variables with JSON.
+# jq on users' machines if running Linux or OSX, and users have sudo access. If not, users will be prompted to install
+# it. RBCli passes in the variable data by populating evironment variables with JSON, and requires JQ to parse them.
 #
 # You can view the entire JSON structures with:
 #

data/skeletons/project/application/options.rb

@@ -10,9 +10,18 @@ Rbcli::Configurate.me do
 	# Here you are defining the [options]. The parameters and lineitms (subcommands) are
 	# defined under their command blocks.
 	#
-	# The following types are supported: `:string`, `:boolean` or `:flag`, `:integer`, and `:float`
+	# Options are defined in the follwoing format:
+	#     option :<name>, "<description_string>", short: '<character>', type: <variable_type>, default: <default_value>, permitted: [<array_of_permitted_values]
 	#
-	# If a default value is not set, it will default to `nil`.
+	#       name:               (Required) The long name of the option, as a symbol. This will be represented as `--name` on the command line
+	#       description_string: (Required) A short description of the command that will appear in the help text for the user
+	#       type:               (Required) The following types are supported: `:string`, `:boolean` or `:flag`, `:integer`, and `:float`
+	#       default:            (Optional) A default value for the option if one isn't entered (default: nil)
+	#       short:              (Optional) A letter that acts as a shortcut for the option. This will allow users to apply the command as `-n`
+	#                                       To not have a short value, set this to :none
+	#                                       (default: the first letter of the long name)
+	#       required:           (Optional) Specify whether the option is required from the user (default: false)
+	#       permitted:          (Optional) An array of whitelisted values for the option (default: nil)
 	#
 	# To specify multiple options, simply copy the line and modify as desired.
 	#
@@ -26,5 +35,5 @@ Rbcli::Configurate.me do
 	description  %q{<%= @vars[:description] %>}
 
 	## Option -- (Optional, Multiple) -- Add a global CLI Option
-	option :name, 'Give me your name', type: :string, default: 'Foo', required: false, permitted: ['Jack', 'Jill']
+	option :name, 'Give me your name', short: 'n', type: :string, default: 'Jack', required: false, permitted: ['Jack', 'Jill']
 end

data/skeletons/project/config/autoupdate.rb

@@ -19,14 +19,17 @@ Rbcli::Configurate.me do
 	# The `enterprise_hostname` setting allows you to point RBCli at a local GitHub Enterprise server.
 	#
 	# Setting `force_update: true` will halt execution if an update is available, forcing the user to update.
+	#
+	# The `message` parameter allows setiting a custom message. Leave as nil to use the default message provided by RBCli.
+	#
 	# Uncomment the line below to enable
 
-	#autoupdate github_repo: '<your_user>/<your_repo>', access_token: nil, enterprise_hostname: nil, force_update: false
+	#autoupdate github_repo: '<your_user>/<your_repo>', access_token: nil, enterprise_hostname: nil, force_update: false, message: nil
 
 
 	## Autoupdate, Rubygems.org -- (Optional) -- Check for updates to this application on Rubygems.org
 	# Uncomment the line below to enable
 
-	#autoupdate gem: '<your_gem>', force_update: false
+	#autoupdate gem: '<your_gem>', force_update: false, message: nil
 
 end

data/skeletons/project/config/storage.rb

@@ -6,29 +6,30 @@
 ###############################
 Rbcli::Configurate.storage do
 	###
-	# Local State Storage
+	# Local State Storage -- (Optional)
 	###
 	# Local state storage creates a hash that is automatically saved to a file locally for state persistance.
 	# It is accessible to all commands at:    Rbcli.localstate[:yourkeyhere]
 	#
 	# Note that every update to the top level of this hash will trigger a save, and updating nested hashes will not.
 	# If you need to update nested hashes, you can trigger a save manually by calling `Rbcli.localstate.commit`.
+	# It is accessible to all commands at: Rbcli.localstate[:yourkeyhere]
 	# Please see the documentation for full usage details.
 	###
 
-	#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]
+	#local_state '/var/mytool/localstate', force_creation: true, halt_on_error: true
 
 
 	###
-	# Remote State Storage
+	# Remote State Storage -- (Optional)
 	###
 	# Remote state storage creates a hash that is automatically saved to a remote database for state persistence.
 	# This state can be made unique to each user, or can be shared across different users of the tool.
 	#
-	# When sharing, locking should be set to `true`. Note that RBCli uses lazy-loaded, meaning the lock will
-	# only be acquired when absolutely needed. This behavior can be overridden manually if desired.
+	# When sharing, locking should be set to `true` to prevent data corruption. Note that RBCli uses lazy-loaded,
+	# meaning the lock will only be acquired when absolutely needed. This behavior can be overridden manually if desired.
 	# For full usage details, see the documentation.
 	###
 
-	#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
+	#remote_state_dynamodb table_name: 'mytable', region: 'us-east-1', force_creation: true, halt_on_error: true, locking: false
 end

data/skeletons/project/config/userspace.rb

@@ -14,7 +14,11 @@ Rbcli::Configurate.me do
 	# If merge_defaults=true, user settings override default settings.
 	# If false, defaults set here are not loaded at all, and the user is required to set them.
 	# If required=true, application will not run if file does not exist.
-	config_userfile '~/.<%= @vars[:cmdname] %>', merge_defaults: true, required: false
+	#
+	# If the path is set to nil, the config file is disabled
+
+	#config_userfile '~/.<%= @vars[:cmdname] %>', merge_defaults: true, required: false
+	config_userfile nil
 
 	## Config Defaults -- (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 files.
@@ -24,5 +28,6 @@ Rbcli::Configurate.me do
 
 	## Config Default -- (Optional, Multiple) -- Specify an individual configuration parameter and set a default value.
 	# These will be included in generated user config.
+
 	config_default :myopt, description: 'Testing this', default: true
 end

data/skeletons/project/exe/executable

@@ -10,7 +10,7 @@
 #########################################################
 
 require 'rbcli'
-require '../config/version'
+require "#{File.dirname(__FILE__)}/../config/version"
 
 #########################
 ## Configuration Block ##

data/skeletons/project/untitled.gemspec

@@ -1,7 +1,7 @@
 
 config = File.expand_path("../config", __FILE__)
 $LOAD_PATH.unshift(config) unless $LOAD_PATH.include?(config)
-require 'config/version'
+require 'version.rb'
 
 Gem::Specification.new do |spec|
   spec.name          = "<%= @vars[:cmdname] %>"
@@ -9,10 +9,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["TODO: Your Name Here"]
   spec.email         = ["TODO: Your Email Here"]
 
-  spec.summary       = %q{TODO: Write a short summary, because RubyGems requires one.}
+  spec.summary       = %q{<%= @vars[:description] %>}
   spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = "TODO: Put your gem's website or public repo URL here."
-  spec.license       = nil
+  spec.license       = "None"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["application", "config", "default_user_configs", "hooks"]
+  spec.require_paths = ["application", "config", "default_user_configs", "hooks", "lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbcli
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Khoury
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-23 00:00:00.000000000 Z
+date: 2018-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,9 +150,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
-description: RBCli is a framework to quickly develop command-line tools.
+description: RBCli is a framework to quickly develop command-line tools and applications.
 email:
-- akhoury@live.com
+- andrew@blacknex.us
 executables:
 - rbcli
 extensions: []
@@ -160,6 +160,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -168,9 +169,83 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- examples/defaults.yml
-- examples/myscript.sh
-- examples/mytool
+- docs-src/docs/advanced/automatic_updates.md
+- docs-src/docs/advanced/command_types.md
+- docs-src/docs/advanced/distributed_state_locking.md
+- docs-src/docs/advanced/hooks.md
+- docs-src/docs/advanced/logging.md
+- docs-src/docs/advanced/state_storage.md
+- docs-src/docs/advanced/user_config_files.md
+- docs-src/docs/development/code_of_conduct.md
+- docs-src/docs/development/contributing.md
+- docs-src/docs/development/license.md
+- docs-src/docs/imported/changelog.md
+- docs-src/docs/imported/quick_reference.md
+- docs-src/docs/index.md
+- docs-src/docs/tutorial/10-getting_started.md
+- docs-src/docs/tutorial/20-project_layout.md
+- docs-src/docs/tutorial/30-your_first_command.md
+- docs-src/docs/tutorial/40-options_parameters_and_arguments.md
+- docs-src/docs/tutorial/50-publishing.md
+- docs-src/docs/whoami.md
+- docs-src/makesite.sh
+- docs-src/mkdocs.yml
+- docs-src/runsite.sh
+- docs/404.html
+- docs/advanced/automatic_updates/index.html
+- docs/advanced/command_types/index.html
+- docs/advanced/distributed_state_locking/index.html
+- docs/advanced/hooks/index.html
+- docs/advanced/state_storage/index.html
+- docs/advanced/user_config_files/index.html
+- docs/assets/fonts/font-awesome.css
+- docs/assets/fonts/material-icons.css
+- docs/assets/fonts/specimen/FontAwesome.ttf
+- docs/assets/fonts/specimen/FontAwesome.woff
+- docs/assets/fonts/specimen/FontAwesome.woff2
+- docs/assets/fonts/specimen/MaterialIcons-Regular.ttf
+- docs/assets/fonts/specimen/MaterialIcons-Regular.woff
+- docs/assets/fonts/specimen/MaterialIcons-Regular.woff2
+- docs/assets/images/favicon.png
+- docs/assets/images/icons/bitbucket.1b09e088.svg
+- docs/assets/images/icons/github.f0b8504a.svg
+- docs/assets/images/icons/gitlab.6dd19c00.svg
+- docs/assets/javascripts/application.a59e2a89.js
+- docs/assets/javascripts/lunr/lunr.da.js
+- docs/assets/javascripts/lunr/lunr.de.js
+- docs/assets/javascripts/lunr/lunr.du.js
+- docs/assets/javascripts/lunr/lunr.es.js
+- docs/assets/javascripts/lunr/lunr.fi.js
+- docs/assets/javascripts/lunr/lunr.fr.js
+- docs/assets/javascripts/lunr/lunr.hu.js
+- docs/assets/javascripts/lunr/lunr.it.js
+- docs/assets/javascripts/lunr/lunr.jp.js
+- docs/assets/javascripts/lunr/lunr.multi.js
+- docs/assets/javascripts/lunr/lunr.no.js
+- docs/assets/javascripts/lunr/lunr.pt.js
+- docs/assets/javascripts/lunr/lunr.ro.js
+- docs/assets/javascripts/lunr/lunr.ru.js
+- docs/assets/javascripts/lunr/lunr.stemmer.support.js
+- docs/assets/javascripts/lunr/lunr.sv.js
+- docs/assets/javascripts/lunr/lunr.tr.js
+- docs/assets/javascripts/lunr/tinyseg.js
+- docs/assets/javascripts/modernizr.1aa3b519.js
+- docs/assets/stylesheets/application-palette.6079476c.css
+- docs/assets/stylesheets/application.ba0fd1a6.css
+- docs/development/code_of_conduct/index.html
+- docs/development/contributing/index.html
+- docs/development/license/index.html
+- docs/imported/changelog/index.html
+- docs/imported/quick_reference/index.html
+- docs/index.html
+- docs/search/search_index.json
+- docs/sitemap.xml
+- docs/tutorial/10-getting_started/index.html
+- docs/tutorial/20-project_layout/index.html
+- docs/tutorial/30-your_first_command/index.html
+- docs/tutorial/40-options_parameters_and_arguments/index.html
+- docs/tutorial/50-publishing/index.html
+- docs/whoami/index.html
 - exe/rbcli
 - lib-sh/lib-rbcli.sh
 - lib/rbcli-tool.rb
@@ -217,15 +292,16 @@ files:
 - skeletons/project/config/storage.rb
 - skeletons/project/config/userspace.rb
 - skeletons/project/config/version.rb
-- skeletons/project/default_user_configs/user_defaults.yml
 - skeletons/project/exe/executable
 - skeletons/project/hooks/default_action.rb
 - skeletons/project/hooks/first_run.rb
 - skeletons/project/hooks/post_execution.rb
 - skeletons/project/hooks/pre_execution.rb
+- skeletons/project/lib/.keep
 - skeletons/project/spec/spec_helper.rb
 - skeletons/project/spec/untitled_spec.rb
 - skeletons/project/untitled.gemspec
+- skeletons/project/userconf/user_defaults.yml
 homepage: https://github.com/akhoury6/rbcli
 licenses:
 - MIT
@@ -249,5 +325,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: A CLI Framework for Ruby
+summary: A CLI Application/Tooling Framework for Ruby
 test_files: []

data/examples/defaults.yml

@@ -1,4 +0,0 @@
-# Mytool custom settings
-optionA: value     # We are setting this value just because
-optionB: value2    # Same here
-optionC: value3    # You get the picture