id = "tmuxinator" name = "tmuxinator" homepage = "https://github.com/tmuxinator/tmuxinator" description = "Create and manage tmux sessions easily." # The project's own logo, as the tmuxinator organisation's avatar. icon = "https://github.com/tmuxinator.png" executables = ["tmuxinator"] platforms = ["macos", "linux"] [dotfiles] # README, "Configuration": "Tmuxinator will attempt to use the following # locations (in this order) when creating or searching for existing project # configuration files: $TMUXINATOR_CONFIG, $XDG_CONFIG_HOME/tmuxinator, # ~/.tmuxinator". Each project is one YAML file in that directory. # $TMUXINATOR_CONFIG names a directory the consumer cannot resolve, so it is # not listed; $XDG_CONFIG_HOME is `[configHome]`, which the consumer does # resolve, so that one is not pinned to the XDG default. # # The `.tmuxinator.yml` a project can carry in its own working directory # belongs to that repository, not here. tmux's own ~/.tmux.conf is a separate # tool with its own entry; tmuxinator does not read or write it. paths = ["~/.tmuxinator/", "[configHome]/tmuxinator/"] # Window layouts, pane commands and project names. tmuxinator authenticates to # nothing. secret = [] # `tmuxinator start` reads the project file once and hands off to tmux. side_effect = false # No machine_lines. A project file's `root:` is the one candidate — it names a # directory on this machine — but every project lives in its own file under a # directory, so a rule would need a glob, and a rule's `file` has to be one # concrete path. Left out rather than guessed at. [commands] format = 1 label = "tmuxinator projects" description = "Start, stop, create and list tmuxinator projects." quality = "ai-draft" base = "fig:tmuxinator" parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false } [[commands.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/tmuxinator.ts" license = "MIT" [[commands.subcommand]] path = ["start"] label = "Start project" description = "Start a tmux session from a project." [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/tmuxinator.ts" license = "MIT" [[commands.subcommand.field]] id = "project" label = "Project" type = "string" position = 0 sources = ["fig"] [[commands.subcommand.task]] id = "start" label = "Start project" fields = ["project"] required = ["project"] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["project"] [[commands.subcommand]] path = ["stop"] label = "Stop project" description = "Stop the tmux session of a project." [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/tmuxinator.ts" license = "MIT" [[commands.subcommand.field]] id = "project" label = "Project" type = "string" position = 0 sources = ["fig"] [[commands.subcommand.task]] id = "stop" label = "Stop project" fields = ["project"] required = ["project"] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["project"] [[commands.subcommand]] path = ["new"] label = "New project" description = "Create a project file and open it in your editor." [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/tmuxinator.ts" license = "MIT" [[commands.subcommand.field]] id = "project" label = "Project name" type = "string" position = 0 sources = ["fig"] [[commands.subcommand.field]] id = "local" label = "Local ./.tmuxinator.yml" type = "boolean" option = ["-l"] sources = ["fig"] [[commands.subcommand.task]] id = "new" label = "New project" fields = ["project", "local"] required = ["project"] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["project", "local"] [[commands.subcommand]] path = ["list"] label = "List projects" description = "List all projects." [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/tmuxinator.ts" license = "MIT" [[commands.subcommand.field]] id = "newline" label = "One entry per line" type = "boolean" option = ["-n", "--newline"] sources = ["fig"] [[commands.subcommand.task]] id = "list" label = "List projects" fields = ["newline"] required = [] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["newline"]