Giter Site home page Giter Site logo

quicknote's Introduction

quicknote (qn)

quicknote is a terminal-based notetaking system designed around speed and ease-of-use.

The primary philosophy when designing this tool was to make recording quick thoughts or ideas as simple as possible without hampering productivity. For the terminal power user and UNIX enthusiast, having the ability to take notes in the same environment without context-switching is incredibly useful.

The efficiency of this program comes with a cost - the overall feature set is quite limited. If you take meticulous, interconnected notes through a more robust PKM system, please use Obsidian or another tool better suited for your needs.

Setup

# Install quicknote and any required external dependencies
pip install git+https://github.com/cdkini/quicknote.git
brew install fzf ripgrep bat

# Point your root env var at your desired notes directory
export QN_ROOT=$HOME/notes # Or other existing directory

# Configure your editor
export EDITOR="nvim" # Or other valid terminal-based editor

Commands

Primary Commands:
  add     Create a new note.
  upsert  Update a note if it exists or create a new one.
  open    Open note(s).
  grep    Search through notes.
  ls      List notes.
  rm      Delete note(s).

Misc Commands:
  status  Get status of notes with Git.
  sync    Sync notes with GitHub.
  web     Open notes in GitHub.

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.