Open a Scrivener project (.scriv folder)

Get the hierarchical structure of the project binder

Read the content of a document. Optionally includes synopsis (index card text).

Write content to an existing document

Create a new document or folder in the project

Move a document to trash

Move a document to a different folder

Rename a document

Search for content across all documents

Read the synopsis (index card text) of a document

Write or update the synopsis (index card text) of a document

Get the list of documents in compile order from the Draft/Manuscript folder. Useful for seeing what will be included in a compile.

Compile the manuscript to a PDF file. Only includes documents marked 'Include in Compile'.

Get word count for a specific document or the entire manuscript

Append content to the end of an existing document without replacing existing content

Set whether a document should be included in compile

Read the notes (inspector notes) for a document

Write or update the notes (inspector notes) for a document

Read multiple documents at once. More efficient than multiple read_document calls.

Search for a term and return matches with surrounding paragraphs for context

Find all sentences mentioning a term across the manuscript. Useful for checking character/place consistency.

Find all descriptive sentences for a term (sentences with 'was', 'had', 'looked', etc.). Helps identify inconsistent descriptions.