:PROPERTIES: :ID: orgnote-cli :END:

#+html: #+html: #+html: #+html:  

#+TITLE: ✨ Org Note CLI

#+html: #+html: #+html: #+html: #+html: #+html: #+html: #+html: #+html: #+html:

• Introduction NPM binary script for synchronising and publishing notes from org roam. Closely related to the Org Note project. WARNING: This package doesn't provide a way to resolve conflicts and doesn't use CRDT yet! Be careful, and don't forget to backup your notes!
• Connected links

• [[https://github.com/Artawower/orgnote][Org Note main repo.]]

• ️ Install #+BEGIN_SRC bash npm install -g orgnote-cli #+END_SRC

• Usage ** Configuration Create ~~/.config/orgnote/config.json~ with next schema: #+BEGIN_SRC typescript export interface OrgNotePublishedConfig { remoteAddress: string; token: string; rootFolder: string; version: string; name?: string; debug?: boolean; logPath?: string; backupCount?: number; backupDir?: string; encrypt?: 'gpgPassword' | 'gpgKeys' | 'disabled';

  gpgPassword?: string; gpgPublicKeyPath?: string; gpgPrivateKeyPath?: string; gpgPrivateKeyPassphrase?: string;

}

#+END_SRC Example #+BEGIN_SRC json [ { "name": "User 1", "remoteAddress": "http://localhost:8000/v1", "token": "289cd69d-e9fb-4ad0-a907-d44e46cac786", "rootFolder": "~/tmp/org-roam", "logPath": "~/tmp/logs/orgnote.log", "encrypt": "gpgPassword", "gpgPassword": "password" }, { "name": "Local development", "remoteAddress": "http://localhost:8000/v1", "token": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "rootFolder": "~/some/path/", "backupDir": "/tmp/orgnote/backups", "backupCount": 2 }, { "name": "Remote development", "remoteAddress": "http:///api/v1", "token": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" "rootFolder": "~/some/path/" }, ] #+END_SRC

** Available commands

• ~publish~ - publish single note ~orgnote-cli publish --remote-address http://url-here/ --token api-token /file/path~
• ~collect~ - forces loading of all notes from a remote resource. WARNING: this operation could override your local notes! /Unsupported yet/
• orces publishing of all notes from the root folder. WARNING: this operation could overwrite remote notes.
• ~sync~ - syncs all notes from the root folder into the remote service and vice versa. WARNING: this operation could override local and remote notes depens on timezone.

** Available flags ~--debug~ enable additional info logging messages ~--force~ clear local cache and last sync time

• Encryption. For exporting keys use next commands ([[https://www.gnupg.org/documentation/][check official doc]]). Make sure you have orgnote folder inside your =.config= #+BEGIN_SRC bash mkdir -p ~/.config/orgnote #+END_SRC

Export public key: #+BEGIN_SRC bash gpg --armor --export > ~/.config/orgnote/public.key #+END_SRC

Export private key #+BEGIN_SRC bash gpg --armor --export-secret-key > ~/.config/orgnote/private.key #+END_SRC

• 🍩 Contribute guide Any contribution is very much appreciated! Please read the [[./CONTRIBUTE.org][style guide]] before contributing to avoid misunderstandings! I would also appreciate it if you would consider becoming my [[https://www.patreon.com/artawower][patron]]