bashwords - learn vocabulary from your shell

bashwords is a very minimal vocabulary trainer for the BASH environment. It was designed with simplicity in mind.

All it does is affix a pseudo-random vocabulary word from a user-defined (that's you) dictionary to your command prompt; e.g,

analgesic host:dir usr$

It makes sure that your base of vocabulary words gets uniform coverage, while incorporating a little bit of randomness.

Unsure of a word's meaning? Use defword.

analgesic host:dir usr$ defword
  analgesic
  Definition: acting to relieve pain
  Synonyms: ['anesthetic', 'anodyne']

Like to add a word? Use addword.

analgesic host:dir usr$ addword
Which word would you like to add?: ameliorate
Its definition?: make something (bad or unsatisfactory) better
Some synonyms? (delimit each with ','): enhance, alleviate 
Word added. 4 total words in collection.

How about deleting? Use delword.

analgesic host:dir usr$ delword
Word to delete: ameliorate
Entry for 'ameliorate' successfully removed.

List all words in dictionary with lswords.

Batch import words with ./bashwords fromFile.

File format: [name of word] [definition] [synonyms] [blank line]

Dump all words currently in bank to file with ./bashwords toFile. File comes in same format as above.

To install

1. Throw the bashwords python file into a folder, say ~/.bashwords. (If you don't choose ~/.bashwords, modify BASHWORDS_DIR in bashwords to ensure it matches the directory it's in.)

   $ git clone git@github.com:jamesob/bashwords.git
   $ cd bashwords
   $ mv bashwords ~/.bashwords/.
   

2. Make bashwords executable:

   $ cd ~/.bashwords
   $ chmod +x bashwords
   

3. Initialize:

   $ ./bashwords init
   

4. Source the generated file in your .bashrc or .bash_profile:

   source [your bashwords directory]/bashdefs.sh
   

5. Open a new shell.

Done!

Copyright (c) 2009 James O'Beirne

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.