Install

Installation for command line

Minion requires Python2.

1. Clone the source code from GitHub:

   git clone https://github.com/edthedev/minion
   

2. Configure your shell:

   • bash/zsh/sh:

     Add the following to your profile (e.g. ~/.bashrc):

      source ~/minion/add_to_your_profile.zsh

   • fish:

     Add the following to your ~/.config/fish/config.fish

      set -x MINION_INSTALL $HOME/minion
      
      if [ -d "$MINION_INSTALL" ]
      	set -x PATH $MINION_INSTALL $PATH
      end
      
      # Some optional aliases, to get started.
      # Uncomment the ones you want.
      alias mn="minion"
      # alias icannotfind="minion open --archive --full"
      # alias newnote="minion note"
      # alias open="minion open"
      # alias remind="minion remind"
      # alias summary="minion summary" 
      # alias favorites="minion favorites"

3. Run Minion once to ensure that a default ~/.minion file gets created.

   minion dates .
   

4. Edit ~/.minion to set your notes directory.

   [notes]
   home = ~/Documents
   

5. Optionally, edit ~/.minion to modify the default editor, templates, and text file extension.

   [compose]
   templates = /Users/edward/.vim/bundle/minion/plugin/../templates
   extension = .md
   editor = vim