changelog shortlog graph tags branches changeset files revisions annotate raw help

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

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