changelog shortlog graph tags branches changeset files revisions annotate raw help

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

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