rbcli 0.1.7 → 0.1.8

data/skeletons/mini/executable

@@ -0,0 +1,241 @@
+#!/usr/bin/env ruby
+
+#########################################################
+### <%= @vars[:cmdname] %>
+#######
+## This is the main executable for <%= @vars[:cmdname] %>.
+## It's job is to load and execute the application.
+#########################################################
+
+require 'rbcli'
+
+#########################
+## Configuration Block ##
+#########################
+# This block is where rbcli is configured.
+# Any options marked as Optional can be commented out.
+# Options marked as Multiple can be declared multiple times.
+#########################
+
+Rbcli::Configurate.me do
+
+	####
+	# GENERAL
+	###
+	# These parameters are for genreal information about your application.
+	###
+
+	## Script Name -- (Required) -- This line identifies the tool's executable on the command line.
+	# To change it, rename this file to the command you want and this will pick up that name automatically.
+	# You can change it manually if needed, but this should work for most cases.
+	scriptname __FILE__.split('/')[-1]
+
+	## Version Number -- (Required)
+	version '0.1.0'
+
+	## Description -- (Requierd) -- A description that will appear when the user looks at the help with -h. This can be as long as needed.
+	description  %q{<%= @vars[:description] %>}
+
+
+	####
+	# LOGGING
+	###
+	# These parameters set the default logging parameters for your applicaiton. Note that a user
+	# can override these settings by modifying their local configuration.
+	# If either option is set to nil, or they are not provided, logging is disabled.
+	###
+
+	## Log Target -- (Optional) -- Set the target for logs.
+	# Valid values are nil, 'STDOUT', 'STDERR', or a file path (as strings).
+	# Default is disabled (nil).
+	log_target nil
+
+	## Log Level -- (Optional) -- Set the default log_level for users.
+	# Valid values are nil, 0-5, or DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN.
+	# Default is disabled (nil).
+	log_level nil
+
+
+	####
+	# USER CONFIGURATION MANAGEMENT
+	###
+	# RBCli allows you to create a configuration file that your users can modify.
+	# Users will be able to generate their own file by running your tool with the `-g` option.
+	# To disable this feature, comment out the `config_userfile` line below.
+	###
+
+	## Config Userfile -- (Optional) -- Set location of user's config file.
+	#
+	#   config_userfile <path>, merge_defaults: <optional: (true|false), default: true>, required: <optional: (true|false, default: false)
+	#
+	# 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
+
+	## 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.
+	# TODO: This line is not needed when using RBCli in standard mode. YAML files go in the `user_configs` directory instead.
+	#config_defaults 'defaults.yml'
+
+	## 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
+
+
+	####
+	# AUTOUPDATE
+	###
+	# RBCli can notify users when you have an update to your application.
+	# This requires your application to be published either on Rubygems.org, Github, or Github Enterprise.
+	# Note that only one can be enabled at a time.
+	# For more details on each integration, see below.
+	###
+
+	## Autoupdate, Github -- (Optional) --  Check for updates to this application at a GitHub repo.
+	# The repo should use version number tags in accordance to Github's best practices: https://help.github.com/articles/creating-releases/
+	#
+	# Note that the `access_token` can be overridden by the user via their configuration file, so it can be left as `nil`,
+	# which will require your users to enter their github tokens to use this feature.
+	# For instructions on generating a new access token, see: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/
+	# The token is not needed if using a public repo.
+	#
+	# 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.
+	#
+	#autoupdate github_repo: '<your_user>/<your_repo>', access_token: nil, enterprise_hostname: nil, force_update: false
+
+	## Autoupdate, Rubygems.org -- (Optional) -- Check for updates to this application on Rubygems.org
+	#autoupdate gem: '<your_gem>', force_update: false
+
+	####
+	# Command Line Options
+	###
+	# Here you can set global options for users on the command line.
+	# RBCli supports commands with syntax as follows:
+	#   toolname [options] command [parameters] [lineitem]
+	#
+	# 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`
+	#
+	# If a default value is not set, it will default to `nil`.
+	#
+	# To specify multiple options, simply copy the line and modify as desired.
+	#
+	# Once parsed, option values will be placed in a hash where they can be accessed via their names as shown above where
+	# they are made available to your hooks and commands.
+	###
+
+	## Option -- (Optional, Multiple) -- Add a global CLI Option
+	option :name, 'Give me your name', type: :string, default: 'Foo', required: false, permitted: ['Jack', 'Jill']
+
+
+	####
+	# HOOKS
+	###
+	# Here you can set hooks that will be run at specified points in the execution chain.
+	# Global CLI options are made available to many of the hooks, but command parameters and lineitems are not.
+	###
+
+	## Default Action -- (Optional) -- The default code to execute when no subcommand is given.
+	# If not present, the help is shown (same as -h)
+	default_action do |opts|
+		puts "Hello, #{opts[:name]}."
+		puts "To see the help, use -h"
+	end
+
+	## Pre-Execution Hook -- (Optional) -- Allows providing a block of code that runs _before_ all commands
+	pre_hook do |opts|
+		puts 'This is a pre-command hook. It executes before the command.'
+	end
+
+	## Post-Execution Hook -- (Optional) -- Allows providing a block of code that runs _after_ all commands
+	post_hook do |opts|
+		puts 'This is a post-command hook. It executes after the command.'
+	end
+
+	## First-Run Hook -- (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.
+	# This feature is dependent on the Local State Storage system, and will not run without it.
+	first_run halt_after_running: false do
+		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 Storage
+	###
+	# 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`.
+	# 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]
+
+
+	###
+	# Remote State Storage
+	###
+	# 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.
+	# 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
+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', default: 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

data/skeletons/project/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/skeletons/project/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/skeletons/project/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+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
+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.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/skeletons/project/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in untitled.gemspec
+gemspec

data/skeletons/project/README.md

@@ -0,0 +1,31 @@
+# <%= @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.
+
+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:
+
+* Review the configuration under the `config` directory
+* Modify global CLI options under the `application/options.rb` file
+* Generate a new command by running `rbcli generate -t command -n <name>`
+* Modify the command's code under `application/commands/<name>.rb`
+* Repeat the previous two steps until complete!
+
+For more details, including advanced usage, please see the [RBCli documentation](https://github.com/akhoury6/rbcli). 
+
+TODO: Delete the text above and write your README!
+
+## About
+
+<%= @vars[:description] %>
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/untitled. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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).

data/skeletons/project/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

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

@@ -0,0 +1,31 @@
+#########################
+## 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', default: 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

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

@@ -0,0 +1,23 @@
+#!/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/skeletons/project/application/options.rb

@@ -0,0 +1,30 @@
+Rbcli::Configurate.me do
+	####
+	# Command Line Options
+	###
+	# Here you can set global options for users on the command line.
+	#
+	# RBCli supports commands with syntax as follows:
+	#   toolname [options] command [parameters] [lineitem]
+	#
+	# 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`
+	#
+	# If a default value is not set, it will default to `nil`.
+	#
+	# To specify multiple options, simply copy the line and modify as desired.
+	#
+	# Once parsed, option values will be placed in a hash where they can be accessed via their names as shown above where
+	# they are made available to your hooks and commands.
+	###
+
+	## Description -- (Required) -- A description that will appear when the user looks at the help with -h.
+	# This should describe what the application does, and if applicable, give some common usage examples.
+	# It can be as long as needed. Use a heredoc if desired: <<-EOF TextGoesHere EOF
+	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']
+end

data/skeletons/project/config/autoupdate.rb

@@ -0,0 +1,32 @@
+Rbcli::Configurate.me do
+	####
+	# AUTOUPDATE
+	###
+	# RBCli can notify users when you have an update to your application.
+	# This requires your application to be published either on Rubygems.org, Github, or Github Enterprise.
+	# Note that only one can be enabled at a time.
+	# For more details on each integration, see below.
+	###
+
+	## Autoupdate, Github -- (Optional) --  Check for updates to this application at a GitHub repo.
+	# The repo should use version number tags in accordance to Github's best practices: https://help.github.com/articles/creating-releases/
+	#
+	# Note that the `access_token` can be overridden by the user via their configuration file, so it can be left as `nil`,
+	# which will require your users to enter their github tokens to use this feature.
+	# For instructions on generating a new access token, see: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/
+	# The token is not needed if using a public repo.
+	#
+	# 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.
+	# Uncomment the line below to enable
+
+	#autoupdate github_repo: '<your_user>/<your_repo>', access_token: nil, enterprise_hostname: nil, force_update: false
+
+
+	## 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
+
+end

data/skeletons/project/config/logging.rb

@@ -0,0 +1,19 @@
+Rbcli::Configurate.me do
+	####
+	# LOGGING
+	###
+	# These parameters set the default logging parameters for your applicaiton. Note that a user
+	# can override these settings by modifying their local configuration.
+	# If either option is set to nil, or they are not provided, logging is disabled.
+	###
+
+	## Log Target -- (Optional) -- Set the target for logs.
+	# Valid values are nil, 'STDOUT', 'STDERR', or a file path (as strings).
+	# Default is disabled (nil).
+	log_target nil
+
+	## Log Level -- (Optional) -- Set the default log_level for users.
+	# Valid values are nil, 0-5, or DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN.
+	# Default is disabled (nil).
+	log_level nil
+end

data/skeletons/project/config/storage.rb

@@ -0,0 +1,34 @@
+###############################
+## State Configuration Block ##
+###############################
+# The state-related componets
+# are configured here.
+###############################
+Rbcli::Configurate.storage do
+	###
+	# Local State Storage
+	###
+	# 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`.
+	# 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]
+
+
+	###
+	# Remote State Storage
+	###
+	# 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.
+	# 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
+end

data/skeletons/project/config/userspace.rb

@@ -0,0 +1,28 @@
+Rbcli::Configurate.me do
+	####
+	# USER CONFIGURATION MANAGEMENT
+	###
+	# RBCli allows you to create a configuration file that your users can modify.
+	# Users will be able to generate their own file by running your tool with the `-g` option.
+	# To disable this feature, comment out the `config_userfile` line below.
+	###
+
+	## Config Userfile -- (Optional) -- Set location of user's config file.
+	#
+	#   config_userfile <path>, merge_defaults: <optional: (true|false), default: true>, required: <optional: (true|false, default: false)
+	#
+	# 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
+
+	## 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.
+	# RBCli's best practice is to leave this line commented, and instead, place all YAML files in
+	# the `default_user_configs` directory where they are loaded automatically.
+	#config_defaults 'defaults.yml'
+
+	## 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/config/version.rb

@@ -0,0 +1,3 @@
+module Project
+	VERSION = '0.1.0'
+end

data/skeletons/project/default_user_configs/user_defaults.yml

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

data/skeletons/project/exe/executable

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+#########################################################
+### <%= @vars[:cmdname] %>
+#######
+## This is the main executable for <%= @vars[:cmdname] %>.
+## It's job is to load and execute the application.
+##
+## You should not need to edit this file.
+#########################################################
+
+require 'rbcli'
+require '../config/version'
+
+#########################
+## Configuration Block ##
+#########################
+# This block is where rbcli is configured.
+# Any options marked as Optional can be commented out.
+# Options marked as Multiple can be declared multiple times.
+#########################
+
+Rbcli::Configurate.me do
+	####
+	# GENERAL
+	###
+	# These parameters are for genreal information about your application.
+	###
+
+	## Script Name -- (Required) -- This line identifies the tool's executable on the command line.
+	# To change it, rename this file to the command you want and this will pick up that name automatically.
+	# You can change it manually if needed, but this should work for most cases.
+	scriptname __FILE__.split('/')[-1]
+
+	## Version Number -- (Required)
+	# Here we reference the same constant that we set for our Gem. If not using Rubygems you can change this to
+	# a version in the standard 'major.minor.patch' format (i.e.: 1.4.0)
+	version Project::VERSION
+end
+
+##################
+## Load Project ##
+##################
+# Here we load the project into Rbcli
+##################
+Rbcli.load_project
+
+#####################
+## Parse Statement ##
+#####################
+# When this statement is called, the CLI will be
+# parsed and code executed.
+#####################
+Rbcli.parse