Skip to content

Notes-CLI is a tool for note-taking in the command line. Notes are stored in a JSON file in the root directory.

Notifications You must be signed in to change notification settings

sossw1/Notes-CLI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notes-CLI

Table of Contents

  1. About
  2. Installation
  3. Usage
  4. License

About

Notes-CLI is a tool for note-taking in the command line. Using the common module fs from Node.js, notes are stored in an output file notes.json in the root directory.

Installation

Fork the GitHub repository here, then clone the forked version to your device.

Install all dependencies using npm:

npm install

To generate the JavaScript files needed to run the program, run the TypeScript compiler:

tsc

The generated files should appear in the root directory.

Usage

In command line, use node app.js --help to reference all available commands, or append the --help flag to any command to see usage info.

Adding a Note

Parameters: title (string), body (string)

node app.js add --title="My First Note" --body="This is great!"

Reading a Note

Parameters: title (string)

node app.js read --title="My First Note"

Listing all Notes

Parameters: none

node app.js list

Deleting a Note

Parameters: title (string)

node app.js delete --title="My First Note"

License

See MIT License

About

Notes-CLI is a tool for note-taking in the command line. Notes are stored in a JSON file in the root directory.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published