6. Command List

The following is a list of commands generated by generate_cmd_list.py.

They are grouped by:

Package
Command type
- ApplicationCommand
- TextCommand
- WindowCommand

6.1. Default

6.1.1. ApplicationCommand

Default.echo.echo { **kwargs }
No command description available

Default.font.choose_font { }
No command description available

Default.font.decrease_font_size { }
No command description available

Default.font.increase_font_size { }
No command description available

Default.font.reset_font_size { }
No command description available

Default.install_package_control.install_package_control { }
No command description available

Default.settings.edit_settings { base_file, user_file=None, default=None }
No command description available

6.1.2. TextCommand

Default.arithmetic.arithmetic { expr }
No command description available

Default.auto_indent_tag.auto_indent_tag { }
No command description available

Default.block.wrap_block { begin, end }
No command description available

Default.comment.toggle_comment { block=False, variant=0 }
No command description available

Default.fold.fold_unfold { }
No command description available

Default.goto_line.goto_line { line }
No command description available

Default.history_list.add_jump_record { selection }
Allows packages to add a jump point without changing the selection

Default.history_list.jump_back { }
No command description available

Default.history_list.jump_forward { }
No command description available

Default.html_print.html_print { }
No command description available

Default.indentation.expand_tabs { set_translate_tabs=False, whole_buffer=True, **kwargs }
No command description available

Default.indentation.tab { set_translate_tabs=False, whole_buffer=True, **kwargs }
No command description available

Default.indentation.unexpand_tabs { set_translate_tabs=False, whole_buffer=True, **kwargs }
No command description available

Default.kill_ring.add_to_kill_ring { forward }
No command description available

Default.kill_ring.yank { }
No command description available

Default.mark.delete_to_mark { }
No command description available

Default.mark.select_to_mark { }
No command description available

Default.mark.set_mark { }
No command description available

Default.mark.swap_with_mark { }
No command description available

Default.open_context_url.open_context_url { event }
No command description available

Default.open_in_browser.open_in_browser { }
No command description available

Default.paragraph.old_expand_selection_to_paragraph { }
No command description available

Default.paragraph.old_wrap_lines { width=0 }
No command description available

Default.paste_from_history.paste_from_history { }
No command description available

Default.scroll.scroll_to_bof { }
No command description available

Default.scroll.scroll_to_eof { }
No command description available

Default.scroll.show_at_center { }
No command description available

Default.show_scope_name.show_scope_name { }
No command description available

Default.sort.permute_lines { operation=’shuffle’ }
No command description available

Default.sort.permute_selection { operation=’shuffle’ }
No command description available

Default.sort.sort_lines { case_sensitive=False, reverse=False, remove_duplicates=False }
No command description available

Default.sort.sort_selection { case_sensitive=False, reverse=False, remove_duplicates=False }
No command description available

Default.transform.convert_ident_case { case, first_case=None, separator=’’ }
No command description available

Default.transform.lower_case { }
No command description available

Default.transform.rot13 { }
No command description available

Default.transform.swap_case { }
No command description available

Default.transform.title_case { }
No command description available

Default.transform.transformer { }
No command description available

Default.transform.upper_case { }
No command description available

Default.transpose.transpose { **kwargs }

empty selection, cursor within a word: transpose characters

empty selection, cursor at the end of a word: transpose words

multiple selections, all empty: as above

multiple selections, at least one non-empty: rotate contents of selections (i.e., each selection takes on the contents of the selection before it)

single non-empty selection: do nothing

6.1.3. WindowCommand

Default.convert_color_scheme.convert_color_scheme { use_variables=None }
No command description available

Default.convert_syntax.convert_syntax { }
No command description available

Default.copy_path.copy_path { }
No command description available

Default.exec.exec { cmd=None, shell_cmd=None, file_regex=’’, line_regex=’’, working_dir=’’, encoding=’utf-8’, env={}, quiet=False, kill=False, kill_previous=False, update_annotations_only=False, word_wrap=True, syntax=’Packages/Text/Plain text.tmLanguage’, **kwargs }
No command description available

Default.goto_line.prompt_goto_line { }
No command description available

Default.keymap.primary_jChanged { }
No command description available

Default.new_templates.new_build_system { }
No command description available

Default.new_templates.new_plugin { }
No command description available

Default.new_templates.new_snippet { }
No command description available

Default.new_templates.new_syntax { }
No command description available

Default.pane.close_pane { group=-1 }
No command description available

Default.pane.close_transient { }
No command description available

Default.pane.focus_neighboring_group { forward=True }
No command description available

Default.pane.move_to_neighboring_group { forward=True }
No command description available

Default.pane.new_pane { move=True }
No command description available

Default.pane.set_max_columns { columns }
No command description available

Default.profile.profile_plugins { }
No command description available

Default.quick_panel.quick_panel { items }
No command description available

Default.rename.rename_file { new_name }
No command description available

Default.run_syntax_tests.profile_syntax_definition { **kwargs }
No command description available

Default.run_syntax_tests.run_syntax_tests { find_all=False, syntax=’Packages/Default/Syntax Test Results.sublime-syntax’, **kwargs }
No command description available

Default.run_syntax_tests.syntax_definition_compatibility { **kwargs }
No command description available

Default.settings.edit_syntax_settings { }
Opens the syntax-specific settings file for the currently active view

Default.settings.open_file_settings { }
Old syntax-specific settings command - preserved for backwards compatibility

Default.side_bar.copy_path_sidebar { paths }
No command description available

Default.side_bar.find_in_folder { dirs }
No command description available

Default.side_bar.new_file_at { dirs }
No command description available

Default.side_bar.new_folder { dirs }
No command description available

Default.side_bar.open_containing_folder { files }
No command description available

Default.side_bar.open_folder { dirs }
No command description available

Default.side_bar.rename_path { paths }
No command description available

Default.switch_file.switch_file { extensions=[], side_by_side=False, event=None }
No command description available

Default.symbol.auto_complete_goto_definition { symbol, event=None }
No command description available

Default.symbol.goto_definition { event=None, symbol=None, kind=<KindId.AMBIGUOUS: 0>, side_by_side=False, replace=False, clear_to_right=False }
No command description available

Default.symbol.goto_reference { symbol=None, side_by_side=False, replace=False, clear_to_right=False }
No command description available

Default.symbol.open_symbol_definition { path, new_tab=False, hide_popup=False, keep_auto_complete_open=False, add_jump_point=-1, event=None, focus_view=None, clear_to_right=False }
No command description available

Default.ui.customize_color_scheme { }
No command description available

Default.ui.customize_theme { }
No command description available

Default.ui.select_color_scheme { name, light=None, dark=None }
No command description available

Default.ui.select_theme { name, light=None, dark=None }
No command description available

Default.ui.view_resource { name }
No command description available

6.2. A File Icon

6.2.1. ApplicationCommand

A File Icon.plugin.afi_revert { }
No command description available

6.3. Diff

6.3.1. TextCommand

Diff.diff.diff_changes { }
No command description available

Diff.diff.diff_views { **kwargs }
No command description available

6.3.2. WindowCommand

Diff.diff.diff_files { files }
No command description available

6.4. HTML

6.4.1. TextCommand

HTML.encode_html_entities.encode_html_entities { **args }
No command description available

6.5. Package Control

6.5.1. ApplicationCommand

Package Control.package_control.commands.add_channel_command.add_channel { url=None, unattended=False }
A command to add a new channel (list of repositories) to the user’s machine

Example:
sublime.run_command(
    "add_channel",
    {
        "url": "https://my-server.com/channel.json",
        "unattended": False  # if True, suppress error dialogs
    }
)
Package Control.package_control.commands.add_repository_command.add_repository { url=None, unattended=False }
A command to add a new repository to the user’s Package Control settings

Example:
sublime.run_command(
    "add_repository",
    {
        "url": "https://my-server.com/repository.json",
        "unattended": False  # if True, suppress error dialogs
    }
)
Package Control.package_control.commands.clear_package_cache_command.clear_package_cache { unattended=False }
A command that clears out ST’s Cache directory.

Example:
sublime.run_command(
    "clear_package_cache",
    {
        "unattended": False  # if True, suppress error dialogs
    }
)
Package Control.package_control.commands.create_package_command.create_package { }
Command to create a regular .sublime-package file

Package Control.package_control.commands.disable_package_command.disable_package { }
A command that adds a package to Sublime Text’s ignored packages list

Package Control.package_control.commands.disable_packages_command.disable_packages { packages=None }
A command that accepts a list of packages to disable, or prompts the user to paste a comma-separated list.

Example:
sublime.run_command("disable_packages", {"packages": ["Package 1", "Package 2"]})
Package Control.package_control.commands.discover_packages_command.discover_packages { }
A command that opens the Package Control website

Package Control.package_control.commands.enable_package_command.enable_package { }
A command that removes a package from Sublime Text’s ignored packages list

Package Control.package_control.commands.enable_packages_command.enable_packages { packages=None }
A command that accepts a list of packages to enable, or prompts the user to paste a comma-separated list.

Example:
sublime.run_command("enable_packages", {"packages": ["Package 1", "Package 2"]})
Package Control.package_control.commands.install_package_command.install_package { }
A command that presents the list of available packages and allows the user to pick one to install.

Package Control.package_control.commands.install_packages_command.install_packages { packages=None, unattended=False }
A command that accepts a list of packages to install, or prompts the user to paste a comma-separated list.

Example:
sublime.run_command(
    "install_packages",
    {
        "packages": ["Package 1", "Package 2"],
        "unattended": False  # if True, suppress error dialogs
    }
)
Package Control.package_control.commands.list_packages_command.list_packages { }
A command that shows a list of all installed packages in the quick panel

Package Control.package_control.commands.list_unmanaged_packages_command.list_unmanaged_packages { }
A command that shows a list of all packages that are not managed by Package Control, i.e. that are installed, but not mentioned in installed_packages.

Package Control.package_control.commands.package_control_disable_debug_mode_command.package_control_disable_debug_mode { }
No command description available

Package Control.package_control.commands.package_control_enable_debug_mode_command.package_control_enable_debug_mode { }
No command description available

Package Control.package_control.commands.remove_channel_command.remove_channel { url=None, unattended=False }
A command to remove a channel from the user’s Package Control settings

Example:
sublime.run_command(
    "remove_channel",
    {
        "url": "https://my-server.com/channel.json",
        "unattended": False  # if True, suppress error dialogs
    }
)
Package Control.package_control.commands.remove_package_command.remove_package { }
A command that presents a list of installed packages, allowing the user to select one to remove

Package Control.package_control.commands.remove_packages_command.remove_packages { packages=None }
A command that accepts a list of packages to remove, or prompts the user to paste a comma-separated list.

Example:
sublime.run_command("remove_packages", {"packages": ["Package 1", "Package 2"]})
Package Control.package_control.commands.remove_repository_command.remove_repository { url=None, unattended=False }
A command to remove a repository from the user’s Package Control settings

Example:
sublime.run_command(
    "remove_repository",
    {
        "url": "https://my-server.com/repository.json",
        "unattended": False  # if True, suppress error dialogs
    }
)
Package Control.package_control.commands.revert_package_command.revert_package { }
A command that presents a list of installed packages, allowing the user to select one to revert

Package Control.package_control.commands.satisfy_libraries_command.satisfy_libraries { }
A command that finds all libraries required by the installed packages and makes sure they are all installed and up-to-date.

Package Control.package_control.commands.satisfy_packages_command.satisfy_packages { }
A command to sync installed_packages with filesystem.

It installs missing packages, which are listed in installed_packages but are not present on filesystem.

It removes managed packages, which are found on filesystem but are not present in installed_packages.

Package Control.package_control.commands.upgrade_all_packages_command.upgrade_all_packages { unattended=False }
A command to automatically upgrade all installed packages that are upgradable.
sublime.run_command("upgrade_all_packages", {"unattended": False})
Package Control.package_control.commands.upgrade_package_command.upgrade_package { }
A command that presents the list of installed packages that can be upgraded

Package Control.package_control.commands.upgrade_packages_command.upgrade_packages { packages=None, unattended=False }
A command that accepts a list of packages to upgrade, or prompts the user to paste a comma-separated list.

Example:
sublime.run_command(
    "upgrade_packages",
    {
        "packages": ["Package 1", "Package 2"],
        "unattended": False  # if True, suppress error dialogs
    }
)

6.5.2. TextCommand

Package Control.package_control.commands.package_control_insert_command.package_control_insert { string=’’ }
A command used by the test runner to display output in the output panel

Package Control.package_control.commands.package_control_message_command.package_control_message { message }
No command description available

6.5.3. WindowCommand

Package Control.package_control.commands.new_template_command.new_channel_json { }
No command description available

Package Control.package_control.commands.new_template_command.new_repository_json { }
No command description available

6.6. User

6.6.1. ApplicationCommand

User.sample.example_three { }
No command description available

6.6.2. TextCommand

User.sample.example { }
No command description available

User.sample.example_four { text, pos, event=None }
No command description available

User.timestamp.insert_timestamp { }
No command description available

User.timestamp.insert_timestamp_sortable { }
No command description available

User.timestamp.insert_timestamp_utc { }
No command description available

6.6.3. WindowCommand

User.generate_cmd_list.generate_command_list { }
Generate a list of all commands, their arguments and their doc strings to a buffer. The list of commands is displayed ordered under the package that defined them.

User.msg_box.message_box { msg }
No command description available

User.sample.example_two { }
No command description available