<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/keyassignment/ActivateCommandPalette.md - fork/wezterm @ main</title>
<meta name="description" content="docs/config/lua/keyassignment/ActivateCommandPalette.md in fork/wezterm at main.">
<meta property="og:title" content="docs/config/lua/keyassignment/ActivateCommandPalette.md - fork/wezterm @ main">
<meta property="og:description" content="docs/config/lua/keyassignment/ActivateCommandPalette.md in fork/wezterm at main.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="main" data-tip="9c883a71b8b60323047762d8b47ae44f101773c6">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">mgpinf</span><span class="commit-message" data-commit="9606fa256904c337e705d2ff67cde78dc410a66f">Add font configuration option for ActivateCommandPalette, CharSelect, PaneSelect (#6696)</span><span class="snapshot-sha sha" data-commit="9606fa256904c337e705d2ff67cde78dc410a66f">9606fa256</span><time datetime="2025-03-10T04:04:32+05:30" title="2025-03-10 04:04:32 +0530">2025-03-10</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/main/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/main/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/main/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/main/tree/docs/config/lua/keyassignment/">keyassignment</a> / <span class="cur">ActivateCommandPalette.md</span></nav>
<span class="view-stats"><span>1.5 KiB</span><span>48 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/32593580002ba31ecea06656a0e31bc31da86e86/docs/config/lua/keyassignment/ActivateCommandPalette.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1><code>ActivateCommandPalette</code></h1>
<p>{{since('20230320-124340-559cb7b0')}}</p>
<p>Activates the Command Palette, a modal overlay that enables discovery and activation of various commands.</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>keys</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-v>key</a-v> = <a-s>&#39;P&#39;</a-s><a-p>,</a-p>
    <a-v>mods</a-v> = <a-s>&#39;CTRL&#39;</a-s><a-p>,</a-p>
    <a-v>action</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-v>ActivateCommandPalette</a-v><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>&lt;kbd&gt;CTRL&lt;/kbd&gt; + &lt;kbd&gt;SHIFT&lt;/kbd&gt; + &lt;kbd&gt;P&lt;/kbd&gt; is the default key assignment for <code>ActivateCommandPalette</code>.</p>
<p>The command palette shows a list of possible actions ranked by
<a href="https://en.wikipedia.org/wiki/Frecency">frecency</a> of use from the command
palette.</p>
<p><img src="/fork/wezterm/raw/c1d9888dffc6712ee6826785d5ca25804af9dbd3/docs/screenshots/command-palette.png" alt="Command Palette" /></p>
<h3>Key Assignments</h3>
<table><thead><tr><th>Action</th><th>Key Assignment</th></tr></thead><tbody>
<tr><td>Exit command palette</td><td>&lt;kbd&gt;Esc&lt;/kbd&gt;</td></tr>
<tr><td>Highlight previous item</td><td>&lt;kbd&gt;UpArrow&lt;/kbd&gt;</td></tr>
<tr><td>Highlight next item</td><td>&lt;kbd&gt;DownArrow&lt;/kbd&gt;</td></tr>
<tr><td>Clear the selection</td><td>&lt;kbd&gt;CTRL&lt;/kbd&gt; + &lt;kbd&gt;u&lt;/kbd&gt;</td></tr>
<tr><td>Activate the selection</td><td>&lt;kbd&gt;Enter&lt;/kbd&gt;</td></tr>
</tbody></table>
<p>Typing text (and using &lt;kbd&gt;Backspace&lt;/kbd&gt;) allows you to fuzzy match possible
actions. Each keystroke will reduce the list of candidate actions to those that
fuzzy match, ranked in decreasing order of the match score.</p>
<p>Activating the selected item will close the command palette and then invoke the
action.</p>
<p>See also:</p>
<ul>
<li><a href="/fork/wezterm/ref/main/blob/docs/config/lua/config/command_palette_font.md">command_palette_font</a></li>
<li><a href="/fork/wezterm/ref/main/blob/docs/config/lua/config/command_palette_font_size.md">command_palette_font_size</a></li>
<li><a href="/fork/wezterm/ref/main/blob/docs/config/lua/config/command_palette_fg_color.md">command_palette_fg_color</a></li>
<li><a href="/fork/wezterm/ref/main/blob/docs/config/lua/config/command_palette_bg_color.md">command_palette_bg_color</a></li>
<li><a href="/fork/wezterm/ref/main/blob/docs/config/lua/config/ui_key_cap_rendering.md">ui_key_cap_rendering</a></li>
</ul>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>`ActivateCommandPalette`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">{{since(&#39;20230320-124340-559cb7b0&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">Activates the Command Palette, a modal overlay that enables discovery and activation of various commands.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>config.</a-p><a-v>keys</a-v><a-p> = </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>    </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;P&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>    </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;CTRL&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>    </a-p><a-v>action</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-v>ActivateCommandPalette</a-v><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>&lt;kbd&gt;CTRL&lt;/kbd&gt; + &lt;kbd&gt;SHIFT&lt;/kbd&gt; + &lt;kbd&gt;P&lt;/kbd&gt; is the default key assignment for `ActivateCommandPalette`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>The command palette shows a list of possible actions ranked by</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>[frecency](https://en.wikipedia.org/wiki/Frecency) of use from the command</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>palette.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>![Command Palette](../../../screenshots/command-palette.png)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>### </a-p><a-tt>Key Assignments</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>| Action | Key Assignment |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>|--------|----------------|</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>|Exit command palette| &lt;kbd&gt;Esc&lt;/kbd&gt; |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>|Highlight previous item| &lt;kbd&gt;UpArrow&lt;/kbd&gt; |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>|Highlight next item| &lt;kbd&gt;DownArrow&lt;/kbd&gt; |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>|Clear the selection| &lt;kbd&gt;CTRL&lt;/kbd&gt; + &lt;kbd&gt;u&lt;/kbd&gt; |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>|Activate the selection| &lt;kbd&gt;Enter&lt;/kbd&gt; |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>Typing text (and using &lt;kbd&gt;Backspace&lt;/kbd&gt;) allows you to fuzzy match possible</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>actions. Each keystroke will reduce the list of candidate actions to those that</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>fuzzy match, ranked in decreasing order of the match score.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>Activating the selected item will close the command palette and then invoke the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>action.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>See also:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p> * [command_palette_font](../config/command_palette_font.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p> * [command_palette_font_size](../config/command_palette_font_size.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p> * [command_palette_fg_color](../config/command_palette_fg_color.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p> * [command_palette_bg_color](../config/command_palette_bg_color.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p> * </a-p>[ui_key_cap_rendering](../config/ui_key_cap_rendering.md)</span></span></pre></div></div>
</main>
</body>
</html>
