WORDCLOUD_CLI(1)

💖 WORDCLOUD_CLI — bestie edition 💖

okay so. <rainbow>wordcloud_cli</rainbow> — it's a little word cloud generator in Python. that's it, that's the whole vibe. it makes pretty clouds out of words. and honestly? iconic. ✨

🌸 NAME 🌸

wordcloud_cli — a little word cloud generator in Python 🫶

🦋 DESCRIPTION 🦋

here's how you call it, bestie. look at the shape of it first, then we'll go one by one:

wordcloud_cli [-h] [--text file] [--regexp regexp] [--stopwords file]
              [--imagefile file] [--fontfile path] [--mask file]
              [--colormask file] [--contour_width width] [--contour_color color]
              [--relative_scaling rs] [--margin width] [--width width]
              [--height height] [--color color] [--background color]
              [--no_collocations] [--include_numbers]
              [--min_word_length min_word_length] [--prefer_horizontal ratio]
              [--scale scale] [--colormap map] [--mode mode] [--max_words N]
              [--min_font_size size] [--max_font_size size] [--font_step step]
              [--random_state seed] [--no_normalize_plurals] [--repeat]
              [--version]

it's a simple command line interface for the wordcloud module. no cap. that's the whole thing. 💅

✨ optional arguments ✨

one bullet per flag, no skips, no gatekeeping. we're listing every single one:

• -h, --help — shows this help message and then dips. bye! 👋
• --text file — name the file of words you wanna build the word cloud out of (default: stdin, so if you don't say anything it just reads what you pipe in 🫶)
• --regexp regexp — overrides the regular expression that decides what counts as a word. you're the boss of "what is a word" now 👑
• --stopwords file — name a file of stopwords (one word per line, fr) and those get removed from the given text after parsing. get that "the" and "and" OUT 💀
• --imagefile file — the file your finished PNG image gets written to (default: stdout) 🎀
• --fontfile path — path to the font file you wanna use (default: DroidSansMono) — pick your font, make it cute 🦋
• --mask file — the mask to use for the image form. it shapes your cloud, main character energy 🌈
• --colormask file — the color mask to use for image coloring 🎨
• --contour_width width — if this is greater than 0, it draws the mask contour (default: 0) ✏️
• --contour_color color — uses the given color as the mask contour color — it accepts any value from PIL.ImageColor.getcolor 💜
• --relative_scaling rs — scaling of words by frequency, in the range 0 - 1 📈
• --margin width — the spacing to leave around words. personal space matters 🫧
• --width width — defines the output image width 📏
• --height height — defines the output image height 📐
• --color color — uses the given color as the coloring for the image — accepts any value from PIL.ImageColor.getcolor 🌸
• --background color — uses the given color as the background color for the image — accepts any value from PIL.ImageColor.getcolor 🖼️
• --no_collocations — does NOT add collocations (bigrams) to the word cloud (default behaviour: add both unigrams and bigrams) 🚫
• --include_numbers — include numbers in the wordcloud? yes? no? you decide 🔢
• --min_word_length min_word_length — only include words with more than X letters. short words, you're out 🙈
• --prefer_horizontal ratio — the ratio of times to try horizontal fitting as opposed to vertical ↔️
• --scale scale — scaling between computation and drawing 🔍
• --colormap map — a matplotlib colormap name 🌈
• --mode mode — use RGB or RGBA for a transparent background ✨
• --max_words N — maximum number of words 🔝
• --min_font_size size — the smallest font size to use 🐜
• --max_font_size size — the maximum font size for the largest word 🐘
• --font_step step — the step size for the font 👣
• --random_state seed — random seed 🎲
• --no_normalize_plurals — whether to remove trailing 's' from words ✂️
• --repeat — whether to repeat words and phrases 🔁
• --version — shows the program's version number and then exits. peep the version, slay 💅

⚠️ heads up bestie: the option values above like 0 - 1 for --relative_scaling rs, 0 for --contour_width width, and the defaults stdin, stdout, DroidSansMono are exactly as written. don't get creative with them, okay? copy the vibes, not new numbers 🫶

👑 AUTHOR 👑

this manpage was written by Nilesh Patra for the Debian distribution, and it can be used for any other usage of the program. king behaviour, fr fr 🫡

and that's the whole page, bestie!! you ate this. go make a word cloud. the version is wordcloud_cli 1.8.1 and this page is dated November 2020 — periodt. 💅✨