changelog shortlog graph tags branches changeset files revisions annotate raw help

Mercurial > org > docs / core/app/organ.org

changeset 13: 26a97fc6dcda
parent: d0a90a87b824
author: ellis <ellis@rwest.io>
date: Wed, 13 Dec 2023 20:01:01 -0500
permissions: -rw-r--r--
description: doc updates 
     1 {{{header(organ,Richard Westhaver,ellis@rwest.io)}}}
     2 
     3 The =organ= CLI tool is used to manipulate [[https://orgmode.org/][Org Mode]] files.
     4 
     5 * Overview
     6 =Org-mode= the application depends on Emacs (it's written in Emacs
     7 Lisp) but that doesn't mean we need to. To solve the issue of
     8 interoperability between different systems, we are developing a tool
     9 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
    10 Org documents that doesn't depend on GNU Emacs.
    11 
    12 If we were designing a /personal/ note-taking system, I would argue
    13 that we don't need this tool. The problem is it's /not/ personal - we
    14 have a much wider intended audience and need to present information in
    15 many different ways. This means thinking about hundreds to thousands
    16 of documents instead of tens, about processing those documents into a
    17 full-text search database, and reducing cost along the way.
    18 
    19 Emacs can do all of these things, but do you really want it to?
    20 
    21 * help
    22 #+begin_src shell :results pp replace
    23 organ -h
    24 #+end_src
    25 
    26 #+RESULTS:
    27 #+begin_example
    28 organ v0.0.1
    29   usage: organ [global] <command> [<arg>]
    30 
    31   org-mode toolbox
    32   options:
    33      -l/--level* :  set the log level
    34      -h/--help* :  print help
    35      -v/--version* :  print version
    36   commands:
    37     inspect  :  inspect an org file
    38      -i/--input  :  path to org file
    39     
    40     show  :  display local org info
    41     
    42     parse  
    43      -i/--input  :  input source
    44      -o/--output  :  compiler output
    45     
    46 #+end_example