X Tutup
Skip to content

Latest commit

 

History

History
153 lines (109 loc) · 2.56 KB

File metadata and controls

153 lines (109 loc) · 2.56 KB

(api)=

API Reference

:::{seealso} See {ref}libtmux's API <libtmux:api> and {ref}Quickstart <libtmux:quickstart> to see how you can control tmux via python API calls. :::

Internals

:::{warning} Be careful with these! Internal APIs are not covered by version policies. They can break or be removed between minor versions.

If you need an internal API stabilized please file an issue. :::

.. automethod:: tmuxp.util.run_before_script
.. automethod:: tmuxp.util.oh_my_zsh_auto_title
.. automethod:: tmuxp.util.raise_if_tmux_not_running
.. automethod:: tmuxp.util.get_current_pane
.. automethod:: tmuxp.util.get_session
.. automethod:: tmuxp.util.get_window
.. automethod:: tmuxp.util.get_pane

CLI

.. automethod:: tmuxp.cli.import_config.get_teamocil_dir
.. automethod:: tmuxp.cli.import_config.get_tmuxinator_dir
.. automethod:: tmuxp.cli.load.load_workspace
.. automethod:: tmuxp.cli.load._reattach

Workspace files

Finding

.. automethod:: tmuxp.workspace.finders.is_workspace_file
.. automethod:: tmuxp.workspace.finders.in_dir
.. automethod:: tmuxp.workspace.finders.in_cwd
.. automethod:: tmuxp.workspace.finders.get_workspace_dir

Validation

.. autofunction:: tmuxp.workspace.validation.validate_schema

Processing

.. automethod:: tmuxp.workspace.loader.expandshell
.. automethod:: tmuxp.workspace.loader.expand
.. automethod:: tmuxp.workspace.loader.trickle

Workspace importers

.. automethod:: tmuxp.workspace.importers.import_teamocil
.. automethod:: tmuxp.workspace.importers.import_tmuxinator

Configuration reader

.. automodule:: tmuxp.config_reader

Workspace Builder

.. autoclass:: tmuxp.workspace.builder.WorkspaceBuilder
   :members:

Workspace Freezer

.. automethod:: tmuxp.workspace.freezer.freeze
.. automethod:: tmuxp.workspace.freezer.inline

Exceptions

.. autoexception:: tmuxp.exc.EmptyWorkspaceException
.. autoexception:: tmuxp.exc.WorkspaceError
.. autoexception:: tmuxp.exc.BeforeLoadScriptError
.. autoexception:: tmuxp.exc.BeforeLoadScriptNotExists
X Tutup