Ruby Thor命令行工具命令

Question

我正计划制作我的第一个命令行工具，并且想知道命名和命令的工作方式。

我希望我的工具的功能类似于Git，从某种意义上说，您只需安装它，然后运行命令，只需输入git clone或git commit 。 在许多示例中，我已经看到工具类似于thor foo:bar或./foo.rb bar 。

我的主要问题是如何做到这一点，如果我的工具名称是Foo ，并且工具中的命令是bar ，那么用户要做的就是在命令行中运行Foo bar 。

Answer 1

对于git clone ，它的工作方式是执行git程序并将clone作为参数传递给它。 因此，如果您有几个应该以类似方式启动的脚本，则可以创建一个小型启动器。 该代码在bash中（但是脚本与sh兼容，因此您可以安全地将shebang更改为/bin/sh ）。 用任何其他语言编写相同的东西非常容易。

#!/bin/bash

command=$1
shift

case $1 in    
    cmd1)
        echo "Executing command #1"
        ./smallcmd1 "$@"
        ;;
    cmd2)
        echo "Executing command $command"
        ./smallcmd2 "$@"
        ;;
    '')
        echo 'No option specified'
        exit 1
        ;;

    *) echo "Invalid option"
        exit 1
        ;;
esac
exit $?

其中smallcmd是您的辅助命令脚本或程序。

现在您可以执行它：

./mycommand smallcmd1

也可以传递其他参数。

如果将此脚本放置在任何$ PATH目录中，则可以省略./如下所示：

mycommand smallcmd1

Answer 2

使用Thor编写可执行文件非常简单。 您要做的就是：

• 包括红宝石shebang线。
• 在脚本中要求“ thor”。
• 定义您的雷神类。
• 将#{YourThorClassname}.start添加到脚本的底部。

示例：my-cli.rb

#!/usr/bin/env ruby

require "thor"

class MyCLI < Thor
  desc "foo", "Prints foo"
  def foo
    puts "foo"
  end
end

MyCLI.start

使脚本可执行：

chmod a+x my-cli.rb

现在您可以输入：

./my-cli.rb foo

您可以在Thor Wiki中找到类似的示例和更多帮助。

您甚至可以将文件重命名为my-cli （不带.rb扩展名），并且由于文件中的ruby shebang而仍然有效。