memo

command module
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 18, 2023 License: MIT Imports: 3 Imported by: 0

README

Memo

Memo is a commandline tool to store and organize notes on your local file system.

  • Built on top of the amazing bbolt db
  • Fuzzy text search
  • Free open source software
  • Works on Linux, Mac OSX, Windows
  • Just a single portable binary file

About Memo notes

A Memo note represents information that you want to keep.

  • it has a title and some content
  • can be encrypted and decrypted automatically
  • by default memo are stored in the memos archive but you can specify a different one
    • using the -store flag or setting the MEMO_STORE environment variable
Encryption

Content of a Memo note can eventually be encrypted.

  • encryption will be done using AES-256-CFB
  • use the environment variable MEMO_SECRET with your secret phrase

Use cases

  • configuration parameters for others local tools and apps
  • credentials (using the encryption feature)
  • notes, gists, code snippets, whatever

Commands

┌┬┐┌─┐┌┬┐┌─┐
│││├┤ ││││ │
┴ ┴└─┘┴ ┴└─┘
Store and organize notes on your local file system.

Usage:
   memo <command>

Commands:
   add      Create a new memo.
   delete   Delete a memo.
   dump     Dump all memos belonging to a specific store.
   get      Retrieve a memo.
   help     Show a list of all commands or describe a specific command.
   info     Print build information and list all existing stores.
   list     Shows a summary list of all memos.
   search   Execute a search against the store.
   sink     Sink all memos from a YAML source.
   update   Update an existing memo.

How To Install

MacOs

brew tap lucasepe/memo
brew install memo

or if you have already installed memo using brew, you can upgrade it by running:

brew upgrade memo

From binary releases (macOS, Windows, Linux)

memo currently provides pre-built binaries for the following:

  • macOS (Darwin)
  • Windows
  • Linux
  1. Download the appropriate version for your platform from memo releases.

  2. Once downloaded unpack the archive (zip for Windows; tarball for Linux and macOS) to extract the executable binary.

  3. If you want to use from any location you must put the binary executable to your Path or add the directory where is it to the environment variables.

Using Go toolchain

go install github.com/lucasepe/memo@latest

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
internal
app

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL