https://github.com/ronin-rb/ronin-wordlists
A library and tool for managing wordlists.
https://github.com/ronin-rb/ronin-wordlists
cli-util hacktoberfest infosec ruby wordlist-download wordlist-mangler wordlists
Last synced: 3 months ago
JSON representation
A library and tool for managing wordlists.
- Host: GitHub
- URL: https://github.com/ronin-rb/ronin-wordlists
- Owner: ronin-rb
- License: lgpl-3.0
- Created: 2023-04-29T10:45:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-02T22:44:16.000Z (8 months ago)
- Last Synced: 2025-06-07T21:16:17.762Z (4 months ago)
- Topics: cli-util, hacktoberfest, infosec, ruby, wordlist-download, wordlist-mangler, wordlists
- Language: Ruby
- Homepage: https://ronin-rb.dev
- Size: 107 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: COPYING.txt
Awesome Lists containing this project
README
# ronin-wordlists
[](https://github.com/ronin-rb/ronin-wordlists/actions/workflows/ruby.yml)
[](https://codeclimate.com/github/ronin-rb/ronin-wordlists)
* [Website](https://ronin-rb.dev/)
* [Source](https://github.com/ronin-rb/ronin-wordlists)
* [Issues](https://github.com/ronin-rb/ronin-wordlists/issues)
* [Documentation](https://ronin-rb.dev/docs/ronin-wordlists/frames)
* [Discord](https://discord.gg/6WAb3PsVX9) |
[Mastodon](https://infosec.exchange/@ronin_rb)
## Description
ronin-wordlists is a library and tool for managing wordlists. ronin-wordlists
can install and update wordlists, and contains a curated list of popular
wordlists and their download URLs.
## Features
* Installs, updates, and manages wordlist files and Git repositories.
* Contains a curated list of popular wordlists and their download URLs.
* Allows looking wordlists up by name, instead of explicit path.
* Supports searching for wordlists in
`/usr/share/wordlists` (Kali Linux and BlackArch Linux),
`/usr/local/wordlists`, and
`~/.cache/ronin-wordlists/wordlists` directories.
## Synopsis
```
$ ronin-wordlists
Usage: ronin-wordlists [options]
Options:
-V, --version Prints the version and exits
-h, --help Print help information
Arguments:
[COMMAND] The command name to run
[ARGS ...] Additional arguments for the command
Commands:
completion
download, install
help
list, ls
purge
remove, rm
search
update, up
```
List popular wordlists available for download or installation:
```shell
$ ronin-wordlists search
[ alexa-top-1000 ]
* URL: https://github.com/urbanadventurer/WhatWeb/blob/master/plugin-development/alexa-top-1000.txt
* Categories: dns, domains
* Summary: The Alexa Top 1000 domain names.
[ subdomains ]
* URL: https://raw.githubusercontent.com/rbsec/dnscan/master/subdomains.txt
* Categories: dns, subdomains
* Summary: List of common subdomain names used by the dnscan util.
...
```
Download a known wordlist:
```shell
ronin-wordlists download rockyou
```
Download a wordlist from a URL:
```shell
ronin-wordlists download https://example.com/path/to/wordlist.gz
```
Update all downloaded wordlists:
```shell
ronin-wordlists update
```
Update a specific wordlist:
```shell
ronin-wordlists update SecLists
```
## Examples
Open a wordlist by name:
```ruby
require 'ronin/wordlists'
wordlist = Ronin::Wordlists.open('alexa-top-1000')
# =>
# #
wordlist.each do |word|
# ...
end
```
Download a custom wordlist into `~/.cache/ronin-wordlists/wordlists`:
```ruby
Ronin::Wordlists.download('https://...')
```
List installed wordlists:
```ruby
Ronin::Wordlists.list
# => #
```
## Requirements
* [Ruby] >= 3.0.0
* [wordlist] ~> 1.1
* [ronin-core] ~> 0.2
## Install
```shell
gem install ronin-wordlists
```
### Gemfile
```ruby
gem 'ronin-wordlists', '~> 0.1'
```
### gemspec
```ruby
gem.add_dependency 'ronin-wordlists', '~> 0.1'
```
## Development
1. [Fork It!](https://github.com/ronin-rb/ronin-wordlists/fork)
2. Clone It!
3. `cd ronin-wordlists/`
4. `./scripts/setup`
5. `git checkout -b my_feature`
6. Code It!
7. `bundle exec rake spec`
8. `git push origin my_feature`
## License
Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
ronin-wordlists is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
ronin-wordlists is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with ronin-wordlists. If not, see .
[Ruby]: https://www.ruby-lang.org
[wordlist]: https://github.com/postmodern/wordlist.rb#readme
[ronin-core]: https://github.com/ronin-rb/ronin-core#readme