Skip to content

Campaign Management

Manage players, campaigns, and characters.

player

player add

Register a new player.

jime player add <name>
Argument Type Description
<name> string The player's display name

player list

List all registered players.

jime player list

campaign

campaign add

Create a new campaign.

jime campaign add <name> [options]
Argument / Option Type Required Description
<name> string Yes Campaign name
--description, -d string No Description of the campaign

campaign list

List all campaigns.

jime campaign list

Link an ingested document to the broad campaign corpus. This association says the document belongs to the campaign; recap generation now uses first-class campaign sessions below for chronology and source selection.

jime campaign link-document <campaign> <source>

campaign session add

Create a first-class campaign session. The date must be in YYYY-MM-DD format.

jime campaign session add <campaign> --date YYYY-MM-DD [--number N] [--title TITLE]

campaign session list

List sessions for a campaign in chronological order.

jime campaign session list <campaign>

Attach an ingested document to a session. Passing --primary marks it as the default source for recap drafts. Linking a session document also ensures the broader campaign link-document association exists.

jime campaign session link-document <session-id> <source> [--role ROLE] [--primary]

character

character add

Create a new character assigned to a player.

jime character add <name> --player <player-name> [options]
Argument / Option Type Required Description
<name> string Yes Character name
--player, -p string Yes Player name (must already exist)
--campaign, -c string No Campaign name
--notes, -n string No Free-form notes about the character

character list

List characters with optional filters.

jime character list [options]
Option Type Description
--player, -p string Filter by player name
--campaign, -c string Filter by campaign name

Example workflow

Set up a campaign from scratch:

# Register players
jime player add "Alice"
jime player add "Bob"
jime player add "Charlie"

# Create a campaign
jime campaign add "The Lost Tombs" -d "Treasure hunting in ancient ruins"

# Add characters
jime character add "Thorgrim" -p "Alice" -c "The Lost Tombs" -n "Dwarf warrior, level 3"
jime character add "Luna" -p "Bob" -c "The Lost Tombs" -n "Elf ranger"
jime character add "Grub" -p "Charlie" -c "The Lost Tombs" -n "Goblin rogue"

# List everything
jime player list
jime campaign list
jime character list --campaign "The Lost Tombs"

recap

Generate, illustrate, publish, and list password-gated session recaps.

recap draft

Generate a player-safe recap draft from a dated campaign session. If --source is omitted, the session primary source is used.

jime recap draft <session-id> [--source SOURCE]

recap show

Show a generated recap version for DM review before publishing. The output includes the title, status, teaser, body, image prompt seed, alt text, model, and creation time.

jime recap show <version-id>

recap image

Generate one cinematic hero image for a recap version.

jime recap image <version-id>

This command requires both Jime:ImageModelDeployment to point at an Azure OpenAI image deployment such as gpt-image-1 and Jime:StorageEndpoint so the generated bytes can be persisted to Blob Storage.

recap publish

Publish a draft recap version to the shared-password web app.

jime recap publish <version-id>

recap unpublish

Hide a recap from the website.

jime recap unpublish <recap-id>

recap list

List published recaps and their private-preview URLs.

jime recap list

recap versions

List all versions (draft, published, and archived) for a recap, newest first. Use this to discover stranded drafts or audit version history.

jime recap versions <recap-id>