poltergeist-defaults.example.json

{
  "version": 2,
  "_README": [
    "This file is the template distributors use to pre-seed a new Poltergeist",
    "install for their team. Copy it to 'poltergeist-defaults.json' (without",
    "'.example'), fill in your team's share path / database names / context",
    "patterns / example snippet, then ZIP it up alongside Poltergeist.exe.",
    "",
    "When a new hire extracts the ZIP and launches the app for the first time,",
    "Poltergeist sees this file, adopts it as the starting config, and writes",
    "the result out to 'poltergeist.json' on the first save. After that, the",
    "defaults file is ignored - the user owns their config.",
    "",
    "Intentionally NOT included in this template: 'deepl_api_key'. Keys bundled",
    "inside a shipped file are trivial to extract, so have users enter theirs",
    "manually under Options > Application the first time they run the app.",
    "",
    "The '_README', '_comment', and '_note' keys used throughout this file are",
    "ignored by the loader - JSON has no native comments, so these stand in."
  ],
  "settings": {
    "_comment_hotkey": "Global hotkey to open the snippet popup. 'ctrl+alt+space' is the default.",
    "hotkey": "ctrl+alt+space",

    "_comment_injection": "Default injection mode: 'clipboard', 'clipboard_shift_insert', 'typing', or 'typing_compat'.",
    "default_injection": "clipboard",

    "default_date_format": "%d/%m/%Y",

    "_comment_start_with_windows": [
      "Must stay false: the in-app 'Start with Windows' checkbox is",
      "currently hidden pending cyber-defense approval of the",
      "Startup-folder .lnk mechanism. A non-false value here will be",
      "forcibly reset to false on first launch by the one-time scrub",
      "in app.py. Leave the key present for schema completeness."
    ],
    "start_with_windows": false,

    "theme": "auto",
    "language": "",

    "_comment_deepl": "Intentionally empty - each user enters their own DeepL key in Options.",
    "deepl_api_key": "",
    "_comment_team_share": [
      "UNC or mapped-drive path to the team's shared folder containing",
      "'team-snippets.json' and any CSV / XLSX databases. The app reads the",
      "share transparently and also caches a local copy for offline use."
    ],
    "team_share_path": "\\\\corp.example.com\\shares\\poltergeist\\team1",

    "_comment_team_shortcuts": [
      "Optional per-folder hotkey overrides for team folders, keyed by",
      "folder id. Leave empty and let each user set their own if preferred."
    ],
    "team_shortcuts": {},

    "_comment_context_patterns": [
      "Regexes applied to the clipboard / selection on hotkey press. Every",
      "named capture group becomes a variable usable in {VAR=name}, {IF ...},",
      "{DATABASE=...}, and the 'Show when:' filter on snippets / folders.",
      "",
      "The example below extracts a site code like 'DE-Sto-123-456' into",
      "four variables (country, type, region, site). Replace with whatever",
      "identifier your team actually copies around."
    ],
    "context_patterns": [
      {
        "name": "site code",
        "pattern": "(?P<country>[A-Z]{2})-(?P<type>[A-Za-z]+)-(?P<region>\\d+)-(?P<site>\\d+)"
      },
      {
        "name": "outage banner",
        "pattern": "(?P<outage>TLOC\\s+\\S+|MPLS\\s+\\S+|INET\\s+\\S+)"
      }
    ]
  },

  "_comment_tree_personal": [
    "A single welcome snippet so new hires see what a snippet looks like.",
    "They will add / edit / delete freely after this point."
  ],
  "tree_personal": [
    {
      "type": "snippet",
      "id": "welcome-snippet",
      "name": "Welcome to Poltergeist",
      "injection": "clipboard",
      "text": "Hi! This is an example personal snippet.\n\nWhat just happened:\n- You copied some text (or didn't) and pressed the global hotkey.\n- Poltergeist opened a popup at your cursor.\n- You picked this snippet and Poltergeist pasted it into whichever field had focus.\n\nNext steps:\n- Open the main window (tray icon > Show) to add your own snippets.\n- The 'Team' tab shows shared snippets for your team, refreshed automatically from the network share.\n- Right-click any folder to assign a per-folder hotkey.\n- Have a look at TUTORIAL.md for the full token reference ({DATE}, {IF ...}, {DATABASE=...}, etc).\n\nHappy typing!\n"
    }
  ],

  "_comment_tree_team": [
    "Left empty on purpose: the team tree is pulled from 'team_share_path'",
    "on every launch so there's no point baking a stale copy in here."
  ],
  "tree_team": []
}