Contents

# encoding: utf-8

module GithubCLI
  class Commands::Contents < Command

    namespace :content

    desc 'get <user> <repo> <path>', 'Get repository <path> contents'
    long_desc <<-DESC
      This method returns the contents of any file or directory in a repository.

      Parameters

      ref - Optional string - The String name of the Commit/Branch/Tag. Defaults to master.
    DESC
    def get(user, repo, path)
      Content.get user, repo, path, options[:params], options[:format]
    end

    desc 'readme <user> <repo>', 'Get the README'
    long_desc <<-DESC
      Parameters

      ref - Optional string - The String name of the Commit/Branch/Tag. Defaults to master.
    DESC
    def readme(user, repo)
      Content.readme user, repo, options[:params], options[:format]
    end

    desc 'archive <user> <repo>', 'Get archive link'
    long_desc <<-DESC
      This method will return a 302 to a URL to download a tarball or zipball
      archive for a repository. Please make sure your HTTP framework is configured
      to follow redirects or you will need to use the Location header to make
      a second GET request.\n

      Note: For private repositories, these links are temporary and expire quickly.

      Parameters

      archive_format - Required string - either tarball or zipball\n
      ref - Optional string - valid Git reference, defaults to master\n
    DESC
    def archive(user, repo)
      Content.archive user, repo, options[:params], options[:format]
    end

  end # Contents
end # GithubCLI

Version data entries

12 entries across 12 versions & 1 rubygems

Version	Path
github_cli-0.5.7	lib/github_cli/commands/contents.rb
github_cli-0.5.6	lib/github_cli/commands/contents.rb
github_cli-0.5.5	lib/github_cli/commands/contents.rb
github_cli-0.5.4	lib/github_cli/commands/contents.rb
github_cli-0.5.3	lib/github_cli/commands/contents.rb
github_cli-0.5.2	lib/github_cli/commands/contents.rb
github_cli-0.5.1	lib/github_cli/commands/contents.rb
github_cli-0.5.0	lib/github_cli/commands/contents.rb
github_cli-0.4.4	lib/github_cli/commands/contents.rb
github_cli-0.4.3	lib/github_cli/commands/contents.rb
github_cli-0.4.2	lib/github_cli/commands/contents.rb
github_cli-0.4.1	lib/github_cli/commands/contents.rb