Skip to content

Commit 2683ec5

Browse files
committed
Add Gemfile.local.example
1 parent 594923c commit 2683ec5

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

Gemfile.local.example

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
##
2+
# Example Gemfile.local file for Metasploit Framework
3+
#
4+
# The Gemfile.local file provides a way to use other gems that are not
5+
# included in the standard Gemfile provided with Metasploit.
6+
# This filename is included in Metasploit's .gitignore file, so local changes
7+
# to this file will not accidentally show up in future pull requests. This
8+
# example Gemfile.local includes all gems in Gemfile using instance_eval.
9+
# It also creates a new bundle group, 'local', to hold additional gems.
10+
#
11+
# This file will not be used by default within the framework. As such, one
12+
# must first install the custom Gemfile.local with bundle:
13+
# bundle install --gemfile Gemfile.local
14+
#
15+
# Note that msfupdate does not consider Gemfile.local when updating the
16+
# framework. If it is used, it may be necessary to run the above bundle
17+
# command after the update.
18+
#
19+
###
20+
21+
# Include the Gemfile included with the framework. This is very
22+
# important for picking up new gem dependencies.
23+
msf_gemfile = File.join(File.dirname(__FILE__), 'Gemfile')
24+
if File.readable?(msf_gemfile)
25+
instance_eval(File.read(msf_gemfile))
26+
end
27+
28+
# Create a custom group
29+
group :local do
30+
# Use pry to help view and interact with objects in the framework
31+
gem 'pry', '~> 0.9'
32+
# Use pry-debugger to step through code during development
33+
gem 'pry-debugger', '~> 0.2'
34+
# Add the lab gem so that the 'lab' plugin will work again
35+
gem 'lab', '~> 0.2.7'
36+
end

0 commit comments

Comments
 (0)