{"id":16481881,"url":"https://github.com/angularsen/yawg","last_synced_at":"2025-10-27T17:31:48.573Z","repository":{"id":41083080,"uuid":"58834372","full_name":"angularsen/yawg","owner":"angularsen","description":"Yet Another Word Generator - Node CLI to generate XKCD inspired passwords, using common English words that are easy to spell.","archived":false,"fork":false,"pushed_at":"2018-04-22T12:46:43.000Z","size":115,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T07:22:53.009Z","etag":null,"topics":["cli","generator","horse","javascript","nodejs","passphrase","password","staple","xkcd"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/angularsen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-05-14T23:07:32.000Z","updated_at":"2024-09-05T11:50:39.000Z","dependencies_parsed_at":"2022-08-31T01:13:57.543Z","dependency_job_id":null,"html_url":"https://github.com/angularsen/yawg","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angularsen%2Fyawg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angularsen%2Fyawg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angularsen%2Fyawg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angularsen%2Fyawg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/angularsen","download_url":"https://codeload.github.com/angularsen/yawg/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238535811,"owners_count":19488596,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","generator","horse","javascript","nodejs","passphrase","password","staple","xkcd"],"created_at":"2024-10-11T13:08:56.601Z","updated_at":"2025-10-27T17:31:48.257Z","avatar_url":"https://github.com/angularsen.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# YAWG - Yet Another Word Generator\nNode CLI to generate XKCD inspired passwords, using common English words that are easy to spell and type in manually.\n\nhttps://www.npmjs.com/package/yawg\n\n### Install\nInstall `yawg` globally with [NPM package manager](https://docs.npmjs.com/cli/npm) included with [NodeJS](https://nodejs.org/en/):\n```\n$ npm install -g yawg        \n```\n\nAlternatively with [Yarn package manager](https://yarnpkg.com/):\n```\n$ yarn global add yawg\n```\n\nThen run it:\n\n```\n$ yawg\ncheese packet wish\n```\n\n### Parameters\n```\n$ yawg -h\nyawg - Yet Another Word Generator\n\nversion: 1.2.3\n\nRequired parameters: (none)\n\nOptional parameters:\n--delimiter=' '     Delimiter between words\n--minLength=12      Min length of phrase\n--maxLength=25      Max length of phrase\n--minWords=3        Min number of words\n--maxWords=5        Max number of words\n--minWordLength=1   Min word length\n--maxWordLength=8   Max word length\n--attempts=10000    Max attempts per phrase\n--count=1           Number of phrases to generate\n    alias: -n\n--help              Show this screen\n    alias: -h\n```\n\n### Examples\n#### Copy phrase to clipboard\n`$ yawg | clip`\n\n#### Multiple phrases\n```\n$ yawg -n 10\ndans mainly fly tray luke\nyen craft marco ill jobs\nran situated bouquet\ntoys que wrist achieve\nbless worry filme craft\njustin shame toronto\ntrader reset dui gen lead\nstr disks antigua nest\nmarvel enables moms\ntrusted cleared unit\n```\n\n#### Short words only\n```\n$ yawg -n3 --maxWordLength=4\nfork my core\nmat fair hong\nbras arm foul\n```\n\n#### Long phrases\n```\n$ yawg -n3 --minLength=25 --maxLength=50\noffices language myrtle altered\nrecipes emission involves audience brighton\ndetailed exhibit industry\n```\n\n### Node API\nYou can require this package in your NodeJS code and pass in the options as an object argument.\n\nExample:\n```js\n'use strict';\n\nvar yawg = require('yawg');\n\ntry {\n    var phrase = yawg({\n        minWords: 4,\n        maxLength: 50,\n        attempts: 100,\n    });\n    console.log('Phrase is: ' + phrase);\n} catch (err) {\n    // Not able to produce a phrase that mathed the constraints of the parameters.\n    // Example: --maxLength=10 --minWords=5 --minWordLength=3  # Can only generate phrase of minimum length 5*13=15\n}\n```\n\n### Troubleshooting\n1. Sometimes Yarn on Windows does not properly configure the PATH environment variable. [Make sure PATH is properly set up](https://github.com/yarnpkg/yarn/issues/1648).\n    * Find the global yarn bin path: `$ yarn global bin   # Ex: C:\\Users\\Andreas\\AppData\\Local\\Yarn\\bin`\n    * Append path to PATH env variable\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangularsen%2Fyawg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fangularsen%2Fyawg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangularsen%2Fyawg/lists"}