cmdnote

CmdNote

A simple note taking system for command line interface.

中文文档

Installation

Firstly, install Golang

Refer to the Go official website and follow the instructions.

Secondly, download project source code

$ git clone https://github.com/qige96/cmdnote.git

Lastly, compile (and install)

$ cd cmdnote
$ go build   # require third party dependency, may demand network
$ go install # install to $GOPATH (optional)

Usage

You could do basic CURD to the notes. All notes are stored as files in your local repository.

$ cmdnote -w hello.txt # invoke your preferred editor to write a file
$ cmdnote -r hello.txt # invoke your preferred reader to read a file
$ cmdnote -l           # list all available notes
$ cmdnote --rename hello.txt:world.txt  # rename a note, use ":" to seperate old name and new name
$ cmdnote --remove world.txt            # remove a note

Support full text search by keywords

$ cmdnote -l
go.txt
hello.txt
lang.txt
lesson1.txt

$ cmdnote -s "hello"
go.txt
hello.txt

--list and --search also support interactive inspection

$ cmdnote -l -i 
    0) go.txt
    1) hello.txt
    2) lang.txt
    3) lesson1.txt
> Which note would you like to check? 0
> Which program would you like to use? cat
hello golang!
> Which note would you like to check? 1
> Which program would you like to use? cat
hello world!
> Which note would you like to check? 2
> Which program would you like to use? cat
Other langs: 

- C
- C++
- C#
- Objectve-C
- Lisp
- PHP
- JavaScript
- TypeScript

> Which note would you like to check? 3
> Which program would you like to use? cat
This is lesson 1.

Fundamental syntax.
> Which note would you like to check?

$

Configuration

Configuration file conf.json is located under the same directory as the executable file live, config for Windows may look like：

{
        "editor": "notepad",
        "browser": "notepad",
        "localRepoDir": "F:\\cmdnote\\cmd_notes",
        "remoteRepoDir": ""
}

config for Linux or MacOS(Darwin) may look like：

{
        "editor": "nano",
        "browser": "nano",
        "localRepoDir": "/home/ubuntu/cmdnote",
        "remoteRepoDir": ""
}

License

MIT License