Consoler

# create an application
app = Consoler::Application.new description: 'A simple app'

# define a command
app.build '[--clean] <output_dir>' do |clean, output_dir|
  # clean contains a boolean
  clean_up if clean

  # output_dir contains a string
  build_project output_dir
end

# run with own args
app.run ['build', 'production', '--clean']

# this does not match, nothing is executed and the usage message is printed
app.run ['deploy', 'production']

# defaults to ARGV
app.run

gem 'consoler', '~> 1.3.0'

Gem::Specification.new do |spec|
  spec.add_dependency 'consoler', '~> 1.3.0'
end

# create an application
app = Consoler::Application.new

# .. or with a description that will show up in the usage message
app = Consoler::Application.new description: 'A simple app'

# create an application
app = Consoler::Application.new

# in the most simple way, you provide a name (the method name) and a block you
# want to execute if it matches
app.build do
  # your code here
end

# to add options to your command, provide a options definition as an argument
app.build '[--clean] [--env=] [-v|--verbose] <output_dir>' do |clean, env, verbose, output_dir|
  # parameters are matched based on name
  # `clean` contains a boolean
  # `env` contains a string or nil if not provided
  # `verbose` contains a number, counting the times it occurred in the arguments
  # `output_dir` contains a string, if needed to match this command
end

# filename: app.rb

# create an application
app = Consoler::Application.new

# a build command
app.build '[--clean] [--env=] [-v|--verbose] <output_dir>' do |clean, env, verbose, output_dir|
  puts 'Starting build...' if verbose > 0

  do_clean_up if clean

  do_build env || 'development', output_dir

  puts 'Build complete' if verbose > 0
end

# a deploy command
app.build '[-v|--verbose] [--env=]' do |env|
  puts 'Starting deploy...' if verbose > 0

  do_deploy env || 'development'

  puts 'Deploy complete' if verbose > 0
end

app = Consoler::Application.new
app.shout '[<first_name> <last_name>] [<name>]' do |first_name, last_name, name|
  # by definition, `last_name` is also filled
  unless first_name.nil? then
    puts "Hello #{first_name} #{last_name}!"
  end

  unless name.nil? then
    puts "Hello #{name}!"
  end
end

# calling with two arguments can fill the first group
# prints "Hello John Doe!"
app.run ['shout', 'John', 'Doe']

# calling with one argument it is not possible to fill the first group
# prints "Hello Mr. White!"
app.run ['shout', 'Mr. White!']

# filename: app.rb

# create a subapplication
android = Consoler::Application.new
android.build do; end

# options are supported just like regular apps
android.clean '--force|-f' do; end

# create an application
app = Consoler::Application.new

# mount the android application on top of the android command
# note that the command does not support options
app.android android

#!/usr/bin/env ruby

db = Consoler::Application.new
db.migrate '-- run all pending migrations' do
  run_migrate
end

db.rollback '[--migrations=] -- rollback a number of migrations' do |migrations|
  run_rollback migrations || 1
end

cache = Consoler::Application.new
cache.clear '[--env=] -- clear the cache for a given environment' do |env|
  run_cache_clear env || 'development'
end

cache.warmup '[--env=] -- warmup the cache for a given environment' do |env|
  run_cache_warmup env || 'development'
end

app = Consoler::Application.new
app.db db
app.cache cache

app.build '[--clean] [--env=] [-v] <output_dir> -- build the project' do |clean, env, v, output_dir|
  puts 'Starting build...' if v > 0

  if clean
    puts 'Starting clean...' if v > 1
    do_clean_up if clean
  end

  do_build env || 'development', output_dir

  puts 'Build complete' if v > 0
end