ronin-repos 0.1.0 → 0.2.0.rc1

data/man/ronin-repos-remove.1.md

@@ -1,4 +1,8 @@
-# ronin-repos-remove 1 "2022-01-01" Ronin Repos "User Manuals"
+# ronin-repos-remove 1 "2023-02-01" Ronin Repos "User Manuals"
+
+## NAME
+
+ronin-repos-remove - Deletes a repository from the cache directory
 
 ## SYNOPSIS
 
@@ -11,31 +15,31 @@ Removes a repository.
 ## ARGUMENTS
 
 *REPO*
-	The name of the repository to remove.
+: The name of the repository to remove.
 
 ## OPTIONS
 
 `-h`, `--help`
-  Prints help information.
+: Prints help information.
 
 ## EXAMPLES
 
 `ronin-repo remove repo`
-	Removes the repository with with the name `repo`.
+: Removes the repository with with the name `repo`.
 
-## FILES
+## ENVIRONMENT
 
-*~/.cache/ronin-repos/*
-	Installation directory for all repositories.
+*HOME*
+: Specifies the home directory of the user. Ronin will search for the
+  `~/.cache/ronin-repos` cache directory within the home directory.
 
-## ENVIRONMENT
+*XDG_CACHE_HOME*
+: Specifies the cache directory to use. Defaults to `$HOME/.cache`.
 
-HOME
-	Specifies the home directory of the user. Ronin will search for the
-	*~/.cache/ronin-repos* cache directory within the home directory.
+## FILES
 
-XDG_CACHE_HOME
-  Specifies the cache directory to use. Defaults to *$HOME/.cache*.
+`~/.cache/ronin-repos/`
+: Installation directory for all repositories.
 
 ## AUTHOR
 
@@ -43,4 +47,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-repos(1), ronin-repos-install(1) ronin-repos-list(1) ronin-repos-update(1) ronin-repos-purge(1)
+[ronin-repos](ronin-repos.1.md) [ronin-repos-install](ronin-repos-install.1.md) [ronin-repos-list](ronin-repos-list.1.md) [ronin-repos-update](ronin-repos-update.1.md) [ronin-repos-purge](ronin-repos-purge.1.md)

data/man/ronin-repos-show.1

@@ -0,0 +1,48 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-repos-show 1 "2023-02-01" Ronin Repos "User Manuals"
+.SH NAME
+.PP
+ronin\-repos\-show \- Prints information about a repository in the cache directory
+.SH SYNOPSIS
+.PP
+\fBronin\-repos show\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP
+.SH DESCRIPTION
+.PP
+Prints information about a specific repository in the cache directory\.
+.SH ARGUMENTS
+.TP
+\fINAME\fP
+The repository name to print information about\.
+.SH OPTIONS
+.TP
+\fB\-C\fR, \fB\-\-cache\-dir\fR \fIDIR\fP
+Overrides the default cache directory\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Prints help information\.
+.SH ENVIRONMENT
+.TP
+\fIHOME\fP
+Specifies the home directory of the user\. Ronin will search for the
+\fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR cache directory within the home directory\.
+.TP
+\fIXDG\[ru]CACHE\[ru]HOME\fP
+Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
+.SH FILES
+.TP
+\fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR
+Installation directory for repositories\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.SH SEE ALSO
+.PP
+.BR ronin\-repos (1)
+.BR ronin\-repos\-list (1)
+.BR ronin\-repos\-install (1)
+.BR ronin\-repos\-remove (1)
+.BR ronin\-repos\-update (1)
+.BR ronin\-repos\-purge (1)

data/man/ronin-repos-show.1.md

@@ -0,0 +1,48 @@
+# ronin-repos-show 1 "2023-02-01" Ronin Repos "User Manuals"
+
+## NAME
+
+ronin-repos-show - Prints information about a repository in the cache directory
+
+## SYNOPSIS
+
+`ronin-repos show` [*options*] *NAME*
+
+## DESCRIPTION
+
+Prints information about a specific repository in the cache directory.
+
+## ARGUMENTS
+
+*NAME*
+: The repository name to print information about.
+
+## 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 repositories.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-repos](ronin-repos.1.md) [ronin-repos-list](ronin-repos-list.1.md) [ronin-repos-install](ronin-repos-install.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)

data/man/ronin-repos-update.1

@@ -1,64 +1,54 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-repos-update 1 "2022-01-01" Ronin Repos "User Manuals"
-.LP
+.TH ronin-repos-update 1 "2023-02-01" Ronin Repos "User Manuals"
+.SH NAME
+.PP
+ronin\-repos\-update \- Updates all or one repository from the cache directory
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin-repos update\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIREPO\fP\[rB]
-.LP
+.PP
+\fBronin\-repos update\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIREPO\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
 Updates all repositories or just one\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIREPO\fP
 The optional repository name to only update\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-C\fR, \fB\-\-cache\-dir\fR \fIDIR\fP
+Overrides the default cache directory\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
 Prints help information\.
-.LP
 .SH EXAMPLES
-.LP
 .TP
-\fBronin-repos update\fR
+\fBronin\-repos update\fR
 Updates all installed repositories\.
-.LP
 .TP
 \fBronin update repo\fR
 Updates the specific repository named \fBrepo\fR\.
-.LP
+.SH ENVIRONMENT
+.TP
+\fIHOME\fP
+Specifies the home directory of the user\. Ronin will search for the
+\fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR cache directory within the home directory\.
+.TP
+\fIXDG\[ru]CACHE\[ru]HOME\fP
+Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
 .SH FILES
-.LP
 .TP
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
+\fB\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fR
 Installation directory for all repositories\.
-.LP
-.SH ENVIRONMENT
-.LP
-.PP
-HOME
-Specifies the home directory of the user\. Ronin will search for the
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
-.LP
-.PP
-XDG\[ru]CACHE\[ru]HOME
-Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-repos(1) ronin\-repos\-repos\-install(1) ronin\-repos\-list(1) ronin\-repos\-remove(1) ronin\-repos\-purge(1)
+.BR ronin\-repos (1)
+.BR ronin\-repos\-repos\-install (1)
+.BR ronin\-repos\-list (1)
+.BR ronin\-repos\-remove (1)
+.BR ronin\-repos\-purge (1)

data/man/ronin-repos-update.1.md

@@ -1,4 +1,8 @@
-# ronin-repos-update 1 "2022-01-01" Ronin Repos "User Manuals"
+# ronin-repos-update 1 "2023-02-01" Ronin Repos "User Manuals"
+
+## NAME
+
+ronin-repos-update - Updates all or one repository from the cache directory
 
 ## SYNOPSIS
 
@@ -11,34 +15,37 @@ Updates all repositories or just one.
 ## ARGUMENTS
 
 *REPO*
-	The optional repository name to only update.
+: The optional repository name to only update.
 
 ## OPTIONS
 
+`-C`, `--cache-dir` *DIR*
+: Overrides the default cache directory.
+
 `-h`, `--help`
-  Prints help information.
+: Prints help information.
 
 ## EXAMPLES
 
 `ronin-repos update`
-  Updates all installed repositories.
+: Updates all installed repositories.
 
 `ronin update repo`
-	Updates the specific repository named `repo`.
+: Updates the specific repository named `repo`.
 
-## FILES
+## ENVIRONMENT
 
-*~/.cache/ronin-repos/*
-	Installation directory for all repositories.
+*HOME*
+: Specifies the home directory of the user. Ronin will search for the
+  `~/.cache/ronin-repos` cache directory within the home directory.
 
-## ENVIRONMENT
+*XDG_CACHE_HOME*
+: Specifies the cache directory to use. Defaults to `$HOME/.cache`.
 
-HOME
-	Specifies the home directory of the user. Ronin will search for the
-	*~/.cache/ronin-repos* cache directory within the home directory.
+## FILES
 
-XDG_CACHE_HOME
-  Specifies the cache directory to use. Defaults to *$HOME/.cache*.
+`~/.cache/ronin-repos/`
+: Installation directory for all repositories.
 
 ## AUTHOR
 
@@ -46,4 +53,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-repos(1) ronin-repos-repos-install(1) ronin-repos-list(1) ronin-repos-remove(1) ronin-repos-purge(1)
+[ronin-repos](ronin-repos.1.md) [ronin-repos-repos-install](ronin-repos-repos-install.1.md) [ronin-repos-list](ronin-repos-list.1.md) [ronin-repos-remove](ronin-repos-remove.1.md) [ronin-repos-purge](ronin-repos-purge.1.md)

data/man/ronin-repos.1

@@ -1,49 +1,61 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-repos 1 "2022-01-01" Ronin Repos "User Manuals"
-.LP
+.TH ronin-repos 1 "2023-02-01" Ronin Repos "User Manuals"
+.SH NAME
+.PP
+ronin\-repos \- manages third\-party git repository for ronin\.
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin-repos\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP\[rB]
-.LP
+.PP
+\fBronin\-repos\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
-Allows downloading and managing git repositories\. \fBronin-repos\fR can install
+Allows downloading and managing git repositories\. \fBronin\-repos\fR can install
 and use any git repository containing Ruby code or other data\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Prints help information\.
-.LP
-.SH FILES
-.LP
+.SH COMMANDS
 .TP
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP
-Installation directory for repositories\.
-.LP
+\fBinstall\fR
+Installs a 3rd\-party git repository\.
+.TP
+\fBlist\fR, \fBls\fR
+Lists installed git repositories\.
+.TP
+\fBnew\fR
+Generates a new git repository\.
+.TP
+\fBpurge\fR
+Deletes all installed git repositories\.
+.TP
+\fBremove\fR, \fBrm\fR
+Removes a previously installed git repository\.
+.TP
+\fBupdate\fR, \fBup\fR
+Updates a previously installed git repository\.
 .SH ENVIRONMENT
-.LP
-.PP
-HOME
+.TP
+\fIHOME\fP
 Specifies the home directory of the user\. Ronin will search for the
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
-.LP
-.PP
-XDG\[ru]CACHE\[ru]HOME
-Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
-.LP
+\fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR cache directory within the home directory\.
+.TP
+\fIXDG\[ru]CACHE\[ru]HOME\fP
+Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
+.SH FILES
+.TP
+\fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR
+Installation directory for repositories\.
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-repos\-install(1) ronin\-repos\-list(1) ronin\-repos\-remove(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)
+.BR ronin\-repos\-completion (1)
+.BR ronin\-repos\-install (1)
+.BR ronin\-repos\-list (1)
+.BR ronin\-repos\-remove (1)
+.BR ronin\-repos\-update (1)
+.BR ronin\-repos\-purge (1)

data/man/ronin-repos.1.md

@@ -1,4 +1,8 @@
-# ronin-repos 1 "2022-01-01" Ronin Repos "User Manuals"
+# ronin-repos 1 "2023-02-01" Ronin Repos "User Manuals"
+
+## NAME
+
+ronin-repos - manages third-party git repository for ronin.
 
 ## SYNOPSIS
 
@@ -12,21 +16,41 @@ and use any git repository containing Ruby code or other data.
 ## OPTIONS
 
 `-h`, `--help`
-  Prints help information.
+: Prints help information.
 
-## FILES
+## COMMANDS
+
+`install`
+: Installs a 3rd-party git repository.
+
+`list`, `ls`
+: Lists installed git repositories.
+
+`new`
+: Generates a new git repository.
 
-*~/.cache/ronin-repos*
-	Installation directory for repositories.
+`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.
+*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
 
-XDG_CACHE_HOME
-  Specifies the cache directory to use. Defaults to *$HOME/.cache*.
+`~/.cache/ronin-repos`
+: Installation directory for repositories.
 
 ## AUTHOR
 
@@ -34,4 +58,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-repos-install(1) ronin-repos-list(1) ronin-repos-remove(1) ronin-repos-update(1) ronin-repos-purge(1)
+[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)

data/ronin-repos.gemspec

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'yaml'
 
@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
   gem.homepage    = gemspec['homepage']
   gem.metadata    = gemspec['metadata'] if gemspec['metadata']
 
-  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+  glob = ->(patterns) { gem.files & Dir[*patterns] }
 
   gem.files  = `git ls-files`.split($/)
   gem.files  = glob[gemspec['files']] if gemspec['files']
@@ -33,6 +33,7 @@ Gem::Specification.new do |gem|
   gem.executables = gemspec.fetch('executables') do
     glob['bin/*'].map { |path| File.basename(path) }
   end
+
   gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
 
   gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
@@ -47,7 +48,7 @@ Gem::Specification.new do |gem|
   gem.required_rubygems_version = gemspec['required_rubygems_version']
   gem.post_install_message      = gemspec['post_install_message']
 
-  split = lambda { |string| string.split(/,\s*/) }
+  split = ->(string) { string.split(/,\s*/) }
 
   if gemspec['dependencies']
     gemspec['dependencies'].each do |name,versions|

data/scripts/setup

@@ -0,0 +1,58 @@
+#!/usr/bin/env bash
+
+#
+# Prints a log message.
+#
+function log()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[32m>>>\x1b[0m \x1b[1m$1\x1b[0m"
+	else
+		echo ">>> $1"
+	fi
+}
+
+#
+# Prints a warn message.
+#
+function warn()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[33m***\x1b[0m \x1b[1m$1\x1b[0m" >&2
+	else
+		echo "*** $1" >&2
+	fi
+}
+
+#
+# Prints an error message.
+#
+function error()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[31m!!!\x1b[0m \x1b[1m$1\x1b[0m" >&2
+	else
+		echo "!!! $1" >&2
+	fi
+}
+
+#
+# Prints an error message and exists with -1.
+#
+function fail()
+{
+	error "$@"
+	exit -1
+}
+
+# default to installing gems into vendor/bundle
+if [[ ! -f .bundle/config ]]; then
+	bundle config set --local path vendor/bundle >/dev/null || \
+	  fail "Failed to run 'bundle config'"
+fi
+
+log "Installing gems ..."
+bundle install || fail "Failed to run 'bundle install'!"
+
+log "Setting up the project ..."
+bundle exec rake setup || "Failed to run 'rake setup'!"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-repos
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0.rc1
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-01 00:00:00.000000000 Z
+date: 2024-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ronin-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.0.rc1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,8 +38,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: ronin-repos provides a repository system for installing, managing, and
-  accessing third-party git repositories, which can contain code or other data.
+description: |-
+  ronin-repos provides a repository system for installing, managing, and accessing third-party git repositories, that can contain additional Ruby code or other data. Other Ronin libraries, such as ronin-exploits or ronin-payloads, can then list and load additional third-party Ruby classes from specific directories within the installed third-party reposs.
+  ronin-repos is essentially a decentralized plugin system for Ronin using git repos.
 email: postmodern.mod3@gmail.com
 executables:
 - ronin-repos
@@ -53,6 +54,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".yardopts"
 - COPYING.txt
@@ -61,6 +63,8 @@ files:
 - README.md
 - Rakefile
 - bin/ronin-repos
+- data/completions/ronin-repos
+- data/completions/ronin-repos.yml
 - data/templates/repo/README.md.erb
 - gemspec.yml
 - lib/ronin/repos.rb
@@ -68,30 +72,38 @@ files:
 - lib/ronin/repos/class_dir.rb
 - lib/ronin/repos/cli.rb
 - lib/ronin/repos/cli/command.rb
+- lib/ronin/repos/cli/commands/completion.rb
 - lib/ronin/repos/cli/commands/install.rb
 - lib/ronin/repos/cli/commands/list.rb
 - lib/ronin/repos/cli/commands/new.rb
 - lib/ronin/repos/cli/commands/purge.rb
 - lib/ronin/repos/cli/commands/remove.rb
+- lib/ronin/repos/cli/commands/show.rb
 - lib/ronin/repos/cli/commands/update.rb
 - lib/ronin/repos/exceptions.rb
 - lib/ronin/repos/repository.rb
 - lib/ronin/repos/root.rb
 - lib/ronin/repos/version.rb
+- man/ronin-repos-completion.1
+- man/ronin-repos-completion.1.md
 - man/ronin-repos-install.1
 - man/ronin-repos-install.1.md
 - man/ronin-repos-list.1
 - man/ronin-repos-list.1.md
 - man/ronin-repos-new.1
+- man/ronin-repos-new.1.md
 - man/ronin-repos-purge.1
 - man/ronin-repos-purge.1.md
 - man/ronin-repos-remove.1
 - man/ronin-repos-remove.1.md
+- man/ronin-repos-show.1
+- man/ronin-repos-show.1.md
 - man/ronin-repos-update.1
 - man/ronin-repos-update.1.md
 - man/ronin-repos.1
 - man/ronin-repos.1.md
 - ronin-repos.gemspec
+- scripts/setup
 homepage: https://ronin-rb.dev
 licenses:
 - LGPL-3.0
@@ -116,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Third-party git repository support for ronin.