mercury-uds
v1.0.6
Published
Mercury service running as unix domain socket
Downloads
31
Readme
Table of Contents
mercury-socket is a Unix domain socket server for managing notes using the Mercury framework. It provides IPC commands to create, retrieve, and manage documents and repositories.
## Features
- Create, read, update, and delete notes
- Manage repositories
- Unix socket communication
## Installation
Ensure you’re using a Linux system (this application is designed for Linux only).
Install dependencies:
git clone https://github.com/nexhero/mercury-socket.git cd mercury-socket npm install
## Run the socket daemon Run the server with command-line options:
node index.jsCommand-Line Options
- -s, –socket : Path for the Unix socket (default: /tmp/mercury.sock)
- -d, –dir : Directory to save database (default: ~/.config/mercury/)
- -b, –database : Database name (default: mercurydb.db)
## Use the terminal client
node mercury-cli.js --helpCreate a Note Document
node mercury-cli.js create --title 'demo' --content 'done'## IPC Commands
- `create-note` - Create a new note
- `all-documents` - List all documents
- `document-id` - Get document by ID
- `remove-document` - Remove document by ID
- `get-local-repository` - Get the local repository key
- `get-all-repository` - List all appended repositories
- `append-repository` - Add remote repository
- `remove-repository` - Remove repository by ID
## Notes
- This application is Linux-only
- Default socket path: /tmp/mercury.sock
- Default storage directory: ~/.config/mercury/
