nfa

Crates.ionfa
lib.rsnfa
version0.1.3
created_at2025-02-03 05:58:43.961386+00
updated_at2025-02-03 07:08:38.240883+00
descriptionA small CLI application for taking notes
homepage
repositoryhttps://github.com/curtisknudson/nfa
max_upload_size
id1540145
size31,905
Curtis Knudson (curtisknudson)

documentation

README

NFA (Notes For Anon)

A simple, fast, and efficient command-line note-taking application written in Rust.

Features

  • Create, read, update, and delete notes
  • List all notes
  • Persistent storage using sled database
  • Simple and intuitive command-line interface
  • Secure storage in user's home directory

Installation

Install using cargo:

cargo install nfa

Creating a new note

# Quick note (automatically generates title from content)
nfa "This is a quick note"

# Structured note (requires both title and content flags)
nfa new -t "My Title" -c "This is the content"

Listing all notes

nfa list

Showing a specific note

nfa show <note-id>

Updating a note

nfa update --id <note-id> --title "New Title" --content "Updated content"

Deleting a note

nfa delete <note-id>

Storage

Notes are stored in ~/.nfa/ directory using the sled database engine.

Development

Prerequisites

  • Rust 1.56 or higher
  • Cargo

Building from source

git clone https://github.com/curtisknudson/nfa
cd nfa
cargo build --release

Running tests

cargo test

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Author

Curtis Knudson

Commit count: 10

cargo fmt