https://github.com/athiththan11/zinc
A command-line tool for (internal) memos/notes :pencil2:
https://github.com/athiththan11/zinc
command-line memo nodejs notes zinc
Last synced: 2 months ago
JSON representation
A command-line tool for (internal) memos/notes :pencil2:
- Host: GitHub
- URL: https://github.com/athiththan11/zinc
- Owner: athiththan11
- License: mit
- Created: 2020-06-07T14:15:43.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-05T06:30:53.000Z (about 2 years ago)
- Last Synced: 2025-01-01T07:27:06.658Z (4 months ago)
- Topics: command-line, memo, nodejs, notes, zinc
- Language: JavaScript
- Homepage:
- Size: 4.26 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Zinc
A command-line tool for (internal) memos :pencil2:
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](examples/memo.md) to store the memos.
## Contents
- [Contents](#contents)
- [Install & Run](#install--run)
- [Dev Environment](#dev-environment)
- [How it works](#how-it-works)
- [Commands & Usages](#commands--usages)
- [`--sink` memos](#--sink-memos)
- [`--write` memos](#--write-memos)
- [`--zync` memos](#--zync-memos)
- [`--find` memos](#--find-memos)
- [`--update` memo](#--update-memo)
- [`--remove` memo](#--remove-memo)
- [`--list` memos](#--list-memos)
- [License](#license)
## Install & Run
### Dev Environment
Clone the tool from [here](https://github.com/athiththan11/Zinc) and execute the following command from the root directory to install the dependencies
```sh
npm install
```
Execute the following command from the root directory to link the `Zinc` with the local Node modules
```sh
npm link
```
To verify, fire up a terminal and execute the following
```sh
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`](#--sink-memos) command to configure the `Zinc` with a preferred location to physically store the memos and the meta information
- Then execute the [`--write`](#--write-memos) command to create your first memo / note
- Execute the [`--zync`](#--zync-memos) command to sync the memos and to generate a meta JSON
- Find and retrieve back your memos with [`--find`](#--find-memos) flag and the keyword
## Commands & Usages
```sh
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 find a memo using the keyword
zinc --update update/rewrite an existing memo
zinc --remove 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`
```sh
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.
```sh
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.
```sh
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.
```sh
zinc --find
```
### `--update` memo
The `--update` flag is used to search and update/re-write and existing memo in the `Zinc`.
```sh
zinc --update
```
### `--remove` memo
The `--remove` flag is used to search and remove an existing memo from the `Zinc`.
```sh
zinc --remove
```
### `--list` memos
The `--list` flag is used to list all existing memos of the `Zinc`.
```sh
zinc --list
```
## License
Licensed under [MIT](LICENSE)