scimax.email

• Type: string

• Default: "" (empty)

• Description: Your email address for Scimax API integrations

This email is used for services that offer better access to identified users. Currently used for:

• OpenAlex: Setting your email gives you access to the polite pool with faster rate limits

{
  "scimax.email": "user@example.com"
}

You can also configure this via the command scimax.ref.configureOpenAlex which provides a quick pick menu for setting both your email and optional API key.

✅ scimax.org.logRepeat

• Type: string

• Values: "false", "time", "note"

• Default: "false"

• Description: Controls logging when repeating tasks cycle back to TODO

When a repeating task (one with a repeater like +1w in its DEADLINE or SCHEDULED timestamp) is marked done, it cycles back to TODO. This setting controls whether to log that completion.

{
  "scimax.org.logRepeat": "time"
}

✅ scimax.org.logIntoDrawer

• Type: boolean or string

• Default: false

• Description: Where to log state changes

{
  "scimax.org.logIntoDrawer": true
}

✅ scimax.journal.directory

• Type: string

• Default: "" (uses ~/scimax-journal)

• Description: Directory where journal files are stored

{
  "scimax.journal.directory": "~/Documents/journal"
}

✅ scimax.journal.format

• Type: string (enum)

• Default: "org"

• Options: "org", "markdown"

• Description: File format for journal entries

{
  "scimax.journal.format": "markdown"
}

✅ scimax.journal.template

• Type: string

• Default: "default"

• Description: Template name for new journal entries. Create custom templates in your journal directory.

{
  "scimax.journal.template": "daily-standup"
}

✅ scimax.journal.dateFormat

• Type: string

• Default: "YYYY-MM-DD"

• Description: Date format for journal file names using date-fns tokens

• `YYYY-MM-DD' → 2026-01-14

• YYYY/MM/DD → 2026/01/14

• `YYYYMMDD' → 20260114

{
  "scimax.journal.dateFormat": "YYYY/MM/DD"
}

✅ scimax.journal.autoTimestamp

• Type: boolean

• Default: true

• Description: Automatically insert timestamps when creating log entries

{
  "scimax.journal.autoTimestamp": false
}

✅ scimax.journal.weekStartsOn

• Type: string (enum)

• Default: "monday"

• Options: "monday", "sunday"

• Description: First day of the week in calendar view

{
  "scimax.journal.weekStartsOn": "sunday"
}

scimax.db.includeJournal

• Type: boolean

• Default: true

• Description: Include the journal directory in database indexing

scimax.db.includeWorkspace

• Type: boolean

• Default: true

• Description: Include workspace folders in database indexing

scimax.db.includeProjects

• Type: boolean

• Default: true

• Description: Include all scimax projects in database indexing

scimax.db.include

• Type: array of strings

• Default: [ ]

• Description: Additional directories or files to index (supports ~ for home directory)

{
  "scimax.db.include": [
    "~/Documents/notes",
    "~/research",
    "~/teaching/courses"
  ]
}

scimax.db.exclude

• Type: array of strings

• Default: ["**/node_modules/**", "**/.git/**", "**/dist/**", "**/build/**"]

• Description: Patterns or paths to exclude from indexing (globs and absolute paths)

{
  "scimax.db.exclude": [
    "**/node_modules/**",
    "**/.git/**",
    "**/dist/**",
    "**/build/**",
    "**/archive/**",
    "~/notes/scratch.org"
  ]
}

scimax.db.autoIndex

• Type: boolean

• Default: false

• Description: Automatically index workspace files on activation. Warning: Disable for large workspaces to prevent memory issues.

{
  "scimax.db.autoIndex": true
}

scimax.db.embeddingProvider

• Type: string (enum)

• Default: "ollama"

• Options: "none", "ollama"

• Description: Embedding provider for semantic/AI-powered search

{
  "scimax.db.embeddingProvider": "ollama"
}

scimax.db.ollamaUrl

• Type: string

• Default: "http://localhost:11434"

• Description: Ollama API URL for embeddings

{
  "scimax.db.embeddingProvider": "ollama",
  "scimax.db.ollamaUrl": "http://localhost:11434"
}

scimax.db.ollamaModel

• Type: string

• Default: "nomic-embed-text"

• Description: Ollama model name for embeddings. Must be installed in Ollama.

{
  "scimax.db.embeddingProvider": "ollama",
  "scimax.db.ollamaModel": "nomic-embed-text"
}

✅ scimax.db.queryTimeoutMs

• Type: number

• Default: 30000 (30 seconds)

• Range: 5000 - 300000

• Description: Maximum time in milliseconds for database queries. Prevents hung operations.

Increase this value if you have a very large database or slow disk:

{
  "scimax.db.queryTimeoutMs": 60000
}

✅ scimax.db.maxRetryAttempts

• Type: number

• Default: 3

• Range: 1 - 10

• Description: Maximum retry attempts for transient database failures (e.g., database locked, I/O errors).

Uses exponential backoff between retries.

{
  "scimax.db.maxRetryAttempts": 5
}

✅ scimax.db.maxFileSizeMB

• Type: number

• Default: 10

• Range: 1 - 100

• Description: Maximum file size in MB to index. Files larger than this are skipped.

Useful when working with external repositories or collaborator files that may contain large generated files:

{
  "scimax.db.maxFileSizeMB": 20
}

scimax.logLevel

• Type: string

• Default: "info"

• Enum: "debug", "info", "warn", "error"

• Description: Controls the verbosity of logging to the Scimax output channel.

Note: Errors are always logged to the error log regardless of this setting, and a status bar indicator appears when errors occur.

scimax.logMaxSizeKB

• Type: number

• Default: 1024 (1MB)

• Min/Max: 100 - 10240

• Description: Maximum size of each log file in KB before rotation. Logs are written to the extension's storage directory.

scimax.logBackupCount

• Type: number

• Default: 3

• Min/Max: 1 - 10

• Description: Number of rotated log backup files to keep (scimax.log.1, scimax.log.2, etc.). Oldest backup is deleted when limit is reached.

Opening Log Files

Use the command Scimax: Open Log File Directory to open the directory containing log files for debugging.

{
  "scimax.logLevel": "debug",
  "scimax.logMaxSizeKB": 2048,
  "scimax.logBackupCount": 5
}

scimax.literate.pythonPath

• Type: string

• Default: "" (uses system Python)

• Description: Path to Python executable for code block execution

{
  "scimax.literate.pythonPath": "/usr/local/bin/python3"
}

Or with virtual environment:

{
  "scimax.literate.pythonPath": "~/projects/myproject/.venv/bin/python"
}

scimax.literate.jupyterPath

• Type: string

• Default: "" (uses system Jupyter)

• Description: Path to Jupyter executable

{
  "scimax.literate.jupyterPath": "~/anaconda3/bin/jupyter"
}

scimax.ref.bibliographyFiles

• Type: array of strings

• Default: [ ]

• Description: Paths to BibTeX bibliography files

{
  "scimax.ref.bibliographyFiles": [
    "~/Documents/bibliography/main.bib",
    "~/research/papers.bib"
  ]
}

scimax.ref.pdfDirectory

• Type: string

• Default: ""

• Description: Directory containing PDF files for references

{
  "scimax.ref.pdfDirectory": "~/Documents/papers"
}

scimax.ref.notesDirectory

• Type: string

• Default: ""

• Description: Directory for reference notes and annotations

{
  "scimax.ref.notesDirectory": "~/Documents/notes/references"
}

scimax.ref.defaultCiteStyle

• Type: string (enum)

• Default: "cite"

• Options: "cite", "citet", "citep", "citeauthor", "citeyear"

• Description: Default citation style for insertions

{
  "scimax.ref.defaultCiteStyle": "citep"
}

scimax.export.latex.customHeader

• Type: string

• Default: ""

• Description: Custom LaTeX header (preamble) that replaces the auto-generated one. Should include \documentclass through all \usepackage commands.

{
  "scimax.export.latex.customHeader": "\\documentclass[11pt]{article}\n\\usepackage[utf8]{inputenc}\n\\usepackage{graphicx}\n\\usepackage{amsmath}\n\\usepackage[margin1in]{geometry}"
}

scimax.export.latex.documentClass

• Type: string

• Default: "article"

• Description: Default LaTeX document class. Can be overridden by #+LATEX_CLASS: in the document.

{
  "scimax.export.latex.documentClass": "report"
}

scimax.export.latex.classOptions

• Type: string

• Default: "12pt,letterpaper"

• Description: Default LaTeX class options. Can be overridden by #+LATEX_CLASS_OPTIONS: in the document.

{
  "scimax.export.latex.classOptions": "11pt,a4paper,twoside"
}

scimax.export.latex.defaultPreamble

• Type: string

• Default: Standard academic packages (inputenc, graphicx, amsmath, etc.)

• Description: Default LaTeX preamble packages. Can be extended by #+LATEX_HEADER: in the document.

{
  "scimax.export.latex.defaultPreamble": "\\usepackage[utf8]{inputenc}\n\\usepackage{graphicx}\n\\usepackage{amsmath}"
}

scimax.export.pdf.compiler

• Type: string (enum)

• Default: "latexmk-lualatex"

• Options: "latexmk-lualatex", "latexmk-pdflatex", "latexmk-xelatex", "lualatex", "pdflatex", "xelatex"

• Description: LaTeX compiler to use for PDF generation

{
  "scimax.export.pdf.compiler": "latexmk-xelatex"
}

scimax.export.pdf.bibtexCommand

• Type: string (enum)

• Default: "bibtex"

• Options: "biber", "bibtex"

• Description: Bibliography processor (only used when not using latexmk)

{
  "scimax.export.pdf.bibtexCommand": "biber"
}

scimax.export.pdf.shellEscape

• Type: string (enum)

• Default: "restricted"

• Options: "restricted", "full", "disabled"

• Description: Shell escape mode for LaTeX compilation

{
  "scimax.export.pdf.shellEscape": "full"
}

scimax.export.pdf.extraArgs

• Type: string

• Default: ""

• Description: Extra arguments to pass to the LaTeX compiler

{
  "scimax.export.pdf.extraArgs": "-synctex=1"
}

scimax.export.pdf.openLogOnError

• Type: boolean

• Default: true

• Description: Automatically open the log file when PDF compilation fails

scimax.export.pdf.cleanAuxFiles

• Type: boolean

• Default: true

• Description: Clean up auxiliary files (.aux, .bbl, .blg, etc.) after successful compilation

scimax.latexPreview.enabled

• Type: boolean

• Default: true

• Description: Enable LaTeX equation preview on hover

{
  "scimax.latexPreview.enabled": true
}

scimax.latexPreview.cacheEnabled

• Type: boolean

• Default: true

• Description: Cache rendered equations for faster hover responses

{
  "scimax.latexPreview.cacheEnabled": true
}

scimax.latexPreview.darkModeAware

• Type: boolean

• Default: true

• Description: Automatically adjust equation rendering for dark/light themes

{
  "scimax.latexPreview.darkModeAware": true
}

scimax.latexLivePreview.buildOnSave

• Type: boolean

• Default: true

• Description: Automatically rebuild PDF when the org file is saved

{
  "scimax.latexLivePreview.buildOnSave": true
}

scimax.latexLivePreview.buildOnIdle

• Type: boolean

• Default: false

• Description: Automatically rebuild PDF after idle period (no typing)

{
  "scimax.latexLivePreview.buildOnIdle": true,
  "scimax.latexLivePreview.idleDelay": 3000
}

scimax.latexLivePreview.idleDelay

• Type: number

• Default: 2000

• Description: Delay in milliseconds before idle build triggers

{
  "scimax.latexLivePreview.buildOnIdle": true,
  "scimax.latexLivePreview.idleDelay": 5000
}

scimax.latexLivePreview.compiler

• Type: string (enum)

• Default: "pdflatex"

• Options: "pdflatex", "xelatex", "lualatex"

• Description: LaTeX compiler to use

{
  "scimax.latexLivePreview.compiler": "xelatex"
}

scimax.latexLivePreview.useLatexmk

• Type: boolean

• Default: true

• Description: Use latexmk for smart incremental builds (recommended). Automatically handles multiple passes for references, bibliography, etc.

{
  "scimax.latexLivePreview.useLatexmk": true
}

scimax.notebook.directory

• Type: string

• Default: ""

• Description: Default parent directory for new notebooks

{
  "scimax.notebook.directory": "~/projects"
}

scimax.notebook.defaultTemplate

• Type: string (enum)

• Default: "research"

• Options: "empty", "research", "software", "notes"

• Description: Default template for new notebooks

{
  "scimax.notebook.defaultTemplate": "software"
}

scimax.notebook.autoDetect

• Type: boolean

• Default: true

• Description: Automatically detect and track projects in workspace

{
  "scimax.notebook.autoDetect": false
}

scimax.hydra.showKeyHints

• Type: boolean

• Default: true

• Description: Show keyboard shortcuts inline with menu items

{
  "scimax.hydra.showKeyHints": true
}

scimax.hydra.singleKeySelection

• Type: boolean

• Default: true

• Description: Select menu items with a single keypress (no Enter needed)

{
  "scimax.hydra.singleKeySelection": true
}

scimax.hydra.dimNonMatching

• Type: boolean

• Default: true

• Description: Dim menu items that don't match the current filter

{
  "scimax.hydra.dimNonMatching": true
}

scimax.hydra.sortByKey

• Type: boolean

• Default: false

• Description: Sort menu items by their keyboard shortcut instead of logical grouping

{
  "scimax.hydra.sortByKey": false
}

scimax.speedCommands.enabled

• Type: boolean

• Default: true

• Description: Enable org-mode speed commands (single-key shortcuts at beginning of headings)

When enabled, you can use single-key shortcuts (like `n', `p', `u') when the cursor is at the beginning of a heading line.

{
  "scimax.speedCommands.enabled": true
}

scimax.agenda.includeJournal

• Type: boolean

• Default: true

• Description: Include the journal directory in agenda scanning

When enabled, the journal directory (from scimax.journal.directory) is automatically included in agenda scanning. Disable this if you don't want journal entries in your agenda.

scimax.agenda.includeWorkspace

• Type: boolean

• Default: true

• Description: Include workspace folders in agenda scanning

scimax.agenda.includeProjects

• Type: boolean

• Default: true

• Description: Include all scimax projects in agenda scanning

When enabled, all projects registered with scimax projectile are included in agenda scanning. This is useful because projects often contain TODO items and tasks.

scimax.agenda.include

• Type: array of strings

• Default: [ ] (empty)

• Description: Additional directories or files to include in the agenda (supports ~ for home directory)

{
  "scimax.agenda.include": [
    "~/Documents/org",
    "~/work/projects"
  ]
}

scimax.agenda.exclude

• Type: array of strings

• Default: ["**/node_modules/**", "**/.git/**", "**/archive/**"]

• Description: Patterns or paths to exclude from agenda scanning. Supports both glob patterns (containing *) and absolute paths.

{
  "scimax.agenda.exclude": [
    "**/node_modules/**",
    "**/.git/**",
    "**/archive/**",
    "~/org/scratch.org"
  ]
}

scimax.agenda.defaultSpan

• Type: number

• Default: 7

• Description: Default number of days to show in agenda view

{
  "scimax.agenda.defaultSpan": 14
}

scimax.agenda.showDone

• Type: boolean

• Default: false

• Description: Show completed (DONE) items in agenda view

{
  "scimax.agenda.showDone": true
}

scimax.agenda.showHabits

• Type: boolean

• Default: true

• Description: Show items tagged with :HABIT:

{
  "scimax.agenda.showHabits": false
}

scimax.agenda.todoStates

• Type: array of strings

• Default: ["TODO", "NEXT", "WAITING"]

• Description: Active TODO states to show in TODO list

{
  "scimax.agenda.todoStates": [
    "TODO",
    "NEXT",
    "IN-PROGRESS",
    "WAITING",
    "SOMEDAY"
  ]
}

scimax.agenda.doneStates

• Type: array of strings

• Default: ["DONE", "CANCELLED"]

• Description: Completed TODO states

{
  "scimax.agenda.doneStates": [
    "DONE",
    "CANCELLED",
    "DEFERRED",
    "ARCHIVED"
  ]
}

scimax.imageOverlays.enabled

• Type: boolean

• Default: true

• Description: Enable inline image thumbnails in org-mode files

{
  "scimax.imageOverlays.enabled": true
}

scimax.imageOverlays.maxWidth

• Type: number

• Default: 96

• Description: Maximum width in pixels for thumbnail icons

{
  "scimax.imageOverlays.maxWidth": 128
}

scimax.imageOverlays.maxHeight

• Type: number

• Default: 96

• Description: Maximum height in pixels for thumbnail icons

{
  "scimax.imageOverlays.maxHeight": 128
}

scimax.imageOverlays.renderMode

• Type: string (enum)

• Default: "gutter"

• Options: "gutter", "after", "both"

• Description: Where to display image thumbnails

{
  "scimax.imageOverlays.renderMode": "both"
}

scimax.imageOverlays.onlyWhenCursorNotInLink

• Type: boolean

• Default: true

• Description: Hide overlay when cursor is inside the image link (prevents interference with editing)

{
  "scimax.imageOverlays.onlyWhenCursorNotInLink": true
}

scimax.imageOverlays.excludePatterns

• Type: array of strings

• Default: [ ]

• Description: Regex patterns for image paths to exclude from overlays

{
  "scimax.imageOverlays.excludePatterns": [
    ".*\\.ico$",
    ".*thumbnail.*"
  ]
}

scimax.imageOverlays.maxOverlaysPerDocument

• Type: number

• Default: 200

• Description: Maximum number of image overlays to display per document (prevents performance issues)

{
  "scimax.imageOverlays.maxOverlaysPerDocument": 500
}

scimax.imageOverlays.showDimensions

• Type: boolean

• Default: true

• Description: Show image dimensions in the after-content decoration

{
  "scimax.imageOverlays.showDimensions": false
}

scimax.imageOverlays.cacheEnabled

• Type: boolean

• Default: true

• Description: Cache generated thumbnails for faster loading

{
  "scimax.imageOverlays.cacheEnabled": true
}

scimax.capture.templates

• Type: array of objects

• Default: [ ]

• Description: Capture templates for quick note-taking. Each template has:

• %^{prompt}: Prompt for input

• %t: Current timestamp

• %T: Current timestamp with time

• %i: Initial content (selected text)

• %a: Link to current location

• %?: Cursor position after insertion

{
  "scimax.capture.templates": [
    {
      "key": "t",
      "name": "Task",
      "type": "entry",
      "file": "~/org/todo.org",
      "headline": "Tasks",
      "template": "* TODO %^{Task}\n  SCHEDULED: %t\n  %?"
    },
    {
      "key": "n",
      "name": "Note",
      "type": "entry",
      "file": "~/org/notes.org",
      "datetree": true,
      "template": "* %^{Title}\n  %T\n\n  %?"
    },
    {
      "key": "m",
      "name": "Meeting",
      "type": "entry",
      "file": "~/org/meetings.org",
      "template": "* Meeting: %^{Topic}\n  %T\n\n  Attendees: %^{Attendees}\n\n  Notes:\n  %?"
    }
  ]
}

scimax.capture.defaultFile

• Type: string

• Default: "~/org/notes.org"

• Description: Default file for captures when no target file is specified in template

{
  "scimax.capture.defaultFile": "~/Documents/inbox.org"
}

scimax.capture.datetreeFormat

• Type: string (enum)

• Default: "day"

• Options: "day", "week", "month"

• Description: Granularity of datetree entries

{
  "scimax.capture.datetreeFormat": "week"
}

scimax.capture.autoSave

• Type: boolean

• Default: true

• Description: Automatically save the file after capture

{
  "scimax.capture.autoSave": true
}