ronin-rb/ronin-repos

View on GitHub
man/ronin-repos-install.1.md

Summary

Maintainability
Test Coverage
# ronin-repos-install 1 "2023-02-01" Ronin Repos "User Manuals"

## NAME

ronin-repos-install - Installs a git repository into the cache directory

## SYNOPSIS

`ronin-repos install` [*options*] *URI*

## DESCRIPTION

Downloads a repository.

## ARGUMENTS

*URI*
: The URI to the git repository.

## OPTIONS

`-C`, `--cache-dir` *DIR*
: Overrides the default cache directory.

`-h`, `--help`
: Prints help information.

## ENVIRONMENT

*HOME*
: Specifies the home directory of the user. Ronin will search for the
  `~/.cache/ronin-repos` cache directory within the home directory.

*XDG_CACHE_HOME*
: Specifies the cache directory to use. Defaults to `$HOME/.cache`.

## FILES

`~/.cache/ronin-repos/`
: Installation directory for all repositories.

## EXAMPLES

`ronin-repos install https://github.com/user/repo.git`
: Installs a public repository over HTTPS.

`ronin-repos install git@example.com:/home/secret/repo`
: Installs a private repository over SSH.

## AUTHOR

Postmodern <postmodern.mod3@gmail.com>

## SEE ALSO

[ronin-repos](ronin-repos.1.md) [ronin-repos-list](ronin-repos-list.1.md) [ronin-repos-remove](ronin-repos-remove.1.md) [ronin-repos-update](ronin-repos-update.1.md) [ronin-repos-purge](ronin-repos-purge.1.md)