skip to navigation
skip to content

geeknote 0.2a

Geeknote - is a command line client for Evernote, that can be use on Linux, FreeBSD and OS X.


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 in console with different filters;
* edit notes directly in console using any editor: nano, vim, emacs, mcedit;
* sync your local files, directories with Evernote;
* use Evernote with cron or any scripts.

Geeknote is written in Python, so you can use the open source package anywhere you have Python, even in Windows if you like.

Here we have documentation for Geeknote. We'll show basic commands how to work with notes, notebooks and tags in Evernote using Geeknote, also we'll show how to use search to find notes you want and give you some examples.

## Installation
You can install Geeknote as a python script.

### Downloading and installing from source
# Download the repository.
$ git clone git://

$ cd geeknote

# Installation
$ [sudo] python install

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

### Development
Run tests

$ python test

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

## Settings
Geeknote has some settings that you should know.

### Authorization in Evernote
First thing we have to do after installation Geeknote is authorization. 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.

### Logout and change user
If you want to change Evernote user you should launch *logout* command:

$ geeknote logout

And after you can repeat authorization step.

###Look your settings

$ geeknote settings
Version: 0.1
App dir: /Users/username/.geeknote
Error log: /Users/username/.geeknote/error.log
Current editor: vim
Username: username
Id: 11111111

### Set up the default editor
Geeknote allows to edit notes right in console editors in markdown format. We will show it a later in documentation.

And 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

#### Example

$ geeknote settings --editor
Current editor is: nano

$ geeknote settings --editor vim
Editor successfully saved

$ geeknote settings --editor
Current editor is: vim

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

### Synopsis
$ geeknote create --title <title>
--content <content>
[--tags <list of="" tags="">]
[--notebook <notebook where="" to="" save="">]
### Options

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

--content <content>
: Specifying the content of new note. The content must not contains double quotes.

--notepad <notebook where to save>
: Specify the notepad 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.

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

### Description
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.

### Examples
$ geeknote create --title "Shopping list 22.04.2012"
--content "Don't forget to buy milk, turkey and chips."
--notebook "Family"
--tags "shop, holiday, important"

## Editing notes
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!

### Synopsis
$ geeknote edit --note <title of="" note="" which="" to="" edit="">
--content <a new="" content="" or="" "write"="">
[--title <the new="" title="">]
[--tags <new list="" of="" data="">]
[--notebook <new notebook="">]

### Options

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

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

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

### Examples
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"

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

### Synopsis
$ 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="">]
### Description
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".

### Options
--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 singl date:, or date range:

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

: 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.

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

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

### Examples
$ 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"

## Show notes in console
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.

### Synopsis
$ geeknote show <text to="" search="" and="" show="">
That is really simple, so doesn't need any descriptions. Just some examples:
### 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

## Removing notes
You can remove notes with Geeknotes from Evernote.

### Synopsis
$ geeknote remove --notebook <note name="">
### Options

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

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

### Examples
$ geeknote remove --note "Shopping list 25.04.2012"

## Notebooks: show the list of notebooks
Geeknote can display the list of all notebooks you have in Evernote.
### Synopsis
$ geeknote notebook-list

## Notebooks: create the notebook
With Geeknote you can create notebooks in Evernote right in console!
### Synopsis
$ geeknote notebook-create --title <notebook title="">

### Options

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

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

## Notebooks: rename the notebook
With Geeknote it's possible to rename existing notebooks in Evernote.

### Synopsis
$ geeknote notebook-edit --notebook <old name="">
--title <new name="">
### Options

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

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

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

## Tags: show the list of tags
You can get the list of all tags you have in Evernote.
### Synopsis
$ geeknote tag-list

## Tags: create a new tag
Usually tags are created with publishing new note. But if you need, you can create a new tag with Geeknote.
### Synopsis
$ geeknote tag-create --title <tag name="" to="" create="">

### Options

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

### Examples
$ geeknote tag-create --title "Hobby"

## Tags: rename the tag
You can rename the tag:

### Synopsis
$ geeknote tag-edit --tagname <old name="">
--title <new name="">
### Options

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

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

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

## Tags: remove tags
And you can remove tag from your Evernote

### Synopsis
$ geeknote tag-remove --tagname <tag name="">
### Options

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

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

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

## gnsync - synchronization app
gnsync - is an additional application, that is install with Geeknote. gnsync allows to synchronize files in local directories with Evernote. It works only with text data.

### Synopsis
$ 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="" or="" markdown="">]
[--logpath <path to="" logfile="">]
[--notebook <notebook, which="" will="" be="" used="">]
### Options

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

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

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

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

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

## Contributors
* Vitaliy Rodnenko
* Simon Moiseenko
* Ivan Gureev
* Roman Gladkov
* Greg V