Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ jobs:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
repository: libtmux/docs
ref: e5d07a35f37f54a38038700430941c2a715f9f36
ref: 8fda4b89071621b9ed2c4722a68d61f6ecf9c1c4
path: .site
persist-credentials: false

Expand Down Expand Up @@ -265,7 +265,7 @@ jobs:
permissions:
contents: read
id-token: write
uses: libtmux/docs/.github/workflows/reusable-deploy.yml@e5d07a35f37f54a38038700430941c2a715f9f36
uses: libtmux/docs/.github/workflows/reusable-deploy.yml@8fda4b89071621b9ed2c4722a68d61f6ecf9c1c4
with:
path-prefix: ruby/${{ matrix.version }}
artifact: docs-ruby-${{ matrix.version }}
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
</p>
<!-- /libtmux-logo -->

<div align="center">

# libtmux for Ruby

Create tmux sessions, split windows, send input, and capture pane output from
Expand All @@ -17,6 +19,8 @@ and the rest of `Enumerable`.
[Guide](docs/index.md) · [API reference](docs/reference/api.md) ·
[Recipes](docs/recipes.md)

</div>

**Alpha.** APIs may change between releases. See the
[initial alpha notes](CHANGELOG.md) and [release guide](docs/releasing.md).

Expand Down
4 changes: 4 additions & 0 deletions gems/libtmux-async/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@
</p>
<!-- /libtmux-logo -->

<div align="center">

# libtmux-async

Run libtmux operations inside an application-owned Async task. This
gem provides a subprocess facade, ordered mapping, control replies and event
subscriptions. Imports start no scheduler, tmux server or background task.

</div>

Install the alpha with `gem install libtmux-async --pre`.

The [complete program](../../examples/async_cancel.rb) owns an isolated server
Expand Down
4 changes: 4 additions & 0 deletions gems/libtmux-mcp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@
</p>
<!-- /libtmux-logo -->

<div align="center">

# libtmux-mcp

Expose an existing tmux server over MCP stdio. Read snapshots, capture pane
output, wait for events, or explicitly enable creation, input and shell commands.
The official MCP SDK handles the protocol; bounded Async tasks handle transport.

</div>

Install the alpha and its `libtmux-mcp` executable:

```console
Expand Down
4 changes: 4 additions & 0 deletions gems/libtmux-workspace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
</p>
<!-- /libtmux-logo -->

<div align="center">

# libtmux-workspace

Load bounded YAML or JSON, inspect an immutable creation plan, then explicitly
Expand All @@ -15,6 +17,8 @@ and installed command-line executable share the core
[compatibility matrix](https://github.com/libtmux/libtmux-ruby/actions/workflows/compatibility.yml);
consult its exact per-revision results.

</div>

The gem declares Ruby 3.3 or newer and depends on the same-version `libtmux`
gem, JSON 3.0 and Psych 5.5. See the repository's
[contribution guide](../../.github/CONTRIBUTING.md) for local builds and checks.
Expand Down
4 changes: 4 additions & 0 deletions gems/libtmux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
</p>
<!-- /libtmux-logo -->

<div align="center">

# libtmux

Ruby tmux orchestration core. `Server.open` borrows an
Expand All @@ -17,6 +19,8 @@ Owned startup uses Linux and Darwin readiness backends. The
[compatibility workflow](https://github.com/libtmux/libtmux-ruby/actions/workflows/compatibility.yml)
retains exact per-revision platform and version results.

</div>

Install the alpha with `gem install libtmux --pre`, then require `libtmux`.
Imports do not
start tmux, a scheduler or an MCP server. See the repository's contribution
Expand Down
Loading