https://github.com/splode/jin
A CLI app for taking simple notes without ever leaving the terminal.
https://github.com/splode/jin
cli nodejs notes notes-app terminal terminal-app
Last synced: 9 months ago
JSON representation
A CLI app for taking simple notes without ever leaving the terminal.
- Host: GitHub
- URL: https://github.com/splode/jin
- Owner: Splode
- License: mit
- Created: 2018-04-08T17:25:10.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-07T19:45:13.000Z (about 7 years ago)
- Last Synced: 2025-03-25T10:42:37.867Z (10 months ago)
- Topics: cli, nodejs, notes, notes-app, terminal, terminal-app
- Language: JavaScript
- Homepage:
- Size: 708 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jin
*A CLI app for taking simple notes without ever leaving the terminal.*
## Overview
jin allows you to take and organize simple notes without ever leaving the command line. Capture ideas, track tasks, and reference code snippets with straightforward and intuitive commands.
## Table of contents
* [Overview](#overview)
* [Installation](#installation)
* [Usage](#usage)
* [Related](#related-projects)
* [License](#license)
## Installation
```bash
$ npm install --global jin-app
```
## Usage
### Commands
* [`add`](#add-note)
* [`list`](#list-notes)
* [`edit`](#edit-note)
* [`remove`](#remove-note)
* [`export`](#export-notes)
* [`help`](#help)
### Add Note
```bash
# Add a new note to an existing notebook.
# If the notebook does not exist, it will be created.
$ jin add [notebook]
# jin a [notebook]
```
```bash
# Create a new, empty notebook.
$ jin add [notebook]
# jin a [notebook]
```
> Note: a notebook name is required.
#### Example
```console
$ jin add nodejs "Use 'util.promisify()' to promisify a callback-style function."
✔ Added "Use 'util.promisify()' to promisify a callback-style function." to "nodejs".
```
### List Notes
```bash
# List all notes in the given notebook.
# Pass the --long|-l option to get detailed information.
$ jin list [options] [notebook]
# jin ls [options] [notebook]
```
```bash
# List all notebooks.
# Pass the --long|-l option to get detailed information.
$ jin list [options]
# jin ls [options]
```
#### Example
```console
$ jin list nodejs
nodejs Notes
----------------
0 Use 'os.homedir()' to access the home directory.
1 Use 'util.promisify()' to promisify a callback-style function.
```
### Edit Note
```bash
# Edit the contents of a note at the given index of a given notebook.
$ jin edit
# jin ed
```
### Remove Note
```bash
# Remove a note at the given index of a given notebook.
$ jin remove [notebook]
# jin rm [notebook]
```
```bash
# Remove a given notebook.
$ jin remove [notebook]
# jin rm [notebook]
```
> Note: You must pass in the `--force` flag when attempting to remove a notebook that contains notes.
#### Examples
```console
$ jin remove nodejs 0
✔ Removed note at index 0 from nodejs notebook.
```
```console
$ jin rm --force nodejs
✔ Removed nodejs notebook.
```
### Export Notes
```bash
# Create an exports of the notes collection in the current directory.
$ jin export
# jin exp
```
> The notes collection is stored in the user's home directory by default.
### Help
```bash
# Display general help output.
$ jin --help
# jin -h
```
```bash
# Display command-specific help output.
$ jin [cmd] --help
```
## Related Projects
* [Dnote](https://github.com/dnote-io/cli)
* [Idea](https://github.com/IonicaBizau/idea)
## License
MIT © [Christopher Murphy](https://github.com/splode)
[⬆ **Back to Top**](#jin)