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

Example:

{
  "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.

Example:

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

File-level override: Use #+STARTUP: logrepeat, #+STARTUP: lognoterepeat, or #+STARTUP: nologrepeat

Heading-level override: Add :LOGGING: logrepeat property

✅ scimax.org.logIntoDrawer

• Type: boolean or string

• Default: false

• Description: Where to log state changes

Example:

{
  "scimax.org.logIntoDrawer": true
}

File-level override: Use #+STARTUP: logdrawer or #+STARTUP: nologdrawer

✅ scimax.journal.directory

• Type: string

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

• Description: Directory where journal files are stored

Example:

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

✅ scimax.journal.format

• Type: string (enum)

• Default: "org"

• Options: "org", "markdown"

• Description: File format for journal entries

Example:

{
  "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.

Example:

{
  "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

Common formats:

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

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

• `YYYYMMDD' → 20260114

Example:

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

✅ scimax.journal.autoTimestamp

• Type: boolean

• Default: true

• Description: Automatically insert timestamps when creating log entries

Example:

{
  "scimax.journal.autoTimestamp": false
}

✅ scimax.journal.weekStartsOn

• Type: string (enum)

• Default: "monday"

• Options: "monday", "sunday"

• Description: First day of the week in calendar view

Example:

{
  "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)

Example:

{
  "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)

Example:

{
  "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.

Example:

{
  "scimax.db.autoIndex": true
}

scimax.db.dirsPerSession

• Type: number

• Default: 5

• Description: Number of configured directories to scan per background indexing session. Progress is saved in extension state, so remaining directories are picked up in later sessions. Lower this if activation feels slow with many indexed directories.

Example:

{
  "scimax.db.dirsPerSession": 3
}

✅ scimax.db.checkStaleOnActivation

• Type: boolean

• Default: true

• Description: On activation, check whether any indexed files have changed on disk and show a one-time prompt offering to run Refresh. Useful for catching changes synced from another machine (e.g. Dropbox) while VS Code was closed. Skipped if scimax.db.autoCheckStale is on (which auto-refreshes in the background instead).

Example (disable the prompt):

{
  "scimax.db.checkStaleOnActivation": false
}

scimax.db.embeddingProvider

• Type: string (enum)

• Default: "ollama"

• Options: "none", "ollama"

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

  • none: No semantic search (text-only)

  • ollama: Use local Ollama server (recommended)

Example:

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

scimax.db.ollamaUrl

• Type: string

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

• Description: Ollama API URL for embeddings

Example:

{
  "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.

Example:

{
  "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:

Example:

{
  "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.

Example:

{
  "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:

Example:

{
  "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.

Example:

{
  "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

Example:

{
  "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

Example:

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

scimax.ref.bibliographyFiles

• Type: array of strings

• Default: [ ]

• Description: Paths to BibTeX bibliography files

Example:

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

scimax.ref.pdfDirectory

• Type: string

• Default: ""

• Description: Directory containing PDF files for references

Example:

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

scimax.ref.notesDirectory

• Type: string

• Default: ""

• Description: Directory for reference notes and annotations

Example:

{
  "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

  • cite: Generic citation

  • citet: Textual citation (Author (Year))

  • citep: Parenthetical citation ((Author, Year))

  • citeauthor: Author only

  • citeyear: Year only

Example:

{
  "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.

Example:

{
  "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.

Example:

{
  "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.

Example:

{
  "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.

Example:

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

✅ scimax.export.latex.citeBackend

• Type: string (enum)

• Default: "bibtex"

• Options: "bibtex", "biblatex"

• Description: Backend used when translating org-cite citations ([cite/STYLE/VARIANTS:@key]) into LaTeX.

  • bibtex (default): emits natbib commands -- \citep, \citet, \citealp, \Citet, etc. Use with the standard bibtex/natbib stack.

  • biblatex: emits biblatex commands -- \autocite, \textcite, \Autocite, \fullcite, etc. Requires \usepackage{biblatex} and biber.

A per-document override is also supported via #+cite_export: bibtex or #+cite_export: biblatex. See Export for the full style/variant → command mapping table.

Example:

{
  "scimax.export.latex.citeBackend": "biblatex"
}

⚠️ scimax.export.latexClassExporters

• Type: object (string → string)

• Default: {}

• Description: Makes the ordinary LaTeX/PDF exports (C-c C-e l l, l p, l o) use a custom exporter when the document declares a matching #+LATEX_CLASS. Keys are class names (matched case-insensitively), values are custom exporter ids.

Example:

{
  "scimax.export.latexClassExporters": {
    "cmu-memo": "cmu-memo"
  }
}

A document with #+LATEX_CLASS: cmu-memo then exports through the cmu-memo exporter automatically. Override per file with #+EXPORTER: <id>, or disable routing for one file with #+EXPORTER: none.

See Extension Points for how to define custom exporters.

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

  • latexmk-*: Uses latexmk which automatically handles multiple passes for references and bibliography (recommended)

  • Direct compilers: Manual handling of bibliography passes

Example:

{
  "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)

  • bibtex: Traditional, works with .bst styles

  • biber: Modern, required for biblatex

Example:

{
  "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

  • restricted: Allows minted/pygments but blocks dangerous commands (safe default)

  • full: Allows all shell commands (security risk, but needed for some packages)

  • disabled: No shell escape

Example:

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

scimax.export.pdf.extraArgs

• Type: string

• Default: ""

• Description: Extra arguments to pass to the LaTeX compiler

Example:

{
  "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.export.pdf.profile

• Type: string

• Default: ""

• Description: Name of the build profile to use when a document does not choose one with #+LATEX_BUILD: and no nearby latex-profiles.json declares a default. Set to none to always use scimax.export.pdf.compiler.

Example:

{
  "scimax.export.pdf.profile": "lualatex-biber"
}

⚠️ scimax.export.pdf.profiles

• Type: object

• Default: {}

• Description: Build profiles defined in settings, in the same shape as a latex-profiles.json file's profiles object. These override the built-in profiles of the same name and are available in every workspace, trusted or not. Project-local latex-profiles.json files override these in turn.

Example:

{
  "scimax.export.pdf.profiles": {
    "thesis": {
      "description": "lualatex with biber and a glossary",
      "steps": [
        { "command": "lualatex", "args": ["-interaction=nonstopmode", "%f"] },
        { "command": "biber", "args": ["%b"], "whenFileExists": "%b.bcf" },
        { "command": "makeglossaries", "args": ["%b"], "whenFileExists": "%b.glo" },
        { "command": "lualatex", "args": ["-interaction=nonstopmode", "%f"] },
        { "command": "lualatex", "args": ["-interaction=nonstopmode", "%f"] }
      ]
    }
  }
}

%f is the file name and %b the base name without extension - the form bibtex and biber expect. See Build Profiles for the full token and step reference.

scimax.latexPreview.enabled

• Type: boolean

• Default: true

• Description: Enable LaTeX equation preview on hover

Example:

{
  "scimax.latexPreview.enabled": true
}

scimax.latexPreview.cacheEnabled

• Type: boolean

• Default: true

• Description: Cache rendered equations for faster hover responses

Example:

{
  "scimax.latexPreview.cacheEnabled": true
}

scimax.latexPreview.darkModeAware

• Type: boolean

• Default: true

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

Example:

{
  "scimax.latexPreview.darkModeAware": true
}

scimax.latexLivePreview.buildOnSave

• Type: boolean

• Default: true

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

Example:

{
  "scimax.latexLivePreview.buildOnSave": true
}

scimax.latexLivePreview.buildOnIdle

• Type: boolean

• Default: false

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

Example:

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

scimax.latexLivePreview.idleDelay

• Type: number

• Default: 2000

• Description: Delay in milliseconds before idle build triggers

Example:

{
  "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

  • pdflatex: Standard, fast

  • xelatex: Better Unicode and font support

  • lualatex: Modern, Lua scripting support

Example:

{
  "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.

Example:

{
  "scimax.latexLivePreview.useLatexmk": true
}

scimax.notebook.directory

• Type: string

• Default: ""

• Description: Default parent directory for new notebooks

Example:

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

scimax.notebook.defaultTemplate

• Type: string (enum)

• Default: "research"

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

• Description: Default template for new notebooks

  • empty: Minimal structure

  • research: Research project layout

  • software: Software development layout

  • notes: Note-taking layout

Example:

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

scimax.notebook.autoDetect

• Type: boolean

• Default: true

• Description: Automatically detect and track projects in workspace

Example:

{
  "scimax.notebook.autoDetect": false
}

scimax.hydra.showKeyHints

• Type: boolean

• Default: true

• Description: Show keyboard shortcuts inline with menu items

Example:

{
  "scimax.hydra.showKeyHints": true
}

scimax.hydra.singleKeySelection

• Type: boolean

• Default: true

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

Example:

{
  "scimax.hydra.singleKeySelection": true
}

scimax.hydra.dimNonMatching

• Type: boolean

• Default: true

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

Example:

{
  "scimax.hydra.dimNonMatching": true
}

scimax.hydra.sortByKey

• Type: boolean

• Default: false

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

Example:

{
  "scimax.hydra.sortByKey": false
}

scimax.highlighting.headingBackgroundBars

• Type: boolean

• Default: true

• Description: Show a tinted whole-line background behind each org heading, fading at deeper levels.

The bar color for each level is configured via the workbench color customizations scimax.heading1Background ... scimax.heading6Background. Override them in settings.json under workbench.colorCustomizations to match your theme:

{
  "scimax.highlighting.headingBackgroundBars": true,
  "workbench.colorCustomizations": {
    "scimax.heading1Background": "#3b82f622",
    "scimax.heading2Background": "#3b82f618",
    "scimax.heading3Background": "#3b82f614",
    "scimax.heading4Background": "#3b82f610",
    "scimax.heading5Background": "#3b82f60c",
    "scimax.heading6Background": "#3b82f608"
  }
}

The matching foreground colors for each heading level are exposed as the orgHeading1 ... orgHeading6 semantic token types and can be themed via editor.semanticTokenColorCustomizations.

scimax.jump.timeoutMs

The equivalent of Emacs avy-timeout-seconds. After you stop typing your query for this many milliseconds, the labels are drawn over the matches and further keystrokes select a label rather than extending the query. Raise it if labels appear while you are still typing; set it to 0 to label as soon as the query matches anything.

scimax.jump.labelChars

The equivalent of Emacs avy-keys. Labels are assigned nearest-first from the cursor, so the characters at the front of this string land on the closest targets. Duplicate characters and whitespace are ignored, and at least two distinct characters are required.

scimax.jump.allVisibleEditors

When true, jump commands label matches in every visible editor and selecting a label in another split focuses that editor first. Set it to false to restrict jumping to the active editor.

scimax.jump.dimBackground

The equivalent of Emacs avy-background. Recolors the visible text to the muted line-number color while labels are showing, so the labels stand out. Off by default, matching avy.

scimax.jump.labelBackground / scimax.jump.labelForeground

Labels are painted directly over the characters they mark, so the background color must be opaque. Any CSS color works.

Example (a high-contrast pair for a light theme):

{
  "scimax.jump.labelBackground": "#b58900",
  "scimax.jump.labelForeground": "#000000",
  "scimax.jump.dimBackground": true
}

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.

Example:

{
  "scimax.speedCommands.enabled": true
}

scimax.agenda.exclude

• Type: array of strings

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

• Description: Patterns or paths to hide from the agenda view. Files matching these stay in the database (search still finds them); they just don't show up in day/week/month views. Supports both glob patterns (containing *) and absolute paths. To not index a file at all, use scimax.db.exclude instead.

Example:

{
  "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

Example:

{
  "scimax.agenda.defaultSpan": 14
}

scimax.agenda.showDone

• Type: boolean

• Default: false

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

Example:

{
  "scimax.agenda.showDone": true
}

scimax.agenda.showHabits

• Type: boolean

• Default: true

• Description: Show items tagged with :HABIT:

Example:

{
  "scimax.agenda.showHabits": false
}

scimax.agenda.todoStates

• Type: array of strings

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

• Description: Active TODO states to show in TODO list

Example:

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

scimax.agenda.doneStates

• Type: array of strings

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

• Description: Completed TODO states

Example:

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

scimax.imageOverlays.enabled

• Type: boolean

• Default: true

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

Example:

{
  "scimax.imageOverlays.enabled": true
}

scimax.imageOverlays.maxWidth

• Type: number

• Default: 96

• Description: Maximum width in pixels for thumbnail icons

Example:

{
  "scimax.imageOverlays.maxWidth": 128
}

scimax.imageOverlays.maxHeight

• Type: number

• Default: 96

• Description: Maximum height in pixels for thumbnail icons

Example:

{
  "scimax.imageOverlays.maxHeight": 128
}

scimax.imageOverlays.renderMode

• Type: string (enum)

• Default: "gutter"

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

• Description: Where to display image thumbnails

  • gutter: In the line margin (gutter)

  • after: Inline emoji after the link

  • both: Both locations

Example:

{
  "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)

Example:

{
  "scimax.imageOverlays.onlyWhenCursorNotInLink": true
}

scimax.imageOverlays.excludePatterns

• Type: array of strings

• Default: [ ]

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

Example:

{
  "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)

Example:

{
  "scimax.imageOverlays.maxOverlaysPerDocument": 500
}

scimax.imageOverlays.showDimensions

• Type: boolean

• Default: true

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

Example:

{
  "scimax.imageOverlays.showDimensions": false
}

scimax.imageOverlays.cacheEnabled

• Type: boolean

• Default: true

• Description: Cache generated thumbnails for faster loading

Example:

{
  "scimax.imageOverlays.cacheEnabled": true
}

scimax.capture.templates

• Type: array of objects

• Default: [ ]

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

  • key: Single character shortcut

  • name: Template name

  • type: entry, item, or table-line

  • file: Target file

  • headline: Optional target headline

  • datetree: Boolean, use datetree structure

  • template: Template text with placeholders

Template placeholders:

• %^{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

Example:

{
  "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: "" (falls back to {scimax.directory}/notes.org)

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

Example:

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

✅ scimax.capture.defaultDirectory

• Type: string

• Default: ""

• Description: Base directory for resolving relative capture template file paths (supports ~). If empty, relative paths resolve against the default capture file's directory.

Example:

{
  "scimax.capture.defaultDirectory": "~/org"
}

✅ scimax.capture.showPreview

• Type: boolean

• Default: true

• Description: Show a preview of the expanded template before inserting the capture.

✅ scimax.capture.openAfterCapture

• Type: boolean

• Default: true

• Description: Open the target file and move the cursor to the insertion point after a capture.

✅ scimax.capture.datetreeFormat

• Type: string (enum)

• Default: "day"

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

• Description: Granularity for file+datetree capture targets — controls the heading tree that captures are filed under. Missing headings are created automatically.

  • day: * 2024 > ** 2024-04 April > *** 2024-04-15 Monday (entry at level 4)

  • week: * 2024 > ** 2024-W16 (ISO week; entry at level 3)

  • month: * 2024 > ** 2024-04 April (entry at level 3)

  Week mode uses the ISO week-numbering year, so a date in early January that belongs to the previous ISO year is filed under that year.

Example:

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