Metadata-Version: 2.4
Name: nnote
Version: 0.3.0
Summary: cli note taker
Author: Agil Mammadov
Author-email: Agil Mammadov <mammadovagil@tutamail.com>
License-Expression: GPL-3.0-or-later
Requires-Dist: click>=8.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: shellingham>=1.5
Requires-Dist: pytest>=8.0 ; extra == 'dev'
Requires-Dist: furo>=2024.0 ; extra == 'docs'
Requires-Dist: sphinx>=7.0 ; extra == 'docs'
Requires-Python: >=3.10
Project-URL: Documentation, https://stiermid.github.io/nnote
Project-URL: Repository, https://github.com/stiermid/nnote
Provides-Extra: dev
Provides-Extra: docs
Description-Content-Type: text/markdown

# nnote

[![PyPI downloads](https://img.shields.io/pypi/dm/nnote.svg)](https://pypi.org/project/nnote/)
[![Github commits (since latest release)](https://img.shields.io/github/commits-since/stiermid/nnote/latest.svg)](https://github.com/stiermid/nnote)

<a href="https://repology.org/project/nnote/related">
	<img src="https://repology.org/badge/vertical-allrepos/nnote.svg" alt="Packaging status" align="right">
</a>

A minimal CLI note-taking tool. Notes are plain files stored in a directory of your choice.

## Installation

**Arch Linux (AUR)**

```bash
yay -S nnote
```

Or with any other AUR helper, or manually via `makepkg`.

**From source**

```bash
pip install -e .
```

## Setup

```bash
nnote init
```

Prompts for a notes directory (default: `~/nnotes`) and a default editor. Config is saved to `~/.config/nnote/config.yaml`. If `$EDITOR` is set in your environment, it will be used as the editor default.

## Documentation

Full documentation is published at **https://stiermid.github.io/nnote/**.

Command reference (also browsable in this repo):

- [`new`](docs/commands/new.rst) — create a note (or a subdirectory)
- [`view`](docs/commands/view.rst) — print a note to stdout
- [`edit`](docs/commands/edit.rst) — open an existing note in the editor
- [`list`](docs/commands/list.rst) — display notes as a tree
- [`drop`](docs/commands/drop.rst) — remove a note or directory
- [`move`](docs/commands/move.rst) — rename or relocate a note
- [`backup`](docs/commands/backup.rst) — export notes to a `.tar.gz` archive
- [`search`](docs/commands/search.rst) — search notes by title and content

Config file format: [docs/configuration.rst](docs/configuration.rst).

## License

This project is licensed under the GNU General Public License v3.0 or later. See [LICENSE](LICENSE) for details.
