tmux_create
Ruby
- Python Unavailable
- Ruby
- Lua Unavailable
- TypeScript Unavailable
- Rust Unavailable
- Go Unavailable
- Java Unavailable
- .NET Unavailable
- C++ Unavailable
- Swift Unavailable
Create a session, window in an exact session, or split an exact pane using argv. Opt-in mutation; 64 KiB total string bytes and at most 256 argv entries. Window/pane focus defaults false. Cwd/environment are optional; size is cells or percent. Assigned refs prove creation, not program readiness or completion.
Policy: opt in with --enable-tool tmux_create.
All Ruby tools · JSON · Source
Arguments
This tool has no top-level named arguments. Consult its schema below.
Schemas
The schema defines required fields, nested values, defaults, and validation constraints.
Input schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "additionalProperties": false, "properties": { "argv": { "items": { "maxLength": 65536, "pattern": "^[^\\u0000]*$", "type": "string" }, "maxItems": 256, "minItems": 1, "prefixItems": [ { "maxLength": 65536, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" } ], "type": "array" }, "cwd": { "maxLength": 65536, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "environment": { "additionalProperties": { "maxLength": 65536, "pattern": "^[^\\u0000]*$", "type": "string" }, "maxProperties": 128, "propertyNames": { "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "type": "object" }, "height": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "kind": { "const": "session" }, "name": { "maxLength": 65536, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "width": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "window_name": { "maxLength": 65536, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" } }, "required": [ "kind", "name", "argv" ], "type": "object" }, { "additionalProperties": false, "properties": { "argv": { "items": { "maxLength": 65536, "pattern": "^[^\\u0000]*$", "type": "string" }, "maxItems": 256, "minItems": 1, "prefixItems": [ { "maxLength": 65536, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" } ], "type": "array" }, "cwd": { "maxLength": 65536, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "environment": { "additionalProperties": { "maxLength": 65536, "pattern": "^[^\\u0000]*$", "type": "string" }, "maxProperties": 128, "propertyNames": { "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "type": "object" }, "focus": { "type": "boolean" }, "index": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "kind": { "const": "window" }, "name": { "maxLength": 65536, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "parent": { "oneOf": [ { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^\\$[0-9]+$", "type": "string" }, "kind": { "const": "session" } }, "required": [ "generation", "kind", "id" ], "type": "object" } ] } }, "required": [ "kind", "parent", "name", "argv" ], "type": "object" }, { "additionalProperties": false, "properties": { "argv": { "items": { "maxLength": 65536, "pattern": "^[^\\u0000]*$", "type": "string" }, "maxItems": 256, "minItems": 1, "prefixItems": [ { "maxLength": 65536, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" } ], "type": "array" }, "cwd": { "maxLength": 65536, "minLength": 1, "pattern": "^[^\\u0000]*$", "type": "string" }, "direction": { "enum": [ "horizontal", "vertical" ] }, "environment": { "additionalProperties": { "maxLength": 65536, "pattern": "^[^\\u0000]*$", "type": "string" }, "maxProperties": 128, "propertyNames": { "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "type": "object" }, "focus": { "type": "boolean" }, "kind": { "const": "pane" }, "parent": { "oneOf": [ { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^%[0-9]+$", "type": "string" }, "kind": { "const": "pane" } }, "required": [ "generation", "kind", "id" ], "type": "object" } ] }, "size": { "oneOf": [ { "maximum": 2147483647, "minimum": 1, "type": "integer" }, { "pattern": "^(?:[1-9][0-9]?|100)%$", "type": "string" } ] } }, "required": [ "kind", "parent", "direction", "argv" ], "type": "object" } ], "type": "object"}Output schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "created": { "items": { "oneOf": [ { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^\\$[0-9]+$", "type": "string" }, "kind": { "const": "session" } }, "required": [ "generation", "kind", "id" ], "type": "object" }, { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^@[0-9]+$", "type": "string" }, "kind": { "const": "window" } }, "required": [ "generation", "kind", "id" ], "type": "object" }, { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^%[0-9]+$", "type": "string" }, "kind": { "const": "pane" } }, "required": [ "generation", "kind", "id" ], "type": "object" }, { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^@[0-9]+$", "type": "string" }, "index": { "minimum": 0, "type": "integer" }, "kind": { "const": "window_link" }, "session_id": { "maxLength": 32, "pattern": "^\\$[0-9]+$", "type": "string" } }, "required": [ "generation", "kind", "id", "session_id", "index" ], "type": "object" } ] }, "maxItems": 3, "minItems": 1, "type": "array" }, "delivery": { "const": "observed" }, "entity": { "oneOf": [ { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^\\$[0-9]+$", "type": "string" }, "kind": { "const": "session" } }, "required": [ "generation", "kind", "id" ], "type": "object" }, { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^@[0-9]+$", "type": "string" }, "kind": { "const": "window" } }, "required": [ "generation", "kind", "id" ], "type": "object" }, { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^%[0-9]+$", "type": "string" }, "kind": { "const": "pane" } }, "required": [ "generation", "kind", "id" ], "type": "object" }, { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^@[0-9]+$", "type": "string" }, "index": { "minimum": 0, "type": "integer" }, "kind": { "const": "window_link" }, "session_id": { "maxLength": 32, "pattern": "^\\$[0-9]+$", "type": "string" } }, "required": [ "generation", "kind", "id", "session_id", "index" ], "type": "object" } ] }, "program_completion": { "const": "unobserved" } }, "required": [ "entity", "created", "delivery", "program_completion" ], "type": "object" }, "ok": { "const": true } }, "required": [ "ok", "data" ], "type": "object" }, { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "delivery": { "enum": [ "not_sent", "possibly_sent", "observed" ] }, "effects": { "additionalProperties": false, "properties": { "created": { "items": { "oneOf": [ { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^\\$[0-9]+$", "type": "string" }, "kind": { "const": "session" } }, "required": [ "generation", "kind", "id" ], "type": "object" }, { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^@[0-9]+$", "type": "string" }, "kind": { "const": "window" } }, "required": [ "generation", "kind", "id" ], "type": "object" }, { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^%[0-9]+$", "type": "string" }, "kind": { "const": "pane" } }, "required": [ "generation", "kind", "id" ], "type": "object" }, { "additionalProperties": false, "properties": { "generation": { "maxLength": 128, "minLength": 1, "type": "string" }, "id": { "maxLength": 32, "pattern": "^@[0-9]+$", "type": "string" }, "index": { "minimum": 0, "type": "integer" }, "kind": { "const": "window_link" }, "session_id": { "maxLength": 32, "pattern": "^\\$[0-9]+$", "type": "string" } }, "required": [ "generation", "kind", "id", "session_id", "index" ], "type": "object" } ] }, "maxItems": 3, "type": "array" }, "state": { "enum": [ "none", "known", "unknown" ] } }, "required": [ "state", "created" ], "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "delivery" ], "type": "object" }, "ok": { "const": false } }, "required": [ "ok", "error" ], "type": "object" } ]}Tool annotations
{ "destructiveHint": true, "idempotentHint": false, "openWorldHint": false, "readOnlyHint": false}