nao🍵

Take notes without worrying about the path where the file is

Features

• You know terminal, you know nao
• No need to specify a path to access a note
• Edit from terminal editor
• One writer and multiple readers by note

Demo

Install

# Requires go 1.18>=
$ go install github.com/luisnquin/nao/v3/cmd/nao@v3.3.0

Completions

Add the line(s) of your corresponding shell to your .zshrc|.bashrc file

# bash
source <(nao completion bash)

# zsh
source <(nao completion zsh)
compdef _nao nao

Configuration

Nao keeps its configuration file inside of a nao directory and the location depends on your operating system. This program leverages XDG to load its various configurations files. For information on the default locations for your OS please see this link.

Unix	macOS	Windows
~/.config/nao/config.yml	~/Library/Application Support/nao/config.yml	%LOCALAPPDATA%\nao\config.yml

# yaml-language-server: $schema=https://raw.githubusercontent.com/luisnquin/nao/main/docs/config.schema

# The terminal editor
editor:
    # Possible values: nano, vim, nvim
    name: nano
    extraArgs: []
# Possible values:
# - default
# - beach-day
# - party
# - nord
# - no-theme
# - rose-pine
# - rose-pine-dawn
# - rose-pine-moon
theme: default
# In case an already open note is being called, the program can act in two ways
# 1. Blocking access until the other note is closed
# 2. Opening the note but in read-only mode for the selected editor
#
# The reason for this feature is to avoid overwriting issues
readOnlyOnConflict: false

Why did I do this?

No one has been able to do this, so here we are

License

MIT