Table of Contents - RDoc Documentation
Pages
CONTRIBUTING
Contributing to hub
What makes a good hub feature
How to install dependencies and run tests
How hub works
How to write tests
Gemfile
Gemfile.lock
LICENSE
README
git + hub = github
expands to:
Installation
Homebrew
rake install from source
Download or clone the project from GitHub:
Windows “Git Bash” (msysGit) note
RubyGems
Standalone via RubyGems
Help! It's slow!
Is hub noticeably slower than plain git?
Is your shell prompt slow?
Aliasing
Shell tab-completion
Commands
git clone
git remote add
git fetch
git cherry-pick
git am, git apply
git fork
git pull-request
git checkout
git merge
git create
git init
git push
git browse
git compare
git submodule
git ci-status
git help
Configuration
GitHub OAuth authentication
HTTPS instead of git protocol
default behavior
opt into HTTPS:
Meta
Prior art
Rakefile
hub.bash_completion.sh
hub.zsh_completion
alias.feature
authentication.feature
bash_completion.feature
browse.feature
checkout.feature
ci_status.feature
clone.feature
compare.feature
create.feature
fetch.feature
fork.feature
merge.feature
pull_request.feature
remote_add.feature
submodule_add.feature
git
open
zsh_completion.feature
changed-version.sh
commit-msg.sh
install
hub.gemspec
hub.1
hub.1.html
hub.1.ronn
test
deps.rip
git
open
CGI.html
Hub.html
Args.html
Commands.html
Context.html
Branch.html
Error.html
FatalError.html
GitReader.html
GitReaderMethods.html
GithubProject.html
GithubURL.html
LocalRepo.html
Remote.html
System.html
GitHubAPI.html
Configuration.html
Exceptions.html
FileStore.html
GistAuth.html
HttpMethods.html
ResponseMethods.html
OAuth.html
Verbose.html
JSON.html
Generator.html
Runner.html
SshConfig.html
Standalone.html
Object.html
URI.html
HTTP.html
index.html
darkfish.js
jquery.js
navigation.js
search.js
search_index.js
searcher.js
rdoc.css
table_of_contents.html
LICENSE
README
git + hub = github
expands to:
Installation
Homebrew
rake install from source
Download or clone the project from GitHub:
Windows “Git Bash” (msysGit) note
RubyGems
Standalone via RubyGems
Help! It's slow!
Is hub noticeably slower than plain git?
Is your shell prompt slow?
Aliasing
Shell tab-completion
Commands
git clone
git remote add
git fetch
git cherry-pick
git am, git apply
git fork
git pull-request
git checkout
git merge
git create
git init
git push
git browse
git compare
git submodule
git ci-status
git help
Configuration
GitHub OAuth authentication
HTTPS instead of git protocol
default behavior
opt into HTTPS:
Meta
Prior art
Rakefile
hub.1
hub.1.html
hub.1.ronn
hub-1.12.1.gemspec
Classes/Modules
CGI
ContextTest
ContextTest::Context
FileStoreTest
FileStoreTest::OrderedHash
Hub
Hub::Args
Hub::Commands
> “git://github.com/rtomayko/tilt.git”
> “git://github.com/rtomayko/tilt.git”
Hub::Context
Hub::Context::Branch
Hub::Context::Error
Hub::Context::FatalError
Hub::Context::GitReader
Hub::Context::GitReaderMethods
Hub::Context::GithubProject
Hub::Context::GithubURL
Hub::Context::LocalRepo
Hub::Context::Remote
Hub::Context::System
Hub::GitHubAPI
Hub::GitHubAPI::Configuration
Hub::GitHubAPI::Exceptions
Hub::GitHubAPI::FileStore
Hub::GitHubAPI::GistAuth
Hub::GitHubAPI::HttpMethods
Hub::GitHubAPI::HttpMethods::ResponseMethods
Hub::GitHubAPI::OAuth
Hub::GitHubAPI::Verbose
Hub::JSON
Hub::JSON::Generator
Hub::LocalServer
Hub::LocalServer::Identify
Hub::LocalServer::JsonParamsParser
Hub::Runner
Hub::SshConfig
Hub::Standalone
HubTest
Minitest
Minitest::Test
Object
RSpec
SimpleCommand
StandaloneTest
URI
URI::HTTP
WEBrick
WEBrick::HTTPStatus
WebMock
Methods
::=== — URI
::=== — Hub::GitHubAPI::Exceptions
::[] — FileStoreTest::OrderedHash
::default_host — Hub::Context::LocalRepo
::encode_www_form — URI
::escape — CGI
::execute — Hub::Runner
::extended — Hub::Context::GitReaderMethods
::from_url — Hub::Context::GithubProject
::main_host — Hub::Context::LocalRepo
::new — Hub::Runner
::new — Hub::LocalServer
::new — Hub::JSON
::new — Hub::GitHubAPI::Configuration
::new — Hub::GitHubAPI::FileStore
::new — URI::HTTP
::new — Hub::Context::GitReader
::new — Hub::SshConfig
::new — Hub::Context::GithubProject
::new — Hub::GitHubAPI
::new — SimpleCommand
::new — Hub::Context::GithubURL
::new — ContextTest::Context
::new — Hub::Args
::new — FileStoreTest::OrderedHash
::parse — URI
::parse — Hub::JSON
::ports — Hub::LocalServer
::resolve — Hub::Context::GithubURL
::run — SimpleCommand
::start_sinatra — Hub::LocalServer
::unescape — CGI
#"--help" — Hub::Commands
#"--version" — Hub::Commands
#== — Hub::Context::GithubProject
#== — Hub::Context::Remote
#Hub — Minitest::Test
#URI — Object
#[]= — FileStoreTest::OrderedHash
#add_exec_flags — Hub::Context::GitReader
#add_exec_flags — Hub::Args
#after — Hub::Args
#alias — Hub::Commands
#am — Hub::Commands
#announcer — Object
#api_host — Hub::GitHubAPI
#apply — Hub::Commands
#apply_authentication — Hub::GitHubAPI::GistAuth
#apply_authentication — Hub::GitHubAPI::OAuth
#apply_authentication — Hub::GitHubAPI::HttpMethods
#askpass — Hub::GitHubAPI::Configuration
#assert — Hub::LocalServer
#assert_basic_auth — Hub::LocalServer
#assert_command — Minitest::Test
#assert_command_run — Object
#assert_commands — Minitest::Test
#assert_forwarded — Minitest::Test
#assert_includes — Minitest::Test
#assert_not_includes — Minitest::Test
#assert_output — Minitest::Test
#before — Hub::Args
#branch_at_ref — Hub::Context::LocalRepo
#browse — Hub::Commands
#browser_launcher — Hub::Context::System
#build — Hub::Standalone
#byte_size — Hub::GitHubAPI::HttpMethods
#call — Hub::LocalServer::JsonParamsParser
#call — Hub::LocalServer::Identify
#chained? — Hub::Args
#changed? — Hub::Args
#checkout — Hub::Commands
#cherry_pick — Hub::Commands
#ci_status — Hub::Commands
#clone — Hub::Commands
#command — Hub::Runner
#command? — Hub::Context::System
#commands — Hub::Args
#commands — Hub::Runner
#commit_patch — Hub::GitHubAPI
#compare — Hub::Commands
#configure_connection — Hub::GitHubAPI::HttpMethods
#create — Hub::Commands
#create_connection — Hub::GitHubAPI::HttpMethods
#create_pullrequest — Hub::GitHubAPI
#create_repo — Hub::GitHubAPI
#current_branch — Hub::Context::LocalRepo
#data — Hub::GitHubAPI::HttpMethods::ResponseMethods
#data? — Hub::GitHubAPI::HttpMethods::ResponseMethods
#detailed_version — Hub::Standalone
#dump — Hub::JSON::Generator
#dump_body — Hub::GitHubAPI::Verbose
#dump_headers — Hub::GitHubAPI::Verbose
#dump_request_info — Hub::GitHubAPI::Verbose
#dump_response_info — Hub::GitHubAPI::Verbose
#e_note — Hub::Commands
#each — FileStoreTest::OrderedHash
#each_source_file — Hub::Standalone
#edit_hub_config — Object
#edit_hub_config — Minitest::Test
#empty_commit — Object
#error_message — Hub::GitHubAPI::HttpMethods::ResponseMethods
#error_message? — Hub::GitHubAPI::HttpMethods::ResponseMethods
#error_sentences — Hub::GitHubAPI::HttpMethods::ResponseMethods
#exec — Hub::Runner
#execute — Hub::Runner
#execute_command_chain — Hub::Runner
#fallback_noecho — Hub::GitHubAPI::Configuration
#fetch — Hub::Commands
#fetch_value — Hub::GitHubAPI::FileStore
#file_exist? — Hub::Context::LocalRepo
#file_read — Hub::Context::LocalRepo
#finalize_request — Hub::GitHubAPI::Verbose
#finalize_request — Hub::GitHubAPI::HttpMethods
#find_proxy — URI::HTTP
#flags — Hub::Args
#fork — Hub::Commands
#fork_repo — Hub::GitHubAPI
#generate — Hub::JSON::Generator
#get — Hub::GitHubAPI::HttpMethods
#get_all — Hub::GitHubAPI::HttpMethods
#get_value — Hub::SshConfig
#getbyte — Hub::GitHubAPI::Configuration
#gist_raw — Hub::GitHubAPI
#git_editor — Hub::Context
#git_url — Hub::Context::GithubProject
#github_url — Hub::Context::Remote
#has_flag? — Hub::Args
#help — Hub::Commands
#history — Object
#hub — Hub::Commands
#hub — Minitest::Test
#init — Hub::Commands
#input_parsed? — Hub::LocalServer::JsonParamsParser
#json — Hub::LocalServer
#known_host? — Hub::Context::LocalRepo
#links — Hub::GitHubAPI::HttpMethods::ResponseMethods
#load — Hub::GitHubAPI::FileStore
#main_project — Hub::Context::LocalRepo
#master? — Hub::Context::Branch
#master_branch — Hub::Context::LocalRepo
#matches? — Object
#matches_with_dumb_content_type — Object
#merge — Hub::Commands
#mkdir_p — Hub::GitHubAPI::FileStore
#name — Hub::Context::LocalRepo
#name_with_owner — Hub::Context::GithubProject
#next_url — Hub::GitHubAPI::HttpMethods::ResponseMethods
#noecho — Hub::GitHubAPI::Configuration
#noop! — Hub::Args
#noop? — Hub::Args
#normalize_hash — Object
#normalize_host — Hub::GitHubAPI::Configuration
#oauth_token — Hub::GitHubAPI::Configuration
#obtain_oauth_token — Hub::GitHubAPI::OAuth
#origin_remote — Hub::Context::LocalRepo
#osx? — Hub::Context::System
#owned_by — Hub::Context::GithubProject
#parse — Hub::JSON
#parse_file — Hub::SshConfig
#password — Hub::GitHubAPI::Configuration
#perform_request — Hub::GitHubAPI::HttpMethods
#perform_request — Hub::GitHubAPI::Verbose
#persist_next_change! — Hub::GitHubAPI::FileStore
#port — URI::HTTP
#post — Hub::GitHubAPI::HttpMethods
#post_form — Hub::GitHubAPI::HttpMethods
#private? — Hub::Context::GithubProject
#project — Hub::Context::Remote
#project_path — Hub::Context::GithubURL
#prompt — Hub::GitHubAPI::Configuration
#prompt_auth_code — Hub::GitHubAPI::Configuration
#prompt_password — Hub::GitHubAPI::Configuration
#protocol — Hub::GitHubAPI::Configuration
#proxy_uri — Hub::GitHubAPI::Configuration
#pull_request — Hub::Commands
#pullrequest_info — Hub::GitHubAPI
#pullrequest_patch — Hub::GitHubAPI
#push — Hub::Commands
#push_target — Hub::Context::Branch
#read — Hub::Context::GitReader
#read_config — Hub::Context::GitReader
#record_setting — Hub::SshConfig
#remote — Hub::Context::GithubProject
#remote — Hub::Commands
#remote? — Hub::Context::Branch
#remote_branch_and_project — Hub::Context::LocalRepo
#remote_by_name — Hub::Context::LocalRepo
#remote_name — Hub::Context::Branch
#remotes — Hub::Context::LocalRepo
#remotes_for_publish — Hub::Context::LocalRepo
#remotes_group — Hub::Context::LocalRepo
#repo_exists? — Hub::GitHubAPI
#repo_host — Hub::Context::LocalRepo
#repo_info — Hub::GitHubAPI
#repo_owner — Hub::Context::LocalRepo
#request_uri — URI::HTTP
#request_uri — Hub::GitHubAPI::HttpMethods
#responsive? — Hub::LocalServer
#ruby_executable — Hub::Standalone
#ruby_shebang — Hub::Standalone
#run — Hub::Commands
#run — SimpleCommand
#run_silent — Object
#save — Hub::Standalone
#save — Hub::GitHubAPI::FileStore
#save_if_needed — Hub::GitHubAPI::FileStore
#server_options — Hub::LocalServer
#set_shell — Object
#setup — ContextTest
#setup — HubTest
#setup — FileStoreTest
#setup — StandaloneTest
#short_name — Hub::Context::Branch
#skip! — Hub::Args
#skip? — Hub::Args
#ssh_config — Hub::Context::LocalRepo
#start — Hub::LocalServer
#start_handler — Hub::LocalServer
#status — Hub::GitHubAPI::HttpMethods::ResponseMethods
#statuses — Hub::GitHubAPI
#stop — Hub::LocalServer
#stub! — Hub::Context::GitReader
#stub_command_output — Hub::Context::GitReader
#stub_config_value — Hub::Context::GitReader
#submodule — Hub::Commands
#success? — Hub::GitHubAPI::HttpMethods::ResponseMethods
#teardown — HubTest
#teardown — StandaloneTest
#terminal_width — Hub::Context::System
#test_am_commit_url — HubTest
#test_am_gist — HubTest
#test_am_no_tmpdir — HubTest
#test_am_pull_request — HubTest
#test_am_untouched — HubTest
#test_apply_commit_url — HubTest
#test_apply_gist — HubTest
#test_apply_pull_request — HubTest
#test_apply_untouched — HubTest
#test_cherry_pick — HubTest
#test_cherry_pick_github_notation_too_short — HubTest
#test_cherry_pick_github_notation_with_remote_add — HubTest
#test_cherry_pick_github_user_notation — HubTest
#test_cherry_pick_github_user_repo_notation — HubTest
#test_cherry_pick_origin_url — HubTest
#test_cherry_pick_url — HubTest
#test_cherry_pick_url_with_fragment — HubTest
#test_cherry_pick_url_with_remote_add — HubTest
#test_context_method_doesnt_hijack_git_command — HubTest
#test_custom_browser — HubTest
#test_cygwin_browser — HubTest
#test_editor — ContextTest
#test_editor_with_argument — ContextTest
#test_editor_with_curly_brackets_embedded_env_variable — ContextTest
#test_editor_with_embedded_env_variable — ContextTest
#test_editor_with_env_variable — ContextTest
#test_editor_with_spaces — ContextTest
#test_editor_with_tilde — ContextTest
#test_exec_path — HubTest
#test_exec_path_arg — HubTest
#test_global_flags_preserved — HubTest
#test_help — HubTest
#test_help_by_default — HubTest
#test_help_custom_command — HubTest
#test_help_flag_on_command — HubTest
#test_help_hub — HubTest
#test_help_hub_no_groff — HubTest
#test_help_short_flag_on_command — HubTest
#test_help_with_pager — HubTest
#test_html_path — HubTest
#test_hub_browse_no_repo — HubTest
#test_hub_browse_ssh_alias — HubTest
#test_hub_browse_ssh_github_alias — HubTest
#test_hub_standalone — HubTest
#test_init — HubTest
#test_init_enterprise — HubTest
#test_linux_browser — HubTest
#test_no_browser — HubTest
#test_not_choking_on_ruby_methods — HubTest
#test_pullrequest_alias — HubTest
#test_pullrequest_enterprise_no_tracking — HubTest
#test_pullrequest_from_branch_tracking_local — HubTest
#test_push_current_branch — HubTest
#test_push_more — HubTest
#test_push_multiple_refs — HubTest
#test_push_two — HubTest
#test_push_untouched — HubTest
#test_standalone — StandaloneTest
#test_standalone_save — StandaloneTest
#test_standalone_save_doesnt_exist — StandaloneTest
#test_standalone_save_permission_denied — StandaloneTest
#test_version — HubTest
#test_yaml_dump — FileStoreTest
#test_yaml_load — FileStoreTest
#test_yaml_load_quoted — FileStoreTest
#tmux_completion_menu — Object
#tmux_completion_menu_basic — Object
#tmux_kill_pane — Object
#tmux_pane? — Object
#tmux_pane_contents — Object
#tmux_send_keys — Object
#tmux_send_tab — Object
#tmux_wait_for_completion — Object
#tmux_wait_for_prompt — Object
#to_exec — Hub::Args
#to_s — URI::HTTP
#to_s — SimpleCommand
#type_match? — Hub::LocalServer::JsonParamsParser
#unix? — Hub::Context::System
#upstream — Hub::Context::Branch
#uri_parse — Hub::Context::Remote
#urls — Hub::Context::Remote
#userinfo — URI::HTTP
#userinfo= — URI::HTTP
#username — Hub::GitHubAPI::Configuration
#username_via_auth_dance — Hub::GitHubAPI
#value_to_persist — Hub::GitHubAPI::Configuration
#verbose? — Hub::GitHubAPI
#verbose_puts — Hub::GitHubAPI::Verbose
#version — Hub::Commands
#web_url — Hub::Context::GithubProject
#which — Hub::Context::System
#windows? — Hub::Context::System
#with_normalized_url — Hub::Context::Remote
#words — Hub::Args
#yaml_dump — Hub::GitHubAPI::FileStore
#yaml_load — Hub::GitHubAPI::FileStore