CLI Reference
The jime command-line tool is the primary interface for Dungeon Masters to manage their Shadowdark knowledge base. It handles document ingestion, search, chat, and campaign management.
Building and running
Build the solution and run the CLI from the repository root:
Commands
| Command | Description |
|---|---|
ingest |
Ingest a document into the vector store |
list |
List all ingested documents |
search |
Search the knowledge base |
chat |
Interactive RAG-powered chat |
transcribe |
Transcribe audio from Google Drive |
docs |
Manage document metadata and visibility |
player |
Manage players |
campaign |
Manage campaigns |
character |
Manage characters |
Configuration
The CLI reads settings from (in priority order):
- Environment variables with prefix
JIME__ - .NET user secrets (secret ID:
jicklejime-cli) appsettings.json
Set credentials for local development (from the repository root):
dotnet user-secrets set "Jime:AzureOpenAiEndpoint" "https://your-resource.openai.azure.com/" --project src/JickleJime.Cli
dotnet user-secrets set "Jime:PostgresConnectionString" "Host=localhost;Port=5432;Database=jicklejime;Username=jime;Password=jime_dev" --project src/JickleJime.Cli
See the Configuration Reference for all available settings.