Skip to content
This repository was archived by the owner on Jun 14, 2026. It is now read-only.

Command_Line_Use

Edward Delaporte edited this page Dec 13, 2014 · 1 revision

Usage

Create a new note in your inbox folder:

minion remind Need to Meet with Mr. Gordon on Monday

Your inbox folder is a subfolder of your $NOTES_HOME folder, which is determined by your .minion file, or the $NOTES_HOME environment variable. The default value is ~/Notes, but I typically change it to $NOTES_HOME to ~/Dropbox/notes, since I am a Dropbox user.

Because it is inside a subfolder of the notes folder, the file you just created can now be instantly recalled by minion in various useful ways.

Calling minion with a command line argument will search for that term (or terms):

To list every file that mentions gordon:

minion list gordon

This will list anything in the notes directory (outside of the archive folders) with gordon (case insensitive) in the file name or text body.

To immediately open a note after creating it, use the note command instead of remind:

minion note cave security plan

To open a specific file, use the 'open' command with enough keywords to uniquely match a file you have already created:

minion open cave security plan

This will search for all files with all three search terms, regardless of their order or location. If there are multiple matches, the matches will be displayed, and you will be prompted for additional search terms. Once enough terms have been added to find a unique match, the file will be opened in your preferred editor.

Configure your preferred editor in either your ~/.minion configuration file or your $EDITOR environment variable. You may also override your setting by calling minion with the --editor= flag. Minion will also detect some binary files and open them with an appropriate viewer on Linux, but this feature is still in Beta.

To see a summary of everything you have stored in Minion folders:

minion summary
164 - someday
51 - journal
44 - wiki 
28 - pics 
23 - soon 
22 - teddy
16 - blog 
13 - next 
4 - waiting
4 - today

This command will step you through your inbox:

minion sort inbox

Here are some handy things you can do when stepping through results:

a - archive - Move the file into the 'Archive.YYYY.MM' folder.
d - done - Delete the file (after confirmation).
r - rename - Lets you type in a new name. Renaming resets all tags, so retype any tags that you want to keep.
v - view the file inline
>later - Move the file into a folder next to the inbox called 'later'. If the folder does not exist yet, it will be created.
@email - Add an @email keyword to the file name, to assist with searching later.

You can combine any number of additional keywords with a single folder move, so this command is valid:

@email @alfred >later

Setting and using dates

  1. Create a note:

    minion note NOTENAME
    
  2. This opens the file NOTENAME.txt which shoud look like this:

    NOTENAME
    ====
    :date: 2014-03-04
    
  3. Change the date accordingly.

  4. List all notes with their according dates:

    minion dates txt
    

Print the contents of all files matching 'foo' to standard output.

minion view foo | more
minion view foo --max=1 | more

Clone this wiki locally