ronin-rb/ronin-repos

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

Summary

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

## NAME

ronin-repos - manages third-party git repository for ronin.

## SYNOPSIS

`ronin-repos` [*options*] [*COMMAND*]

## DESCRIPTION

Allows downloading and managing git repositories. `ronin-repos` can install
and use any git repository containing Ruby code or other data.

## OPTIONS

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

## COMMANDS

`install`
: Installs a 3rd-party git repository.

`list`, `ls`
: Lists installed git repositories.

`new`
: Generates a new git repository.

`purge`
: Deletes all installed git repositories.

`remove`, `rm`
: Removes a previously installed git repository.

`update`, `up`
: Updates a previously installed git repository.

## 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 repositories.

## AUTHOR

Postmodern <postmodern.mod3@gmail.com>

## SEE ALSO

[ronin-repos-completion](ronin-repos-completion.1.md) [ronin-repos-install](ronin-repos-install.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)