Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Generate consistent-codenames from any string (Heroku style, aka Haiku).

License

Notifications You must be signed in to change notification settings

DannyBen/concode

Repository files navigation

Concode

repocard

Generate consistent-codenames from any string (Heroku style, aka Haiku).

This is a Ruby port of Python's codenamize.


Installation

$ gem install concode

Feature Highlights

  • Use as a Ruby library or from the command line
  • Generate heroku-style / docker-style consistent codenames from any string (e.g. IP address, git commit hash)
  • Control the number of words, and number of letters in each word
  • Compatibility with Python's codenamize (both libraries will generate the same codes given the same string)
  • Limitless combinations (over 1.7 million for 2 words, and 1.8 billion for 3 words)

Command Line Usage

$ concode --help
Usage:
 concode <string> [options]
 concode --random [options]
 concode --count [options]
 concode (-h|--help|-v|--version)
Options:
 -w, --words N Number of words to generate
 -c, --chars N Max characters per word
 -g, --glue CHAR Word separator
 -C, --caps Capitalize words
 -n, --count Count possible combinations
 -r, --random Generate a random code
 -h, --help Show this message
 -v, --version Show version

Examples

$ concode hello
plausible-term
$ concode hello --words 3
ancient-plausible-term
$ concode hello --words 3 --chars 3 --caps --glue ' '
Cut Red Bar
$ concode --random -w4
cruel-aggressive-cute-world

Library Usage

require 'concode'
# basic use:
generator = Concode::Generator.new
puts generator.generate 'something annoying'
# => annoyed-poem
# or, with all the options:
generator = Concode::Generator.new words: 3, chars: 4, capitalize: true, glue: ' '
puts generator.generate 'something annoying'
# => Wise Rude Boot
# get the available combinations with:
puts generator.word_count
# => 7402200

Credits

Thanks to Jose Juan Montes (@jjmontesl) for developing and documenting codenamize.

About

Generate consistent-codenames from any string (Heroku style, aka Haiku).

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

AltStyle によって変換されたページ (->オリジナル) /