---
name: "wordcloud_cli"
section: "1"
platform: "linux"
package: "python3-wordcloud"
version: "1.9.3+dfsg-2+b2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/wordcloud_cli"
---

# wordcloud\_cli(1)

little word cloud generator in Python

## NAME

wordcloud\_cli - little word cloud generator in Python

## DESCRIPTION

usage: 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\]

A simple command line interface for wordcloud module.

### optional arguments:

- **-h**, **--help**

  show this help message and exit

- **--text** file

  specify file of words to build the word cloud (default: stdin)

- **--regexp** regexp

  override the regular expression defining what constitutes a word

- **--stopwords** file

  specify file of stopwords (containing one word per line) to remove from the given text after parsing

- **--imagefile** file

  file the completed PNG image should be written to (default: stdout)

- **--fontfile** path

  path to font file you wish to use (default: DroidSansMono)

- **--mask** file

  mask to use for the image form

- **--colormask** file

  color mask to use for image coloring

- **--contour\_width** width

  if greater than 0, draw mask contour (default: 0)

- **--contour\_color** color

  use given color as mask contour color - accepts any value from PIL.ImageColor.getcolor

- **--relative\_scaling** rs

  scaling of words by frequency (0 - 1)

- **--margin** width

  spacing to leave around words

- **--width** width

  define output image width

- **--height** height

  define output image height

- **--color** color

  use given color as coloring for the image - accepts any value from PIL.ImageColor.getcolor

- **--background** color

  use given color as background color for the image - accepts any value from PIL.ImageColor.getcolor

- **--no\_collocations**

  do not add collocations (bigrams) to word cloud (default: add unigrams and bigrams)

- **--include\_numbers**

  include numbers in wordcloud?

- **--min\_word\_length** min\_word\_length

  only include words with more than X letters

- **--prefer\_horizontal** ratio

  ratio of times to try horizontal fitting as opposed to vertical

- **--scale** scale

  scaling between computation and drawing

- **--colormap** map

  matplotlib colormap name

- **--mode** mode

  use RGB or RGBA for transparent background

- **--max\_words** N

  maximum number of words

- **--min\_font\_size** size

  smallest font size to use

- **--max\_font\_size** size

  maximum font size for the largest word

- **--font\_step** step

  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**

  show program's version number and exit

## AUTHOR

 This manpage was written by Nilesh Patra for the Debian distribution and\
  can be used for any other usage of the program.
