changelog shortlog graph tags branches changeset files revisions annotate raw help

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

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