命令概述
注意
此命令列表正在开发中。
关于命令参数中的路径
一些命令接受路径作为参数。其中一些支持类似片段的语法，而另一些则不支持。第一种命令将接受类似 ${packages}/SomeDir/SomeFile.ext 的参数，而第二种命令将接受类似 Packages/SomeDir/SomeFile.ext 的参数。
通常，较新的命令支持类似片段的语法。
命令期望使用 UNIX 风格的路径，除非另有说明，包括在 Windows 上（例如，/c/Program Files/Sublime Text 3/sublime_plugin.py）。
通常，命令参数中的相对路径假定从 :Data_directory: 开始。
命令
append
在视图末尾插入字符串。
- characters (字符串): 要插入的字符串。
- force (布尔值)
- scroll_to_end (布尔值)
add_to_kill_ring
将选定的文本添加到内部缓冲区“剪切环”（使用 yank 粘贴它）。
auto_complete
打开自动补全列表。
build
运行构建系统。
- variant (字符串): 可选。要运行的变体的名称。
chain
将多个命令链接在一起执行。以下是此命令接受的参数。
- commands [[字符串, ArgsMapping]] 或 [[{"command": 字符串, "args": ArgsMapping}]: 将要执行的命令链。
chain 命令可以使用以下语法实现
{
"command": "chain",
"args": {
"commands" : [
["command1", {"arg1": "value1", "arg2": "value2"}],
["command2", {"arg1": "value1", "arg2": "value2"}],
["command3", {"arg1": "value1", "arg2": "value2"}],
]
}
}如果需要，命令列表也可以用包含命令和参数的对象替换，如下所示
{
"command": "chain",
"args": {
"commands" : [
{"command": "command1", "args": {"arg1": "value1", "arg2": "value2"}}
{"command": "command2", "args": {"arg1": "value1", "arg2": "value2"}}
]
}
}clear_bookmarks
如果没有 name 参数，或者指定了 name "bookmarks"，它将删除当前文件中设置的所有书签，但不会删除标记。如果将 name "mark" 指定为参数，它将删除当前文件中设置的所有标记，但不会删除书签。
- name (字符串): 例如
"mark","bookmarks"。
clear_fields
退出活动片段字段循环。
clear_recent_files
删除最近访问的文件和文件夹的记录。
clear_recent_projects
删除最近访问的项目的记录。
clone_file
将当前视图克隆到同一个选项卡组中，两者共享同一个缓冲区。这意味着您可以将一个选项卡拖动到另一个组，对一个视图的任何更新都将在另一个视图中可见。
close_file
关闭活动视图，在某些情况下，还会关闭整个应用程序。
close_folder_list
从当前项目中删除所有文件夹。
close_project
关闭当前项目。
close_tag
用适当的标签包围当前的内部文本。
close_window
关闭活动窗口。
close
关闭活动视图。
commit_completion
将当前在自动完成列表中选中的项目插入到缓冲区中。
context_menu
显示上下文菜单。
copy
将选定的文本发送到系统剪贴板。
cut
删除选定的文本并将其发送到系统剪贴板。换句话说，它剪切。
decrease_font_size
减小字体大小。
delete_to_mark
删除select_to_mark 将选择的文本到内部缓冲区“kill ring”（使用 yank 粘贴它）。
detect_indentation
从当前文件猜测缩进。
duplicate_line
复制当前行。
exec
异步运行外部进程。在 Windows 上，GUI 会被抑制。
exec 是构建系统使用的默认命令，因此它提供了类似的功能。但是，构建系统中的一些选项由 Sublime Text 内部处理，因此它们下面的列表仅包含此命令接受的参数。
- cmd [(String)]
- shell_cmd (String): 要使用的 shell 命令。如果给出则覆盖
cmd并忽略shell。 - file_regex (String)
- line_regex (String)
- working_dir (String)
- encoding (String)
- env [{String: String}]
- quiet (Bool): 如果为
True，则如果命令失败或具有非零退出代码，则不会打印任何运行时信息。 - kill (Bool): 如果为
True，则只会终止当前构建进程。这是通过 命令面板 中的构建：取消命令调用的。 - update_phantoms_only (Bool)
- hide_phantoms_only (Bool)
- word_wrap (Bool): 是否在构建面板中换行输出
- syntax (String): 用于为输出着色的语法文件。
- path (String)
- shell (Bool)
另请参阅
exec 目标选项 : 关于exec 命令所有参数的详细文档。
exit
退出整个应用程序，包括所有打开的窗口。
expand_selection
将选择范围扩展到预定义的限制。
- to (枚举): 值: bol, hardbol, eol, hardeol, bof, eof, brackets, line, tag, scope, indentation.
expand_tabs
将制表符转换为空格。
- set_translate_tabs (布尔值)
find_all_under
查找当前选择或当前单词的所有出现位置。
find_next
查找当前搜索词的下一个出现位置。
find_prev
查找当前搜索词的上一个出现位置。
find_under_expand_skip
基于当前选择添加新的选择，或将选择范围扩展到当前单词，同时删除当前选择。
find_under_expand
基于当前选择添加新的选择，或将选择范围扩展到当前单词。
find_under_prev
查找当前选择或当前单词的上一个出现位置。
find_under
查找当前选择或当前单词的下一个出现位置。
focus_group
将焦点设置到指定组中最上面的文件。
- group (整数): 要设置焦点的组索引。这由当前布局中
cells项的顺序决定（参见Window.set_layout）。
fold_by_level
扫描整个文件，并将缩进级别为 level 或更高的所有内容折叠。例如，如果您先按级别 2 折叠，然后按级别 3 折叠，则不会展开已折叠的区域。带有光标的部分不会被折叠。
- level (整数): 应该折叠的缩进级别。
0等同于运行 #### unfold_all。
fold_tag_attributes
折叠 XML 文件中的所有标签属性，只保留标签名称和结束括号可见。
fold
折叠当前选择，并显示 …。在折叠区域所在的行的旁边添加展开箭头。
hide_auto_complete
隐藏自动完成列表。
hide_overlay
隐藏活动覆盖层。使用 show_overlay 命令显示覆盖层。
hide_panel
隐藏活动面板。
- cancel (布尔值): 通知面板将选择恢复到打开面板时的状态。（仅限增量查找面板。）
increase_font_size
增大字体大小。
indent
增加选择的缩进。
insert_best_completion
插入可以从当前上下文中推断出的最佳完成。
- default (字符串): 无法获得最佳完成时要插入的字符串。
insert_snippet
从字符串或 .sublime-snippet 文件中插入代码片段。
- contents (字符串): 要插入的代码片段字符串。请记住，反斜杠
\必须转义，就像在其他 JSON 字符串中一样。 - name (字符串): 相对于当前文件的路径，指向要插入的 .sublime-snippet 文件。
insert
插入字符串。
- characters (字符串): 要插入的字符串。
join_lines
将当前行与下一行合并。
left_delete
删除光标左侧的字符。
lower_case
将选定内容转换为小写。
move_to_group
将当前文件移动到指定的组。
- group (Int): 要聚焦的组索引。请参阅 #### focus_group 命令。
move_to
将光标移动到预定义的位置。
- to (Enum): 值：bol、eol、bof、eof、brackets。
- extend (Bool): 是否扩展选择。默认为
false。
move
按预定义的单位移动光标。
- by (Enum): 值：characters、words、word_ends、subwords、subword_ends、lines、pages、stops。
- forward (Bool): 是否在缓冲区中前进或后退。
- word_begin (Bool)
- empty_line (Bool)
- punct_begin (Bool)
- separators (Bool)
- extend (Bool): 是否扩展选择。默认为
false。
new_build_system
创建一个新缓冲区并插入构建系统模板。
new_plugin
创建一个新缓冲区并插入插件模板（文本命令）。
new_snippet
创建一个新缓冲区并插入代码片段模板。
new_window
打开一个新窗口。
next_bookmark
选择下一个书签区域。
next_field
将光标移动到当前代码片段字段循环中的文本代码片段字段。
next_misspelling
移动到下一个拼写错误。
next_result
移动到下一个捕获的结果。
next_view_in_stack
切换到最近活动视图。
next_view
切换到下一个视图。
open_dir
使用默认文件管理器打开指定的目录。
- dir (String): 要打开的目录。
open_file_settings
打开当前语法的语法特定用户设置文件。
open_file
打开指定的文件。如果指定的覆盖文件不存在，将动态打开来自 sublime-package 档案 的资源文件，并将其设为只读。
file (String): 绝对路径或相对路径 到要打开的文件。相对路径将从最近访问的目录（例如，当前打开文件的目录）开始。
扩展类似代码片段的变量，例如
$platform和$packages。contents (String): 如果文件不存在，此字符串将写入新缓冲区。
open_recent_file
打开最近关闭的文件。
- index (Int)
open_recent_folder
打开最近关闭的文件夹。
- index (Int)
open_recent_project
打开最近关闭的项目。
- index (Int)
open_url
使用默认浏览器打开指定的 URL。
- url (String)
paste_and_indent
在光标后插入剪贴板内容，并进行上下文缩进。
paste
在光标后插入剪贴板内容。
- 剪贴板 (字符串): 可能是 选择。XXX 允许哪些其他值？
permute_lines
XXX
- 操作 (枚举): 反转, 唯一, 随机 ...?
permute_selection
XXX
- 操作 (枚举): 反转, 唯一, 随机 ...?
prev_bookmark
选择上一个书签区域。
prev_field
将光标移动到当前片段字段循环中的上一个片段字段。
prev_misspelling
移动到上一个拼写错误。
prev_result
移动到上一个捕获的结果。
prev_view_in_stack
切换到最近活动视图之前的活动视图。
prev_view
切换到上一个视图。
prompt_add_folder
提示添加一个文件夹到当前项目。
prompt_open_project
提示打开一个项目文件作为项目。
prompt_save_as
提示输入新的文件名并保存活动文件。
prompt_select_project
打开一个弹出窗口，其中包含最近访问的项目，您可以在其中进行模糊搜索。
redo_or_repeat
再次执行最新操作。
redo
重新应用最新撤消的操作。
refresh_folder_list
重新加载当前项目中的所有文件夹并更新侧边栏。
reindent
使用语法首选项中设置的正则表达式更正选择的缩进。基本缩进将是第一行选定行之前的行的缩进。有时无法按预期工作。
reopen_last_file
重新打开最后一个关闭的文件。
reopen
重新打开当前文件。
- 编码 (字符串): 文件应以该编码重新打开。
replace_completion_with_auto_complete
XXX
replace_completion_with_next_completion
reset_font_size
将字体大小重置为默认值
注意: 这实际上会从您的用户设置中删除该条目，可能还有其他地方已“更改”此设置。
revert
撤消对文件的未保存更改。
right_delete
删除光标右侧的字符。
run_macro_file
运行一个 .sublime-macro 文件。
- 文件 (字符串): 宏文件的相对路径。
run_macro
运行存储在宏缓冲区中的宏。
save_all
保存所有打开的文件。
save_macro
提示输入文件路径，将宏缓冲区中的宏保存到该路径。
save_project_as
提示输入新的文件名并保存当前项目。
save
保存活动文件。
- encoding (字符串): 保存文件的编码。
scroll_lines
滚动视图中的行。
amount [浮点数]: 正值向下滚动行（视图向上），负值向上滚动行（视图向下）。
select_all_bookmarks
选择所有已加书签的区域。
select_all
选择视图的内容。
select_bookmark
选择当前文件中已加书签的区域。
- index (Int)
select_by_index
将当前组中的某个选项卡设为焦点。
- index (整数): 要设为焦点的选项卡索引。
select_lines
将一行添加到当前选择中。
- forward (布尔值): 是否添加下一行或上一行。默认为
true。
select_to_mark
选择当前每个光标的当前位置和标记位置之间的文本。每个光标按出现顺序与每个标记匹配，并移动到其选择的开头。
如果任何数量的选择重叠，则它们将合并，并且在所有对应于每个合并选择的插入符号中，仅保留在文件中首先出现的插入符号。
如果当前插入符号的数量小于或等于标记的数量，则按顺序忽略剩余的标记。相反，如果当前有比标记更多的插入符号，则会生成第一个相关的选择。对于所有额外的标记，包含在选择中的标记将被删除，其余标记将保留在原位，不会从其位置触发选择。
set_build_system
更改当前构建系统。
- file (字符串): 构建系统的路径。如果为空，Sublime Text 会尝试从指定的 selector 自动找到合适的构建系统。
- index (整数): 在 工具 | 构建系统 菜单中使用，但在其他情况下可能没有用。
set_layout
更改当前窗口的组布局。此命令使用与 Window.set_layout 相同的模式，请参阅该模式以了解参数列表和说明。
set_line_ending
更改当前文件的行尾。
- type (枚举): windows, unix, cr
set_mark
标记当前文件中每个插入符号的位置。如果该文件中已设置任何标记，则会将其删除。
set_setting
设置设置的值。此值特定于视图。
- setting (字符串): 要更改的设置的名称。
- value (*): 要设置的值。
show_about_window
我想你知道这是做什么的。
show_at_center
滚动视图以显示选定行位于视图的中间，并在必要时调整水平滚动。
show_overlay
显示请求的覆盖层。使用 #### hide_overlay 命令隐藏它。
overlay (枚举): 要显示的覆盖层类型。可能的值
show_files (布尔值): 如果使用转到覆盖层，则从显示文件开始，而不是空小部件。
text (字符串): 要放在覆盖层中的初始内容。
show_panel
显示面板。
- panel (枚举): 值: incremental_find, find, replace, find_in_files, console 或 output.<panel_name>。
- pattern (字符串): 要添加到 查找: 字段的搜索字符串/模式。(ST 4123+)
- replace_pattern (字符串): 要添加到 替换: 字段的替换字符串。(ST 4123+)
- reverse (布尔值): 是否在缓冲区中向后搜索。
- toggle (布尔值): 如果面板已可见，是否隐藏它。
- highlight (布尔值): 是否突出显示查找结果。(ST 4107+)
- in_selection (布尔值): 是否仅在当前选择范围内搜索。(ST 4107+)
- preserve_case (布尔值): 替换文本时是否保留原始大小写。(ST 4107+)
- regex (布尔值): 是否执行正则表达式匹配。(ST 4107+)
- use_gitignore (布尔值): 是否从
find_in_files搜索运行中排除被 git 忽略的文件。(ST4107+) - whole_word (布尔值): 是否仅搜索整个单词。(ST4107+)
- wrap (布尔值): 如果到达文件末尾，是否在文档开头继续搜索。(ST4107+)
show_scope_name
在状态栏中显示插入符号范围的名称。
single_selection
将多个选择合并为一个选择。
slurp_find_string
将当前选择或单词复制到查找面板的“查找”字段中。
slurp_replace_string
将当前选择或单词复制到查找和替换面板的“替换”字段中。
soft_redo
重新执行每个操作，逐步完成细粒度编辑。
soft_undo
撤消每个操作，逐步完成细粒度编辑。
sort_lines
对行进行排序。
- case_sensitive (布尔值): 排序是否区分大小写。
sort_selection
对选择中的行进行排序。
- case_sensitive (布尔值): 排序是否区分大小写。
split_selection_into_lines
将选择拆分为多个选择，每个选择一行。
swap_case
交换选择中每个字符的大小写。
swap_line_down
将当前行与下一行交换。
swap_line_up
将当前行与上一行交换。
swap_with_mark
标记所有当前插入符号的位置，删除这些插入符号，并在以前标记的位置（如果有）设置新的插入符号。
switch_file
在具有相同名称但扩展名不同的两个文件之间切换。
- extensions (字符串): 将启用切换的扩展名（不带前导点）。
title_case
将选择的第一个字符大写，并将其余字符转换为小写。
toggle_bookmark
为活动区域设置或取消设置书签。（可以使用 "bookmarks" 作为键通过区域 API 访问书签。）
toggle_comment
如果可用，则对活动行进行注释或取消注释。
- block (布尔值): 是否插入块注释。
toggle_distraction_free
切换无干扰模式的开启或关闭。
toggle_full_screen
切换全屏模式的开启或关闭。
toggle_minimap
显示或隐藏迷你地图。
toggle_overwrite
切换覆盖模式的开启或关闭。
toggle_record_macro
启动或停止宏记录器。
toggle_save_all_on_build
切换在开始构建之前是否应该保存所有打开的文件。
toggle_setting
切换布尔设置的值。此值特定于视图。
- setting (字符串): 要切换的设置的名称。
toggle_show_open_files
显示或隐藏侧边栏中的打开文件。
toggle_side_bar
显示或隐藏侧边栏。
toggle_status_bar
显示或隐藏状态栏。
toggle_tabs
显示或隐藏选项卡栏。
transpose
使选择或字符交换位置。
有选择地：所选区域的内容循环。没有选择：交换相邻字符并将光标向前移动 1 个位置。
undo
撤消最新操作。
unexpand_tabs
将缩进中的空格转换为制表符。
- set_translate_tabs (布尔值)
unfold_all
展开所有折叠的区域。
unfold
展开选择中的所有折叠区域，如果没有选择，则展开当前行中的所有折叠区域。
unindent
取消缩进选择。
upper_case
使选择变为大写。
wrap_lines
换行。默认情况下，它在第一个标尺列处换行。
- width (整数): 指定应换行的列。
yank
从“剪切环”粘贴文本（使用 add_to_kill_ring 或 delete_to_mark 添加）。
发现命令
有几种方法可以发现命令的名称，以便将其用作键绑定、宏、菜单项或插件。
- 浏览 **首选项 | 键绑定 - 默认** 中的默认键绑定。如果您知道要检查其命令的键绑定，则可以使用 搜索面板 搜索它。当然，这在相反的方向上也能奏效。
sublime.log_commands(True)在 :console: 中运行上述内容将告诉 Sublime Text 在运行命令时在控制台中打印命令的名称。您实际上只需输入此内容，执行运行要检查的命令所需的任何操作，然后查看控制台。它还会打印传递的参数，因此您可以从其中获取所有必要的信息。完成后，只需使用
False作为参数再次运行该函数。检查
.sublime-menu文件。如果您的命令由菜单项运行，请浏览位于Packages/Default/Main.sublime-menu中的默认菜单文件。一旦您查看它，您就会很快找到它们，或者查看 菜单文档。
- 与菜单类似，您可以对
.sublime-command文件执行完全相同的操作。有关完成文件的一些文档，请参见 完成。