Skip to content

configuration.md

Latest commit

聽

History

History
163 lines (141 loc) 路 6.86 KB

configuration.md

File metadata and controls

163 lines (141 loc) 路 6.86 KB
Raw

Configuration

Lepton reads user configuration from a .leptonrc JSON file in the home directory reported by Electron. In Lepton v1.9.0 and later, the exact path is shown on the About page (Command/Ctrl + ,).

The file is not generated automatically. Create it if you want to override the defaults below.

Template .leptonrc

{
  "theme": "light",
  "autoUpdate": false,
  "startAtLogin": false,
  "i18n": {
    "locale": "en"
  },
  "window": {
    "closeToTray": false,
    "minimizeToTray": false
  },
  "avatar": {
    "type": "github",
    "boringAvatarVariant": "beam"
  },
  "userPanel": {
    "hideProfilePhoto": false
  },
  "logger": {
    "level": "info"
  },
  "security": {
    "cachedAccessTokenStorage": "auto"
  },
  "proxy": {
    "enable": false,
    "address": "socks://localhost:1080"
  },
  "snippet": {
    "sorting": "updated_at",
    "sortingReverse": true,
    "expanded": true,
    "newSnippetPrivate": false,
    "downloadAll": false
  },
  "tag": {
    "showInSnippetList": false,
    "colored": false
  },
  "editor": {
    "tabSize": 4,
    "validateFilename": true
  },
  "enterprise": {
    "enable": false,
    "host": "",
    "token": "",
    "avatarUrl": ""
  },
  "notifications": {
    "success": true,
    "failure": true
  },
  "zoom": {
    "percent": 100
  },
  "shortcuts": {
    "keyShortcutForSearch": "Shift+Space",
    "keyNewGist": "CommandOrControl+N",
    "keyEditGist": "CommandOrControl+E",
    "keyDeleteGist": "CommandOrControl+Delete",
    "keySubmitGist": "CommandOrControl+S",
    "keyImmersiveMode": "CommandOrControl+I",
    "keyAboutPage": "CommandOrControl+,",
    "keyDashboard": "CommandOrControl+D",
    "keySyncGists": "CommandOrControl+R"
  }
}

Options

Field Sub-field Default Description
theme light UI theme. Supported values: light, dark, one-dark, atom-one-dark, github-light, github-dark, catppuccin-latte, catppuccin-mocha, solarized-light, solarized-dark, dracula, material-theme, ayu.
autoUpdate false Enable automatic update downloads for packaged releases.
startAtLogin false Start Lepton when the user logs in. Not supported on every Linux environment.
i18n locale en Interface language. Supported values: en, es, fr, ja, ko, tr, zh-Hans, zh-Hant.
window closeToTray false Hide Lepton to the tray/menu bar when the window is closed. On macOS, the normal close behavior hides the window without creating a tray item unless this is enabled.
minimizeToTray false Hide Lepton to the tray/menu bar when the window is minimized. Currently applies on macOS.
avatar type github Profile image source. Use github for the GitHub avatar or boring for a generated avatar.
boringAvatarVariant beam Variant used when avatar.type is boring.
userPanel hideProfilePhoto false Hide the profile photo in the user panel.
logger level info Logging level. Use info for normal use or debug when collecting diagnostic logs.
security cachedAccessTokenStorage auto Cached GitHub OAuth token storage. Supported values: auto, encrypted, file. auto uses file storage in development builds and Electron safeStorage in packaged builds. When safeStorage is unavailable, token updates fall back to the legacy plaintext <userData>/storage/token.json file. Cached tokens stay in the location where they were written until the token is updated again.
proxy enable false Route GitHub API requests and Electron sessions through a proxy.
address socks://localhost:1080 Proxy address. Supports normal proxy URLs, Chromium proxy rule lists, and pac+https://... PAC URLs.
snippet sorting updated_at Snippet order. Supported values: updated_at, created_at, description.
sortingReverse true Reverse the configured snippet order.
expanded true Expand snippets in the detail view by default.
newSnippetPrivate false Create new snippets as secret snippets by default.
downloadAll false Load all authenticated snippets and download their details during sync. Enable this for complete global content search across snippet file contents.
tag showInSnippetList false Show custom tags in snippet list rows.
colored false Render custom tags with stable color badges.
editor tabSize 4 Tab size in spaces.
validateFilename true Validate snippet filenames before saving.
enterprise enable false Enable GitHub Enterprise mode.
host "" GitHub Enterprise host, for example github.example.com.
token "" Personal access token with the gist scope. This remains plain .leptonrc configuration and is not affected by security.cachedAccessTokenStorage.
avatarUrl "" Optional avatar image URL for GitHub Enterprise users.
notifications success true Show notifications for successful actions.
failure true Show notifications for failed actions.
zoom percent 100 Default page zoom percentage. 100 is original size; use values like 80, 120, or 150.
shortcuts keyShortcutForSearch Shift+Space Open snippet metadata and downloaded-content search.
keyNewGist CommandOrControl+N Create a snippet.
keyEditGist CommandOrControl+E Edit the selected snippet.
keyDeleteGist CommandOrControl+Delete Delete the selected snippet.
keySubmitGist CommandOrControl+S Submit editor changes.
keyImmersiveMode CommandOrControl+I Toggle immersive mode.
keyAboutPage CommandOrControl+, Open the About page.
keyDashboard CommandOrControl+D Open the dashboard.
keySyncGists CommandOrControl+R Sync snippets with GitHub Gist.

Debug Logging

Set logger.level to debug when collecting logs for an issue report:

{
  "logger": {
    "level": "debug"
  }
}

Home Directory Notes

macOS

On macOS, the home directory is your user folder under /Users. Place .leptonrc here:

/Users/<CurrentUserName>/.leptonrc

In Finder, use Go > Home to open the home directory. Because .leptonrc starts with a dot, it is hidden by default; press Command + Shift + . to show hidden files.

Windows

The home directory can vary by Windows distribution, but it usually starts here:

C:\Users\<CurrentUserName>\.leptonrc

Use the About page (Command/Ctrl + ,) to find the exact path.

Linux Snap Package

For the snap package, Electron may report ~/snap/lepton/current as the home directory instead of ~. Use the About page (Command/Ctrl + ,) to find the exact path.

Questions Or Issues

Open issues and feature requests at https://github.com/hackjutsu/Lepton/issues.