Document Management

Manage document metadata, 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>

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

Examples

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

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

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 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 Shadowdark RPG rules and mechanics"
jime docs describe "#1" "Session notes from January 15, 2024"

docs remove

Remove a document's registry entry, reverting it to default behavior (scope all, no category, no description). This does not delete the document's chunks from the vector store.

jime docs remove <file-or-id>

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

Note

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