argz
🐲 Argz
Command-line application library for Crystal.
Installation
Add this to your application's shard.yml
:
dependencies:
argz:
github: picatz/argz
Usage
require "argz"
Hello World Application
Argz::App.build do
name "Example Application"
version "1.0.0"
command "Example" do
long "--hello-world"
summary "Basic hello world command-line option."
action do
puts "Hello World!"
end
end
end
Argz::App.run!
Default / Help Output
Hello World
Version: 1.0.0
Usage: app.cr [Options]
--hello-world Basic hello world command-line option.
-h --help Print out this help menu.
Each Argument
Accessing each argument that has been passed to the command-line is fairly straight-forward:
Argz::Raw.each do |argument|
puts argument # do something with it
end
All Arguments
To get a big glob of all the possible arguments that were given:
all = Argz::Raw.all
all.class
# => Array(String)
all.each do |argument|
# do something with the argument
end
Flags
Command-line arguments are usually specified with flags. Flags start with a "-" when passed into the application. Where? At the command-line, naturally. However,
Argz::Raw.add(flag_or_flags)
Allows us to append arguments to simulate if the arguments were passed to the command-line.
Argz::Raw.is_flag?(flag)
Will check if a given flag has been passed into the command-line.
Argz::Raw.is_flag_like?(flag)
Will check if a given string could pass for the flag, but won't check if it actually has been passed as a command-line argument.
# Add raw command-line arguments to ARGV
Argz::Raw.add(["-key", "value"]
# Check if a given string is a given command-line flag.
Argz::Raw.is_flag?("-key")
# => true
# This flag hasn't been added as a command-line argument.
Argz::Raw.is_flag?("-nope")
# => false
# Check if a given string is flag-like.
Argz::Raw.is_flag_like?("-nope")
# => true
Arguments
Arguments for flags exist, but sometimes they don't! How do you work with them?
Argz::Raw.arguments_to(flag)
will return an array with arguments for that flag if they exist.
Argz::Raw.arguments_to?(flag)
will return a boolean; true if the flag has arguments, and false if doesn't.
Argz::Raw.add("-example", "-example2", "a", "b", "c")
# No arguments given for this flag.
Argz::Raw.arguments_to?("-example")
# => false
Argz::Raw.arguments_to("-example")
# => []
# Arguments given for this flag.
Argz::Raw.arguments_to?("-example2")
# => true
Argz::Raw.arguments_to("-example2")
# => ["a", "b", "c"]
Contributors
- picat Kent Gruber - creator, maintainer
argz
- 2
- 0
- 0
- 0
- 0
- over 7 years ago
- July 30, 2017
MIT License
Thu, 07 Nov 2024 10:03:01 GMT