A very simple command line tool for extracting text from Scrivener projects to enable processing by downstream command line utilities.
Scrivener is awesome at many things but automation ain't one of them. This at least makes it easy to surface context text or notes for further processing so, with some ingenuity, you can embed your own markup, todos, etc.
It's intended to be simple and fast and to do one thing well. It's not a replacement project compile (for which see more ambitious projects elsewhere on github...).
scry -h
You can specify either the .scriv bundle or the .scrivx project file.
By default `scry`` extracts all content paragraphs from the draft folder of the project, stripping RTF controls and other artefacts of Scrivener styling and annotation. Which is quite likely a serviceable plain text rendering of your draft work.
Various command line flags are available to select other meaningful bits of text. For example:
Inline annotations and notes from the draft folder:
scry proj.scrivx -i -n
Content from the research folder:
scry proj.scrivx -r
Synopses from the draft folder:
scry proj.scrivx -s
To select all top-level binder folders (except trash), use -A.
To output the items as JSON for further processing (i.e. maintaining
some internal item structure but no binder structure), use -I.
Currently, much of the RTF processing is lifted more or less directly from
https://github.com/compenguy/rtf2text which is Copyright 2019 Will Page <[email protected]>. `