Document Management

Manage documents, interpretation versions, categories, visibility scopes, and descriptions using the jime docs subcommands.

docs read

Display the full text of a document from its active interpretation. Useful for viewing complete session transcripts or full rulebook content.

jime docs read <file-or-id>
jime docs read <file-or-id> --interpretation <interpretation-id>

Argument	Type	Description
`<file-or-id>`	string	Source filename or `#N` document ID

Option	Type	Description
`--interpretation`, `-i`	UUID	Read a specific interpretation instead of the active one

Examples

# Read a session transcript
jime docs read "SD-SoS-Sesh00-20260317.mp3"

# Read by document ID
jime docs read "#4"

# Inspect an inactive interpretation before activating it
jime docs read "#4" --interpretation "11111111-1111-1111-1111-111111111111"

Tip

Pipe the output to a pager or file for long documents: jime docs read "#4" | less

docs list

List all documents in the registry with their metadata and chunk counts.

jime docs list

Displays a table with:

Column	Description
ID	Document identifier (`#N` format)
File	Source filename
Category	Assigned category
Scope	Visibility: `all`, `dm-only`, or `disabled`
Description	Human-readable description
Chunks	Number of stored chunks
Updated	Last registry update

docs interpretations list

List all interpretation versions for a document. Re-ingesting a document creates a new interpretation and makes it active; older interpretations and chunks are preserved until you remove them.

jime docs interpretations list <file-or-id>

Argument	Type	Description
`<file-or-id>`	string	Source filename or `#N` document ID

The table shows each interpretation ID, whether it is active, whether full text is stored, chunk count, and creation time. Search and jime docs read <file-or-id> use only the active interpretation.

docs interpretations activate

Make an existing interpretation active for search and default document reads. Activating one interpretation deactivates all other interpretations for that document.

jime docs interpretations activate <file-or-id> <interpretation-id>

Argument	Type	Description
`<file-or-id>`	string	Source filename or `#N` document ID
`<interpretation-id>`	UUID	Interpretation ID from `docs interpretations list`

docs interpretations remove

Delete one interpretation and only the chunks attached to that interpretation.

jime docs interpretations remove <file-or-id> <interpretation-id>

Argument	Type	Description
`<file-or-id>`	string	Source filename or `#N` document ID
`<interpretation-id>`	UUID	Interpretation ID from `docs interpretations list`

Warning

Removing the active interpretation is allowed. If no other interpretation is activated afterward, the document remains registered but has no active version, so it will not contribute search results and jime docs read <file-or-id> will report no active full text.

docs set-scope

Set the visibility scope of a document, controlling which audiences can see its content in search results.

jime docs set-scope <file-or-id> <scope>

Argument	Type	Description
`<file-or-id>`	string	Source filename or `#N` document ID
`<scope>`	string	Visibility scope

Scopes

Scope	Who can see it	Use case
`all`	Everyone (players and DMs)	Rulebooks, public campaign info
`dm-only`	DM only	Monster stats, secret plot notes, session prep
`disabled`	No one	Temporarily hidden documents

Examples

# Make a rulebook visible to players
jime docs set-scope "rulebook.pdf" "all"

# Hide monster stats from players
jime docs set-scope "monsters.pdf" "dm-only"

# Temporarily disable a document
jime docs set-scope "#3" "disabled"

docs set-category

Assign a category to a document for organizing and filtering.

jime docs set-category <file-or-id> <category>

Argument	Type	Description
`<file-or-id>`	string	Source filename or `#N` document ID
`<category>`	string	Category name (free-form)

Categories are free-form labels — use whatever makes sense for your campaign. Common examples: rules, sessions, npcs, maps, house-rules.

Examples

jime docs set-category "rulebook.pdf" "rules"
jime docs set-category "#2" "sessions"

docs remove-category

Remove the category from a document, leaving it uncategorized.

jime docs remove-category <file-or-id>

Argument	Type	Description
`<file-or-id>`	string	Source filename or `#N` document ID

docs describe

Set a human-readable description for a document.

jime docs describe <file-or-id> <description>

Argument	Type	Description
`<file-or-id>`	string	Source filename or `#N` document ID
`<description>`	string	Description text

Examples

jime docs describe "rulebook.pdf" "Core rules and mechanics"
jime docs describe "#1" "Session notes from January 15, 2024"

docs remove

Delete a document, all of its interpretations, and all chunks attached to those interpretations.

jime docs remove <file-or-id>

Argument	Type	Description
`<file-or-id>`	string	Source filename or `#N` document ID

Warning

This is a hard delete from the local corpus. Use docs interpretations remove when you only want to delete one interpretation version while keeping the document and other interpretations.

Note

The #N document ID syntax works across all docs subcommands. Use jime docs list to find document IDs.