Giter Site home page Giter Site logo

notejs's Introduction

note.js

Command line tool for note-taking & sharing

note.js is a node.js based tool which helps you to take and share notes between your computers and even with your colleagues, right from your terminal! You short text snippets will be saved online so you can access them anywhere you want.

Installation

npm install -g notejs

How to use

Placeholders

  • USERNAME: 4-20 alphanumeric characters (no spaces) - Your personal or your colleague's note.js username.
  • PASSWORD: 4-20 characters (no spaces) - Your note.js password.
  • NOTE: 2-20 alphanumeric characters (no spaces) - Note's name, also serves as its unique ID.
  • CONTENT: 2-200 characters - Note's content.

Commands

  1. First you'll have to register in order to be able to use all features:
    note register USERNAME PASSWORD

  2. Now you can post your first note:
    note post NOTE CONTENT

  3. To see all notes of a user (use my as USERNAME to see yours):
    note get USERNAME

  4. Alternatively, you can open specific note if you know its name or even part of it:
    note get USERNAME NOTE

  5. You can even email a note!
    note email USERNAME NOTE EMAIL

  6. If you want to create a note which won't be seen when other users run the command in step #3, you can create a somewhat "private" note, which will be seen only for users who know the note's name:
    note post-private NOTE CONTENT

  7. To delete an existing note:
    note delete NOTE

  8. If your repository is a mess and you want to delete all your notes:
    note delete-all

  9. In any case your session expires, you have to login in order to be able to use all features:
    note login USERNAME PASSWORD

  10. Forgot with which user you are logged in?
    note whoami

  11. Working on a public computer? make sure you logout after finish working:
    note logout

  12. When you think it's time to say goodbye, run this command to delete all your notes and username
    note unregister

Limitations

  • Currently, each user is allowed to create up to 100 notes (it may change in the near future)

notejs's People

Contributors

nire0510 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.