Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
tmuxp 1.64.0 documentation
Light Logo Dark Logo
tmuxp 1.64.0 documentation
  • About
  • Quickstart
  • Commands
    • tmuxp load
    • tmuxp shell
    • tmuxp ls
    • tmuxp search
    • tmuxp edit
    • tmuxp import
    • tmuxp convert
    • tmuxp freeze
    • tmuxp debug-info
    • Completions
  • Workspace files
    • Top-level configuration
    • Environmental variables
    • Examples
  • Plugins

Project

  • Developing and Testing
  • API Reference
    • Internals
      • Colors - tmuxp._internal.colors
      • Config reader - tmuxp._internal.config_reader
      • Private path - tmuxp._internal.private_path
      • Typings - tmuxp._internal.types
    • CLI
      • tmuxp convert - tmuxp.cli.convert
      • tmuxp debug-info - tmuxp.cli.debug_info
      • tmuxp edit - tmuxp.cli.edit
      • tmuxp freeze - tmuxp.cli.freeze
      • tmuxp import - tmuxp.cli.import_config
      • tmuxp load - tmuxp.cli.load
      • tmuxp ls - tmuxp.cli.ls
      • tmuxp search - tmuxp.cli.search
      • tmuxp shell - tmuxp.cli.shell
      • CLI utilities - tmuxp.cli.utils
    • Workspace
      • Builder - tmuxp.workspace.builder
      • Constants - tmuxp.workspace.constants
      • Finders - tmuxp.workspace.finders
      • Freezer - tmuxp.workspace.freezer
      • Importers - tmuxp.workspace.importers
      • Loader - tmuxp.workspace.loader
      • Validation - tmuxp.workspace.validation
    • Exceptions - tmuxp.exc
    • Logging - tmuxp.log
    • Plugin - tmuxp.plugin
    • Shell - tmuxp.shell
    • Utilities - tmuxp.util
    • Typings - tmuxp.types
  • Changelog
  • Migration notes
  • The Tao of tmux
  • Glossary
  • GitHub

team git-pull / Tony Narlock:

vcs-python vcspull (libvcs), g

tmux-python tmuxp (libtmux)

cihai unihan-etl (db) cihai (cli)

django django-slugify-processor django-docutils

docs + tests gp-libs

web social-embed

Back to top
View this page
Edit this page

tmuxp search¶

Search for workspace configurations by name or content across your tmuxp directories.

Command¶

Search workspace files by name, session, path, window, or pane content.

Usage¶

usage: tmuxp search [-h] [-f FIELD] [-i] [-S] [-F] [-w] [-v] [--any] [--json]
                    [--ndjson]
                    [PATTERN ...]

Examples¶

$ tmuxp search dev
$ tmuxp search "my.*project"
$ tmuxp search name:dev
$ tmuxp search s:development

Field-Scoped Search¶

$ tmuxp search window:editor
$ tmuxp search pane:vim
$ tmuxp search p:~/.tmuxp

Matching Options¶

$ tmuxp search -i DEV
$ tmuxp search -S DevProject
$ tmuxp search -F 'my.project'
$ tmuxp search --word-regexp test

Multiple Patterns¶

$ tmuxp search dev production
$ tmuxp search --any dev production
$ tmuxp search -v staging

Machine-Readable Output Examples¶

$ tmuxp search --json dev
$ tmuxp search --ndjson dev | jq '.name'

Positional Arguments¶

query_terms PATTERN¶

search patterns (prefix with field: for field-scoped search)

Default
None

Options¶

-f, --field FIELD¶

restrict search to field(s): name, session/s, path/p, window/w, pane

Default
None
-i, --ignore-case¶

case-insensitive matching

Default
False
-S, --smart-case¶

case-insensitive unless pattern has uppercase

Default
False
-F, --fixed-strings¶

treat patterns as literal strings, not regex

Default
False
-w, --word-regexp¶

match whole words only

Default
False
-v, --invert-match¶

show workspaces that do NOT match

Default
False
--any¶

match ANY pattern (OR logic); default is ALL (AND logic)

Default
False
--json¶

output as JSON

Default
False
--ndjson¶

output as NDJSON (one JSON per line)

Default
False
Next
tmuxp edit
Previous
tmuxp ls
Copyright © Copyright 2013- Tony Narlock
Made with Sphinx and @pradyunsg's Furo
On this page
  • tmuxp search
    • Command
      • Usage
      • Examples
        • Field-Scoped Search
        • Matching Options
        • Multiple Patterns
        • Machine-Readable Output Examples
      • Positional Arguments
      • Options
Advertisement