clim

"clim" is slim command line interface builder for Crystal.

"clim" = "cli" + "slim"

Build Status

Installation

Add this to your application's shard.yml:

dependencies:
  clim:
    github: at-grandpa/clim

Sample Code

require "clim"

module Hello
  class Cli < Clim

    main_command
    desc   "Hello CLI tool."
    usage  "hello [options] [arguments] ..."
    array  "-n NAME",  "--name=NAME",      desc: "Target name.",        default: [] of String
    string "-g WORDS", "--greeting=WORDS", desc: "Words of greetings.", default: "Hello"
    run do |opts, args|
      puts "#{opts.s["greeting"]},"
      puts "#{opts.a["name"].join(", ")}!"
    end

  end
end

Hello::Cli.start(ARGV)
$ crystal build src/hello.cr
$ ./hello -h

  Hello CLI tool.

  Usage:

    hello [options] [arguments] ...

  Options:

    -h, --help                       Show this help.
    -n NAME, --name=NAME             Target name.  [default:[]]
    -g WORDS, --greeting=WORDS       Words of greetings.  [default:Hello]

$ ./hello -n Taro -n Miko -g 'Good night'
Good night,
Taro, Miko!

DSL

require "clim"

module Hello
  class Cli < Clim

    main_command
    #
    # Put main command informations & options here.
    #
    run do |opts, args|
      # Put main command code here.
    end

    sub do
      command "sub_command"
      #
      # Put sub command informations & options here.
      #
      run do |opts, args|
        # Put sub command code here.
      end

      sub do
        command "sub_sub_command"
        #
        # Put sub sub command informations & options here.
        #
        run do |opts, args|
          # Put sub sub command code here.
        end

        # ...

      end
      
      # ...

    end

  end
end

Hello::Cli.start(ARGV)

Usage

require

require "clim"

Command Informations

desc

  desc  "My Command Line Interface."          # Command description.

usage

  usage  "mycli [sub-command] [options] ..."  # Command usage.

Command Options

string

  string "-s ARG", "--string-long-name=ARG", desc: "Option description."  # String option
  run do |opts, args|
    puts opts.string["string-long-name"]  # Get value.
    puts opts.s["string-long-name"]       # Ditto.
  end

bool

  bool  "-b", "--bool-long-name", desc: "Option description."  # Bool option
  run do |opts, args|
    puts opts.bool["bool-long-name"]  # Get value.
    puts opts.b["bool-long-name"]     # Ditto.
  end

array

  array "-a ITEM", "--array-long-name=ITEM", desc: "Option description."  # Array option
  run do |opts, args|
    puts opts.array["array-long-name"]  # Get value.
    puts opts.a["array-long-name"]      # Ditto.
  end

default / required

  string "-s ARG",  "--string-long-name=ARG", default: "default value"               # Default value.
  bool   "-b",      "--bool-long-name",       required: true                         # Required.
  array  "-a ITEM", "--array-long-name=ITEM", default: [] of String, required: true  # Both.

help

  run do |opts, args|
    puts opts.help      # Get help string.
  end

Development

Spec.

$ make spec

Tools

clim-tools

Contributing

  1. Fork it ( https://github.com/at-grandpa/clim/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors