1.1--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2+++ b/core/app/organ.org	Sat Sep 07 22:34:47 2024 -0400
     1.3@@ -0,0 +1,51 @@
     1.4+#+title: organ
     1.5+#+author: Richard Westhaver
     1.6+#+setupfile: ../../../clean.theme
     1.7+#+OPTIONS: num:nil
     1.8+
     1.9+The =organ= CLI tool is used to manipulate [[https://orgmode.org/][Org Mode]] files.
    1.10+
    1.11+* Overview
    1.12+:PROPERTIES:
    1.13+:ID:       ff9147a1-da33-46b1-b398-b87049e6c197
    1.14+:END:
    1.15+=Org-mode= the application depends on Emacs (it's written in Emacs
    1.16+Lisp) but that doesn't mean we need to. To solve the issue of
    1.17+interoperability between different systems, we are developing a tool
    1.18+called [[https://lab.rwest.io/comp/core/-/tree/branch/default/lisp/lib/organ][organ]]. The purpose of =organ= is to provide an external API for
    1.19+Org documents that doesn't depend on GNU Emacs.
    1.20+
    1.21+If we were designing a /personal/ note-taking system, I would argue
    1.22+that we don't need this tool. The problem is it's /not/ personal - we
    1.23+have a much wider intended audience and need to present information in
    1.24+many different ways. This means thinking about hundreds to thousands
    1.25+of documents instead of tens, about processing those documents into a
    1.26+full-text search database, and reducing cost along the way.
    1.27+
    1.28+Emacs can do all of these things, but do you really want it to?
    1.29+
    1.30+* help
    1.31+:PROPERTIES:
    1.32+:ID:       36603658-8f85-435c-b6b3-f8da47237f5c
    1.33+:END:
    1.34+#+begin_src shell :results pp replace :exports both
    1.35+organ -h
    1.36+#+end_src
    1.37+
    1.38+#+RESULTS:
    1.39+#+begin_example
    1.40+organ v0.0.1 --- org-mode toolbox
    1.41+
    1.42+  usage: organ [global] <command> [<arg>]
    1.43+
    1.44+options:
    1.45+  -l/--level* :  set the log level
    1.46+  -h/--help* :  print help
    1.47+  -v/--version* :  print version
    1.48+
    1.49+commands:
    1.50+  inspect : inspect an org file
    1.51+  show : display local org info
    1.52+  describe : describe local org info
    1.53+  parse 
    1.54+#+end_example