https://github.com/luisnquin/nao

Take notes without worrying about the path where the file is 🌂
https://github.com/luisnquin/nao

cli drunk ls note-taking notes terminal-editor

Last synced: over 1 year ago
JSON representation

Take notes without worrying about the path where the file is 🌂

• Host: GitHub
• URL: https://github.com/luisnquin/nao
• Owner: luisnquin
• License: mit
• Created: 2022-06-19T19:59:18.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-01T00:34:50.000Z (over 1 year ago)
• Last Synced: 2025-02-28T12:56:17.574Z (over 1 year ago)
• Topics: cli, drunk, ls, note-taking, notes, terminal-editor
• Language: Go
• Homepage:
• Size: 112 MB
• Stars: 20
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: .github/README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          

nao🍵




[![GitHub go.mod Go version of a Go module](https://img.shields.io/github/go-mod/go-version/luisnquin/nao)](https://github.com/luisnquin/nao)

[![CI](https://github.com/luisnquin/nao/actions/workflows/go.yml/badge.svg)](https://github.com/luisnquin/nao/actions/workflows/go.yml)

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)

[![GitHub stars](https://img.shields.io/github/stars/luisnquin/nao.svg?style=social&label=Star&maxAge=2592000)](https://github.com/luisnquin/nao)

[![Built with Nix](https://img.shields.io/static/v1?logo=nixos&logoColor=white&label=&message=Built%20with%20Nix&color=41439a)](https://github.com/luisnquin/nao)

Take notes without worrying about the path where the file is



## Features

- [x] You know terminal, you know nao

- [x] No need to specify a path to access a note

- [x] Edit from terminal editor

- [x] One writer and multiple readers by note

## Demo

[![asciicast](https://asciinema.org/a/9DETM5MtJaA9d0emviPvz1n0s.svg)](https://asciinema.org/a/9DETM5MtJaA9d0emviPvz1n0s)

## Install

```bash

# 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

# 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](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) to load its various configurations files. For information on the default locations for your OS please see [this link](https://github.com/adrg/xdg/blob/master/README.md).

  | Unix            | macOS                              | Windows               |

  |-----------------|------------------------------------|-----------------------|

  | `~/.config/nao/config.yml` | `~/Library/Application Support/nao/config.yml` | `%LOCALAPPDATA%\nao\config.yml`  |

```yaml

# 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](https://raw.githubusercontent.com/luisnquin/nao/main/LICENSE)