This is my playground for porting geeknote to Python 3, here be dragons.

Geeknote is a command line client for Evernote that can be use on Linux, FreeBSD and OS X. It allows you to:

• create notes in your Evernote account;
• create tags, notebooks;
• use Evernote search from the console using different filters;
• edit notes directly in the console using any editor, such as nano, vim or mcedit;
• synchronize your local files and directories with Evernote;
• use Evernote with cron or any scripts.

Geeknote is open source and written in Python. Geeknote can be used anywhere where you have Python installed (even in Windows if you like).

In this document we'll show basic commands how to work with Evernote's notes, notebooks and tags using Geeknote and how to use Geeknote search.

You can install Geeknote as a python script or using Homebrew/Linuxbrew.

brew install --HEAD https://raw.githubusercontent.com/VitaliyRodnenko/geeknote/master/geeknote.rb

# Install dependencies. (This example for Debian-based systems):
$ [sudo] apt-get update; [sudo] apt-get -y install python-setuptools

# Download the repository.
$ git clone git://github.com/jeffkowalski/geeknote.git  # this repository
# -or-
$ git clone git://github.com/VitaliyRodnenko/geeknote.git  # original author's repository

$ cd geeknote

# Optional configuration
#   For Yinxiang 印象笔记, set USE_YINXIANG to True in geeknote/config.py
#   By default, the False setting will enable Evernote servers
#   If you want to temporarily switch between Yinxiang and standard Evernote,
#   you maybe wish instead to use the environment variable GEEKNOTE_BASE,
#   described below in "(Yinxiang Biji notes)"

# Installation
$ [sudo] python[2] setup.py install

# Launch Geeknote and go through login procedure.
$ geeknote login

Run tests

$ python[2] setup.py test

# or, to run tests with `tox`
$ tox

After installation, Geeknote must be authorized with Evernote prior to use. To authorize your Geeknote in Evernote launch the command login:

$ geeknote login

This will start the authorization process. Geeknote will ask you to enter your credentials just once to generate access token, which will be saved in local database. Re-authorization is not required, if you won't decide to change user. After authorization you can start to work with Geeknote.

If you want to change Evernote user you should launch logout command:

$ geeknote logout

Afterward, you can repeat the authorization step.

If you want to use Evernote's separate service in China Yinxiang Biji (印象笔记), you need to set the environment variable GEEKNOTE_BASE to yinxiang.

$ GEEKNOTE_BASE=yinxiang geeknote login

Yinxiang Biji (印象笔记) is faster in China and it supports Chinese payment method. Be aware that Yinxiang Biji will not have support for sharing social features like twitter and facebook. And since data are stored on servers in China, Chinese authorities have the right to access their data according to current regulations.

For more information, see:

https://blog.evernote.com/blog/2012/05/09/evernote-launches-separate-chinese-service/

$ geeknote settings
Geeknote
******************************
Version: 0.1
App dir: /Users/username/.geeknote
Error log: /Users/username/.geeknote/error.log
Current editor: vim
Markdown2 Extras: None
Note extension: .markdown,.org
******************************
Username: username
Id: 11111111
Email: example@gmail.com

You can edit notes within console editors in plain text or markdown format.

You can setup the default editor you want to use. To check which editor is now set up as a default call:

$ geeknote settings --editor

To change the default editor call:

$ geeknote settings --editor vim

$ geeknote settings --editor
  Current editor is: nano

$ geeknote settings --editor vim
  Editor successfully saved

$ geeknote settings --editor
  Current editor is: vim

The main functionality that we need is creating notes in Evernote.

$ geeknote create --title <title>
                  [--content <content>]
                  [--tags <list of tags>]
                  [--created <date and time>]
                  [--resource <attachment filename>]
                  [--notebook <notebook where to save>]
                  [--reminder <date and time>]

--title <title> : With this option we specify the title of new note we want to create.

--content <content> : Specify the content of new note. The content must not contain double quotes.

--tags <list of tags, like: tag1, tag2> : Specify tags that our note will have. It can accept multiple tags, separated with comma.

--created <date> : Set note creation date and time in either 'yyyy-mm-dd' or 'yyyy-mm-dd HH:MM' format.

--resource <attachment filename, like: document.pdf> : Specify file to be attached to the note. May be repeated.

--notebook <notebook where to save> : Specify the notebook where new note should be saved. This option is not required. If it isn't given, the note will be saved in default notebook. If notebook doesn't exist Geeknote will create it automatically.

--reminder <date> : Set reminder date and time in either 'yyyy-mm-dd' or 'yyyy-mm-dd HH:MM' format. Alternatively use TOMORROW and WEEK for 24 hours and a week ahead respectively, NONE for a reminder without a time. Use DONE to mark a reminder as completed.

This command allows us to create a new note in Evernote. Geeknote has designed for using in console, so we have some restrictions like inability to use double quotes in --content option. But there is a method to avoid it - use stdin stream or file synchronization, we show it later in documentation.

Creating a new note:

$ geeknote create --title "Shopping list 23.04.2015"
                  --content "Don't forget to buy milk, turkey and chips."
                  --resource shoppinglist.pdf
                  --notebook "Family"
                  --tags "shop, holiday, important"

Creating a new note and editing content in editor:

$ geeknote create --title "Meeting with customer"
                  --notebook "Meetings"
                  --tags "projectA, important, report"
                  --created "2015-10-23 14:30"

With Geeknote you can edit your notes in Evernote using any editor you like. It could be nano, vi, vim etc ... You can edit notes right in console!

$ geeknote edit --note <title or GUID of note to edit>
                [--content <new content or "WRITE">]
                [--title <the new title>]
                [--tags <new list of data>]
                [--created <date and time>]
                [--resource <attachment filename>]
                [--notebook <new notebook>]
                [--reminder <date and time>]

--note <title of note which to edit> : Tell to Geeknote which note we want to edit. Geeknote will make a search by the name. If geeknote will find more than one note with such name, it will ask you to make a choice.

--title <a new title> : Use this option if you want to rename your note. Just set a new title, and Geeknote will rename the old one.

--content <a new content or "WRITE"> : Enter the new content of your notes in text, or write instead the option "WRITE". In the first case the old content on the note will be replaced with new one. In the second case Geeknote will get the current content and open it in Markdown in a text editor.

--resource <attachment filename, like: document.pdf> : Specify file to be attached to the note. May be repeated. Will replace existing resources.

--tags <list of tags, like: tag1, tag2> : The same for tags - you can set a new list of tags for your note.

--created <date> : Set note creation date date and time in either 'yyyy-mm-dd' or 'yyyy-mm-dd HH:MM' format.

--notebook <notebook where to save> : With this option you can change the notebook which contains your note.

--reminder <dd.mm.yy-HH:MM> --reminder <date> : Set reminder date and time in either 'yyyy-mm-dd' or 'yyyy-mm-dd HH:MM' format. Alternatively use TOMORROW and WEEK for 24 hours and a week ahead respectively, NONE for a reminder without a time. Use DONE to mark a reminder as completed. Use DELETE to remove reminder from a note.

Simple editing:

Renaming the note:

$ geeknote edit --note "Shoplist 22.05.2012" --title "Shoplist 23.05.2012"

Renaming the note and editing content in editor:

$ geeknote edit --note "Shoplist 22.05.2012" --title "Shoplist 23.05.2012" --content "WRITE"

You can easily search notes in Evernote with Geeknote and get results in console.

$ geeknote find --search <text to find>
                [--tags <list of tags that notes should have>]
                [--notebooks <list on notebooks where to make search >]
                [--date <data ro data range>]
                [--count <how many results to show>]
                [--exact-entry]
                [--content-search]
                [--url-only]
                [--reminders-only]
                [--ignore-completed]
                [--with-tags]
                [--with-notebook]
                [--guid]

With find you can make a search through your Evernote. It has an usefull options that allow you to make search more detail. Important notice, that Geeknote remembers the result of the last search. So, you can use the number of the note's position to make some actions that Geeknote can. For example:

$ geeknote find --search "Shopping"

Total found: 2
  1 : Shopping list 22.04.2012
  2 : Shopping list 25.04.2012

$ geeknote show 2

That will show you the note "Shopping list 25.04.2012".

--search <text to find> : Set the text you want to find. You can use "*" like this: --search "Shop*"

--tags <list of tags that notes should have> : Filter by tag. It makes possible to search notes, that have necessary tags. Tags can be separated with comma.

--notebooks <list on notebooks where to make search> : Search just in notebook/notebooks you need. The list of notebooks specify by comma.

--date <date or range> : Filter by date. You can set a single date: dd.mm.yyyy, or date range: dd.mm.yyyy-dd.mm.yyyy

--count <how many results to show> : Limits the number of displayed results.

--exact-entry : By default Geeknote has a smart search, so it searches not exact entries. But if you need exact entry, you can set this option. It doesn't take any arguments.

--content-search : find command searches by note's title. If you want to search by note's content - set this option. It doesn't take any arguments.

--url-only : Show results as a list of URLs to the every note in Evernote's web-client.

--reminders-only : Include only notes with a reminder.

--ignore-completed : Include only unfinished reminders.

--with-tags : Show tags of the note after note title.

--with-notebook : Show notebook which contains the note after note title.

--guid : Show GUID of the note as substitute for result index.

$ geeknote find --search "How to patch KDE2" --notebooks "jokes" --date 25.03.2012-25.06.2012
$ geeknote find --search "apt-get install apache nginx" --content-search --notebooks "manual"

You can output any note in console using command show - that is add-on for find. When you use show it make search previously, and if the count of results more then 1, Geeknote will ask you to make a choise.

$ geeknote show <text or GUID to search and show>

That is really simple, so doesn't need any descriptions. Just some examples:

$ geeknote show "Shop*"

  Total found: 2
    1 : Shopping list 22.04.2012
    2 : Shopping list 25.04.2012
    0 : -Cancel-
  : _

As we mentioned before, show can use the results of previous search, so if you have already done the search, just call show with number of previous search results.

$ geeknote find --search "Shop*"

  Total found: 2
  1 : Shopping list 22.04.2012
  2 : Shopping list 25.04.2012

$ geeknote show 2

You can remove notes with Geeknotes from Evernote.

$ geeknote remove --notebook <note name or GUID>
                 [--force]

--note <note name> : Name of the note you want to delete. If Geeknote will find more than one note, it will ask you to make a choice.

--force : A flag that says that Geeknote shouldn't ask for confirmation to remove note.

$ geeknote remove --note "Shopping list 25.04.2012"

Geeknote can display the list of all notebooks you have in Evernote.

$ geeknote notebook-list [--guid]

--guid : Show GUID of the notebook as substitute for result index.

With Geeknote you can create notebooks in Evernote right in console!

$ geeknote notebook-create --title <notebook title>

--title <notebook title> : With this option we specify the title of new note we want to create.

$ geeknote notebook-create --title "Sport diets"

With Geeknote it's possible to rename existing notebooks in Evernote.

$ geeknote notebook-edit --notebook <old name>
                         --title <new name>

--notebook <old name> : Name of existing notebook you want to rename.

--title <new name> : New title for notebook

$ geeknote notebook-edit --notebook "Sport diets" --title "Hangover"

You can get the list of all tags you have in Evernote.

$ geeknote tag-list [--guid]

--guid : Show GUID of the tag as substitute for result index.

Usually tags are created with publishing new note. But if you need, you can create a new tag with Geeknote.

$ geeknote tag-create --title <tag name to create>

--title <tag name to create> : Set the name of tag you want to create.

$ geeknote tag-create --title "Hobby"

You can rename the tag:

$ geeknote tag-edit --tagname <old name>
                    --title <new name>

--tagname <old name> : Name of existing tag you want to rename.

--title <new name> : New name for tag.

$ geeknote tag-edit --tagname "Hobby" --title "Girls"

And you can remove tag from your Evernote

$ geeknote tag-remove --tagname <tag name>
                     [--force]

--tagname <tag name> : Name of existing tag you want to remove.

--force : A flag that says that Geeknote shouldn't ask for confirmation to remove tag.

$ geeknote tag-remove --tagname "College" --force

gnsync - is an additional application, that is install with Geeknote. gnsync allows to synchronize files in local directories with Evernote. It works with text data and html with picture attachment support.

$ gnsync --path <path to directory which to sync>
        [--mask <unix shell-style wildcards to select the files, like *.* or *.txt or *.log>]
        [--format <in what format to save the note - plain, markdown, or html>]
        [--notebook <notebook, which will be used>]
        [--all]
        [--logpath <path to logfile>]
        [--two-way]
        [--download]

--path <path to directory which to sync> : Set with that option the directory you want to sync with Evernote. It should be the directory with text content files.

--mask <unix shell-style wildcards to select the files> : You can tell gnsync what filetypes to sync. By default gnsync tries to open every file in the directory. But you can set the mask like: *.txt, *.log, *.md, *.markdown.

--format <in what format to save the note - plain or markdown> : Set the engine which to use while files uploading. gnsync supports markdown and plain text formats. By default it uses plain text engine.

--notebook <notebook where to save> : You can set the notebook which will be syncronized with local directory. But if you won't set this option, gnsync will create new notebook with the name of the directory that you want to sync.

--all : You can specify to synchronize all notebooks already on the server, into subdirectories of the path. Useful with --download to do a backup of all notes.

--logpath <path to logfile> : gnsync can log information about syncing and with that option you can set the logfile.

--two-way : Normally gnsync will only upload files. Adding this flag will also make it download any notes not present as files in the notebook directory (after uploading any files not present as notes)

--download-only : Normally gnsync will only upload files. Adding this flag will make it download notes, but not upload any files

The application gnsync is very useful in system adminstration, because you can syncronize you local logs, statuses and any other production information with Evernote.

$ gnsync --path /home/project/xmpp/logs/
         --mask "*.logs"
         --logpath /home/user/logs/xmpp2evernote.log
         --notebook "XMPP logs"

• Vitaliy Rodnenko
• Simon Moiseenko
• Ivan Gureev
• Roman Gladkov
• Greg V
• Ilya Shmygol