changelog shortlog graph tags branches changeset files revisions annotate raw help

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

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