https://github.com/marksmurphy/codename-generator

Use `codename-generator` to suggest some random code names for when your imagination lets you down.
https://github.com/marksmurphy/codename-generator

avatar avatar-generator codename generator

Last synced: 4 months ago
JSON representation

Use `codename-generator` to suggest some random code names for when your imagination lets you down.

• Host: GitHub
• URL: https://github.com/marksmurphy/codename-generator
• Owner: markSmurphy
• Created: 2019-11-15T11:46:43.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-06-07T16:44:16.000Z (over 2 years ago)
• Last Synced: 2024-10-15T09:17:45.837Z (4 months ago)
• Topics: avatar, avatar-generator, codename, generator
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/codename-generator
• Size: 77.1 KB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# codename-generator

![Version](https://img.shields.io/npm/v/codename-generator.svg?style=plastic)

![node-current](https://img.shields.io/node/v/codename-generator?style=plastic)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/5f8ab4e09fde4454968b383a2b4f2fbe)](https://www.codacy.com/gh/markSmurphy/codename-generator/dashboard?utm_source=github.com&utm_medium=referral&utm_content=markSmurphy/codename-generator&utm_campaign=Badge_Grade)

![GitHub issues](https://img.shields.io/github/issues/markSmurphy/codename-generator?style=plastic)

[![Known Vulnerabilities](https://snyk.io/test/github/markSmurphy/codename-generator/badge.svg?targetFile=package.json)](https://snyk.io/test/github/markSmurphy/codename-generator?targetFile=package.json)

![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/codename-generator.svg?style=plastic)

![Downloads](https://img.shields.io/npm/dm/codename-generator.svg?style=plastic)

![Licence](https://img.shields.io/npm/l/codename-generator.svg?style=plastic)

## Overview

Have you ever needed to give something a code name?  Perhaps for a project you're working on, or a new screen-name, but your imagination has let you down?

Use `codename-generator` to suggest some random code names.

It has a small dictionary of a few thousand inoffensive adjectives and nouns which are picked at random to generate a suggested code name.

By default a screen-full of suggestions are made, so the larger your screen is, the more suggestions you'll have.

```text

codename-generator

```

![`codename-generator`](https://marksmurphy.github.io/img/codename-generator-screenfull.gif)

---

## Installation

```text

npm -g install codename-generator

```

---

## Change Log

See what's changed recently via the `CHANGELOG.md` which can be found [here](./CHANGELOG.md)

---

## Options

You can use the `--help` option to list all of the options.

### Default (no options)

Don't supply any options and by default you'll get a screen-full of suggested code names (based upon the terminal's row count via the property `node -p process.stdout.rows`).

### 

Or you can specify how many you'd like generated:

```text

codename-generator 20

```

![`codename-generator 20`](https://marksmurphy.github.io/img/codename-generator-20.gif)

### --list-adjectives

Lists all ~1870 adjectives in the dictionary.

### --list-nouns

Lists all ~960 nouns in the dictionary.

### --nsfw

Enables **Not Safe for Work** mode, which supplements the usual inoffensive dictionary with a selection of the ruder everyday english expressions.

### --no-color

Switches off colour output.  Useful if piping output somewhere which doesn't handle the unicode control codes.

### --version

Display the version number.

### --help

Display the help screen.

![`codename-generator --help`](https://marksmurphy.github.io/img/codename-generator-help.png)