Idea Note

idea-note is a tool to manage your idea or notes in one place, then you can synchronize the notes to cloud.

Currently it only support git, but the notes are just a collection of files, you can support box, s3 or google drive easily by some other tools.

Notes: Only MacOS and Neovim have been tested for now.

Table of Contents

• Motivation
• Features
  • CLI
  • Vim Plugin
• Installation(MacOS)
  • Homebrew
    • CLI
    • Vim Plugin
  • Git Repo
    • CLI
    • Vim Plugin
• Usage
  • CLI
  • Vim Plugin

Motivation

• Collect small learning notes and idea
• Manage my data by myself
• Add any feature I wanted in any time
• Save money a lot

Features

CLI

• Create new note in default project
• Create new note in custom project
• Go to given project folder
• Open the existing note
• Add existing file to idea-note
• List recent notes
• Search notes by keywords
• Search note name by keywords
• Search project name by keywords
• Synchronize note to git remote repository
• Synchronize note to s3 bucket
• Encrypt note

Vim Plugin

• Create new note in default project
• Create new note in custom project
• Open the existing note
• Search notes by keywords

Installation(MacOS)

Homebrew

brew tap sjmyuan/idea-note git://github.com/sjmyuan/idea-note.git
brew install idea-note
brew untap sjmyuan/idea-note

CLI

1. Configure IDEA_LOCAL to be the directory in which you want to store your decrypted notes.

   The default value of IDEA_LOCAL is $HOME/.idea/local

   export IDEA_LOCAL=<note directory>

2. Configure IDEA_REMOTE to be the directory in which you want to store your encrypted notes.

   If you want idea-note to support the git synchronization, the directory should be a git repository. The default value of IDEA_REMOTE is $HOME/.idea/remote

   export IDEA_REMOTE=<note directory>

3. Check if the idea command can work

   $ idea help

Vim Plugin

1. Install fzf

   $ brew install fzf

2. Install the dependencies in vimrc, we use Plug as pulgin manager here.

   Plug '/usr/local/opt/fzf'
   Plug 'junegunn/fzf.vim'

3. Install the plugin of idea-note

   Plug '/usr/local/opt/idea-note'

4. Configure the notes directory, if you already installed the cli, can use $IDEA_LOCAL directly.

   let g:idea#local = $IDEA_LOCAL

5. Check if the :IdeaOpen command can work

   :IdeaOpen

Git Repo

First of all, clone the repo to your local environment

$ git clone git@github.com:sjmyuan/idea-note.git

CLI

1. Install the dependencies

   $ brew install git
   $ brew install the_silver_searcher
   $ brew install neovim

2. Add the bin directory to the PATH variable in your bash_profile/zsh_profile

   export PATH="<directory>/bin:$PATH"

3. Configure IDEA_LOCAL to be the directory in which you want to store your decrypted notes.

   The default value of IDEA_LOCAL is $HOME/.idea/local

   export IDEA_LOCAL=<note directory>

4. Configure IDEA_REMOTE to be the directory in which you want to store your encrypted notes.

   If you want idea-note to support the git synchronization, the directory should be a git repository. The default value of IDEA_REMOTE is $HOME/.idea/remote

   export IDEA_REMOTE=<note directory>

5. Check if the idea command can work

   $ idea help

Vim Plugin

1. Install fzf

   $ brew install fzf

2. Install the dependencies in vimrc, we use Plug as pulgin manager here.

   Plug '/usr/local/opt/fzf'
   Plug 'junegunn/fzf.vim'

3. Install the plugin of idea-note

   Plug '<idea-note repository directory>'

4. Configure the notes directory, if you already installed the cli, can use $IDEA_LOCAL directly.

   let g:idea#local = $IDEA_LOCAL

5. Check if the :IdeaOpen command can work

   :IdeaOpen

Usage

CLI

• Browse help message

  $ idea help
  $ idea <command> help

• Create new note in default project

  $ idea open
  $ idea open <custom note name>

• Create new note in custom project

  $ idea open --project demo
  $ idea open --project demo <custom note name>

• Open existing note

  $ idea open <existing note path> // the path can be found in `idea ls`

• Add existing file to idea

  $ idea add <existing file>
  $ idea add --project <project name> <existing file>

• Go to given project folder

  $ idea goto <project name> // the path can be found in `idea ls`

• List recent notes

  $ idea ls

• Search notes

  $ idea search <pattern>

• Search note name by keywods

  $ idea search --file <pattern>

• Search project name by keywods

  $ idea search --project <pattern>

• Synchronize notes to git remote repo

  $ idea git-sync
  $ idea git-sync --password <password>

• Synchronize notes to s3 bucket

  $ idea s3-sync s3://<bucket name>/<folder name>
  $ idea s3-sync --password <password> s3://<bucket name>/<folder name>

Vim Plugin

• Create new note in default project

  :IdeaOpen
  :IdeaOpen <custom note name>

• Create new note in custom project

  :IdeaOpen --project <project name>
  :IdeaOpen --project <project name> <custom note name>

• Open existing note

  :IdeaOpen <existing note path> // the path can be found in `idea ls`

• Search notes

  :IdeaSearch <pattern>