tmuxinator

tmuxinator, a tmux session manager

.tmuxinator.yaml.tmuxinator.yml**/.tmuxinator/*.yaml**/.tmuxinator/*.yml**/tmuxinator/*.yaml**/tmuxinator/*.yml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your .tmuxinator.yaml and it validates in your browser — nothing is uploaded.

Validate a .tmuxinator.yaml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`defaults`	`object`	—
`name`	`oneOf`	—
`project_name`	`string`	Name of project root (deprecated, use `name`)
`root`	`string`	—
`project_root`	`string`	Name of project root (deprecated, use `root`)
`socket_name`	`string`	Optional tmux socket.
`on_project_start`	`oneOf`	Runs on project start, always.
`on_project_first_start`	`oneOf`	Run on project start, the first time.
`on_project_restart`	`oneOf`	Run on project start, after the first time.
`on_project_exit`	`oneOf`	Run on project exit (detaching from tmux session).
`on_project_stop`	`oneOf`	Run on project stop.
`pre`	`string`	Runs before everything (deprecated).
`post`	`string`	Runs after everything (deprecated).
`rbenv`	`string`	Specify version for rbenv (deprecated)
`cli_args`	`string`	Pass arguments to tmux (deprecated)
`tabs`	`array`	Specify tabs (deprecated)
`pre_window`	`string`	Runs in each window and pane before window/pane specific commands. Useful for setting up interpreter versions.
`tmux_options`	`string`	Pass command line options to tmux. Useful for specifying a different tmux.conf.
`tmux_command`	`string`	Change the command to call tmux. This can be used by derivatives/wrappers like byobu.
`startup_window`	`oneOf`	Specifies (by name or index) which window will be selected on project startup. If not set, the first window is used.
`startup_pane`	`integer`	Specifies (by index) which pane of the specified window will be selected on project startup. If not set, the first pane is used.
`attach`	`boolean`	Controls whether the tmux session should be attached to automatically. Defaults to true. default: `true`
`tmux_detached`	`boolean`	Deprecated. Use `attach`
`enable_pane_titles`	`boolean`	Enables the display of pane titles. default: `false`
`pane_title_position`	`string`	Configures pane title position. default: `"top"`
`pane_title_format`	`string`	Configures pane title format. default: `"#{pane_index}: #{pane_title}"`
`windows`	`array`	—

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
30 properties, 83% carrying a description, max nesting depth 19.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`minLength`	JSON Schema Validation, draft 2020-12	§6.3.2 — "minLength"
`oneOf`	JSON Schema Core, draft 2020-12	§10.2.1.3 — "oneOf"
`patternProperties`	JSON Schema Core, draft 2020-12	§10.3.2.2 — "patternProperties"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas