ronin-repos 0.1.1 → 0.2.0

data/man/ronin-repos.1

@@ -1,75 +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 "2023-02-01" Ronin Repos "User Manuals"
-.LP
+.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 COMMANDS
-.LP
 .TP
 \fBinstall\fR
 Installs a 3rd\-party git repository\.
-.LP
 .TP
 \fBlist\fR, \fBls\fR
 Lists installed git repositories\.
-.LP
 .TP
 \fBnew\fR
 Generates a new git repository\.
-.LP
 .TP
 \fBpurge\fR
 Deletes all installed git repositories\.
-.LP
 .TP
 \fBremove\fR, \fBrm\fR
 Removes a previously installed git repository\.
-.LP
 .TP
 \fBupdate\fR, \fBup\fR
 Updates a previously installed git repository\.
-.LP
 .SH ENVIRONMENT
-.LP
 .TP
 \fIHOME\fP
 Specifies the home directory of the user\. Ronin will search for the
-\fB~/.cache/ronin-repos\fR cache directory within the home directory\.
-.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$HOME/.cache\fR\.
-.LP
+Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
 .SH FILES
-.LP
 .TP
-\fB~/.cache/ronin-repos\fR
+\fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR
 Installation directory for repositories\.
-.LP
 .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,5 +1,9 @@
 # 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*]
@@ -12,41 +16,41 @@ and use any git repository containing Ruby code or other data.
 ## OPTIONS
 
 `-h`, `--help`
-  Prints help information.
+: Prints help information.
 
 ## COMMANDS
 
 `install`
-  Installs a 3rd-party git repository.
+: Installs a 3rd-party git repository.
 
 `list`, `ls`
-  Lists installed git repositories.
+: Lists installed git repositories.
 
 `new`
-  Generates a new git repository.
+: Generates a new git repository.
 
 `purge`
-  Deletes all installed git repositories.
+: Deletes all installed git repositories.
 
 `remove`, `rm`
-  Removes a previously installed git repository.
+: Removes a previously installed git repository.
 
 `update`, `up`
-  Updates a previously installed git repository.
+: 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.
+: 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`.
+: Specifies the cache directory to use. Defaults to `$HOME/.cache`.
 
 ## FILES
 
 `~/.cache/ronin-repos`
-	Installation directory for repositories.
+: Installation directory for repositories.
 
 ## AUTHOR
 
@@ -54,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/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.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
+date: 2024-07-22 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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !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
@@ -62,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
@@ -69,16 +72,20 @@ 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
@@ -89,11 +96,14 @@ files:
 - 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
@@ -118,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.5.11
 signing_key:
 specification_version: 4
 summary: Third-party git repository support for ronin.