Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

tmux_capabilities

Ruby
  • Python Unavailable
  • Ruby
  • Lua Unavailable
  • TypeScript Unavailable
  • Rust Unavailable
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift Unavailable

Discover the fixed endpoint, server binding, enabled tools, criteria schema and limits. Acquires metadata; starts no daemon.

Policy: enabled by default.

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",
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
}
Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"data": {
"additionalProperties": false,
"properties": {
"authored_run": {
"additionalProperties": false,
"properties": {
"authorization": {
"const": "exact_generation_at_queue_grant"
},
"availability": {
"enum": [
"conditional",
"unsupported"
]
},
"descendant_termination": {
"const": "unobserved"
},
"enrollment": {
"const": "explicit_source"
},
"persistent_shell_changes": {
"const": false
},
"requirements": {
"items": {
"type": "string"
},
"type": "array"
},
"shell_profile": {
"const": "zsh-5.9-zle"
},
"stdin": {
"const": "closed"
}
},
"required": [
"availability",
"shell_profile",
"enrollment",
"authorization",
"stdin",
"persistent_shell_changes",
"descendant_termination",
"requirements"
],
"type": "object"
},
"criteria_schema": {
"type": "object"
},
"enabled_tools": {
"items": {
"type": "string"
},
"type": "array"
},
"endpoint": {
"type": "string"
},
"limits": {
"additionalProperties": {
"type": "number"
},
"type": "object"
},
"observation": {
"additionalProperties": false,
"properties": {
"history_continuity": {
"const": "unknown"
},
"process_cursor": {
"enum": [
"conditional",
"unsupported"
]
},
"requirements": {
"items": {
"type": "string"
},
"type": "array"
},
"screen": {
"const": "bounded_rows"
},
"wait_conditions": {
"items": {
"enum": [
"screen_contains",
"process_exit"
]
},
"type": "array"
}
},
"required": [
"screen",
"history_continuity",
"process_cursor",
"requirements",
"wait_conditions"
],
"type": "object"
},
"owns_daemon": {
"const": false
},
"resource_subscriptions": {
"const": false
},
"server_identity": {
"additionalProperties": false,
"properties": {
"generation": {
"type": "string"
},
"pid": {
"type": "integer"
},
"start_time": {
"type": "integer"
},
"tmux_version": {
"type": "string"
}
},
"required": [
"generation",
"pid",
"start_time",
"tmux_version"
],
"type": "object"
}
},
"required": [
"endpoint",
"server_identity",
"enabled_tools",
"criteria_schema",
"limits",
"owns_daemon",
"resource_subscriptions",
"authored_run",
"observation"
],
"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": false,
"idempotentHint": false,
"openWorldHint": false,
"readOnlyHint": false
}
Esc

Type to search.