Skip to content

Latest commit

 

History

History
160 lines (109 loc) · 4.53 KB

README.md

File metadata and controls

160 lines (109 loc) · 4.53 KB
Raw

Zinc

A command-line tool for (internal) memos ✏️





A command-line tool to sink and find memos (a.k.a notes) on the fly from your favourite terminal. Zinc follows a simplified markdown template to store the memos.


Zinc Gif


Contents


Install & Run

Dev Environment

Clone the tool from here and execute the following command from the root directory to install the dependencies

npm install

Execute the following command from the root directory to link the Zinc with the local Node modules

npm link

To verify, fire up a terminal and execute the following

zinc --version

How it works

Zinc uses a simplified markdown structure to write and sink the memos (notes). Once Zinc is installed in your environment to store notes,

  • Execute the --sink command to configure the Zinc with a preferred location to physically store the memos and the meta information
  • Then execute the --write command to create your first memo / note
  • Execute the --zync command to sync the memos and to generate a meta JSON
  • Find and retrieve back your memos with --find flag and the keyword

Commands & Usages

Usage: zinc [flag]

Options:
  --version     Show version number                                    [boolean]
  -s, --sink    configure a location to sink the memos                 [boolean]
  -w, --write   write a memo                                           [boolean]
  -z, --zync    zi(sy)nc the memos                                     [boolean]
  -f, --find    keyword to search through                               [string]
  -u, --update  update/rewrite an existing memo                         [string]
  -r, --remove  remove a memo                                           [string]
  -l, --list    list all memos                                         [boolean]
  --help        Show help                                              [boolean]

Examples:
  zinc --sink              configure a sink location to store the memos
  zinc --write             write a memo by providing a title, description,
                           source (an external (URL) reference), and
                           code/segment if exists
  zinc --zync              sync the memos to find the memos using the keyword
  zinc --find <keyword>    find a memo using the keyword
  zinc --update <keyword>  update/rewrite an existing memo
  zinc --remove <keyword>  remove a memo from zinc
  zinc --list              list all memos

--sink memos

The --sink flag is used to setup the Zinc in your environment and to configure a sink (storage) location to persist the memos. Execute the following command to configure the sink location for Zinc

zinc --sink

--write memos

The --write flag is used to write memos from the terminal window. Zinc prompts a couple of required questions to fill up and then voila, your memo (note) is stored inside the configured sink location.

zinc --write

--zync memos

The --zync flag is used to sync the memos which are stored in the sink. Zinc syncs the memos (notes) and creates a meta JSON to use it onwards.

zinc --zync

--find memos

The --find flag is used to search through the memos using the prompted keywords. Zinc uses the meta JSON to traverse through and find the matching memos with the given keyword.

zinc --find <keyword>

--update memo

The --update flag is used to search and update/re-write and existing memo in the Zinc.

zinc --update <keyword>

--remove memo

The --remove flag is used to search and remove an existing memo from the Zinc.

zinc --remove <keyword>

--list memos

The --list flag is used to list all existing memos of the Zinc.

zinc --list

License

Licensed under MIT