Offliner - Your Personal Offline Knowledge Vault

Offliner is a simple and powerful command-line tool built with Go that allows you to store, search, and manage knowledge, notes, and reference data completely offline. Your data is stored in a local database, ensuring it's always available, private, and secure, without needing an internet connection.

Features

• Fully Offline: No internet connection required. All data is stored locally.
• Simple CLI Interface: Easy-to-use commands for managing your knowledge base.
• Cross-Platform: Build and run on Windows, macOS, and Linux.
• Local Database: Uses BoltDB for fast and reliable local storage.
• Tagging: Organize your entries with comma-separated tags.
• Import/Export: Easily back up and restore your data to and from JSON files.
• Pretty Output: Color-coded output for better readability.

Installation

You can download the latest pre-compiled binary for your operating system from the GitHub Releases page.

1. Go to the Releases page.
2. Download the archive (.zip for Windows, .tar.gz for macOS/Linux) that matches your system.
3. Extract the archive. You will find an executable file named offliner (or offliner.exe on Windows).
4. Move this executable to a directory that is in your system's PATH (e.g., /usr/local/bin on macOS/Linux, or a custom folder you've added to the PATH on Windows). This makes the command available from anywhere in your terminal.

Usage

Here are the available commands and how to use them.

add

Add a new knowledge entry.

offliner add "My Entry Title" "This is the content of my entry." --tags "go,cli,notes"

list

List all stored entries.

offliner list

search

Search for entries by a keyword in the title or content.

offliner search "keyword"

view

View the full content of a specific entry by its ID.

offliner view <ID>

delete

Delete an entry by its ID.

offliner delete <ID>

export

Export all entries to a JSON file for backup.

offliner export my_knowledge_base.json

import

Import entries from a JSON file.

offliner import my_knowledge_base.json

Building from Source

If you want to build the application yourself, you'll need to have Go installed.

1. Clone the repository:

   git clone https://github.com/YOUR_USERNAME/offliner.git
   cd offliner

2. Tidy the dependencies:

   go mod tidy

3. Run the build script: This will create binaries for Windows, macOS, and Linux in the dist/ directory.

   # On Windows (PowerShell)
   .\build.ps1
   
   # On macOS/Linux (you might need to create a build.sh script)
   # Or build directly:
   go build -o offliner .

---

This README was generated to help you get started. Feel free to edit and improve it!