class GithubExporter::CLI

Public Instance Methods

export() click to toggle source
# File lib/github_exporter/cli.rb, line 32
def export
  exporter = GithubExporter::Exporter.new options[:url],
                                          exts:        options[:exts],
                                          non_exts:    options[:non_exts],
                                          theme:       options[:theme],
                                          output_name: options[:output_name]

  exporter.export
end
usage() click to toggle source
# File lib/github_exporter/cli.rb, line 43
    def usage
      puts <<-EOS
Usage:

  $github_exporter -u, --url=URL \
                   -e, --exts=EXT1 EXT2 EXT3 \
                   -t, --theme=theme_name \
                   -o, --output-name=output_file.pdf

Example:

  # Export the *.rb from the given repository

  $github_exporter -e rb -u https://github.com/agilecreativity/github_exporter.git

  # Export the *.rb and also 'Gemfile' from a 'github_exporter' directory
  # Note: this directory must be directly below the current directory

  $github_exporter -e rb -f Gemfile -u github_exporter

  # Same as previous command with the 'solarized' instead of 'default' colorscheme
  $github_exporter -e rb -f Gemfile -u filename_cleaner -t solarized

Options:

  -u, --url=URL                   # The full url of the github project to be cloned OR local directory name

  -e, --exts=EXT1 EXT2 EXT3 ..    # The list of extension names to be exported
                                  # e.g. -e md rb java

  -f, [--non-exts=one two three]  # The list of file without extension to be exported
                                  # e.g. -f Gemfile LICENSE

  -t, [--theme=theme_name]        # The theme/colorscheme to be used with vim_printer see :help :colorscheme from inside Vim
                                  # default: 'default'
                                  # e.g. -t solarized

  -o, [--output-name=output.pdf]  # The output pdf filename (will default to 'repository_name'.pdf)
                                  # e.g. -o repository_name.pdf

Export a given Github project or a local project directory to a single pdf file

      EOS
    end