| name | literate-org |
| description | Create a literate org-mode document with executable bash source blocks (org-babel) so the user can re-run commands/queries themselves in Emacs, then open it via emacsclient. Triggers: /literate-org, 'literate org document', 'org file with runnable blocks', 'org doc I can execute', 'make this verifiable in org', 'create an org document with executable commands' |
| user_invocable | true |
Literate Org Document
Use this skill when the user wants findings, verification steps, or a runbook
packaged as an org-mode file where each command is an executable org-babel
block they can run with C-c C-c in Emacs. Typical case: after an
investigation, turn the evidence trail into a self-verifiable document.
Workflow
-
Collect the commands that support each claim — shell commands, CLI
queries (az, kubectl, ES|QL via a wrapper script, etc.). Only include
commands that were actually run and worked during the session; this is a
reproduction document, not a brainstorm.
-
Write the org file to /tmp/<topic>.org (never the repo root) with this
shape:
#+title: <One-line claim or task>
#+date: <YYYY-MM-DD>
#+property: header-args:bash :results output :exports both
<Intro: the claim under test / purpose, prerequisites (sessions,
VPN, credentials), and "run each block with C-c C-c".>
* <Theme section>
<One or two sentences: what this block shows and the expected outcome.>
#+begin_src bash
<command>
#+end_src
-
Open it non-blocking in the user's running Emacs:
emacsclient --no-wait /tmp/<topic>.org
- Use
dangerouslyDisableSandbox: true — emacsclient connects to a Unix
socket and the sandbox blocks it.
