add-remote-1.0.0 is not a library.

add-remote

An interactive CLI tool to add a remote fork to a local Git repository. When run from a Git repo, it queries GitHub for the full list of forks and offers simple choices for adding one under a local alias. The added fork will be configured with a pull-url only; the push-url will be disabled.

Install

cargo install add-remote

Run

Simply cd to a Git repository and run add-remote.

Configure

add-remote will display all forks which aren't currently copied locally, then ask you to choose one and to provide an alias for it.

It will offer a default selection (i.e. just hit to select it) if it can. The default will be chosen as follows:

if there's only one fork available, it will be selected, or else
the main fork/source owner if not already added locally, or else
the fork indicated by the Git config value of add-remote.preferredFork if set, and if that fork is not already added locally

You can set add-remote.preferredFork (e.g. to maidsafe) by running:

git config --global --add add-remote.preferredFork maidsafe

Having chosen the fork to add, you will then be asked to provide an alias for it. Again, a default value will be presented, chosen as follows:

if this is the main fork/source owner, uses the Git config value of add-remote.mainForkOwnerAlias if set, or else uses "upstream"
uses the Git config value from the map of aliases under the subkey add-remote.'Fork Alias' if set
uses the fork-owner's name

You can set add-remote.mainForkOwnerAlias (e.g. to owner) by running:

git config --global --add add-remote.mainForkOwnerAlias owner

Default aliases can be added to your .gitconfig file under the subkey add-remote.'Fork Alias'.<owner's name> by running e.g:

git config --global --add add-remote.'Fork Alias'.dirvine David
git config --global --add add-remote.'Fork Alias'.Viv-Rajkumar Viv

Having run these Git config commands, your .gitconfig should contain the following:

[add-remote]
    preferredFork = maidsafe
    mainForkOwnerAlias = owner
[add-remote "Fork Alias"]
    dirvine = David
    Viv-Rajkumar = Viv

Note

add-remote only works with projects hosted on GitHub currently since GitLab's API doesn't support querying for a list of project forks.

License

Licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.