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
38 changes: 2 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,7 @@ Today the strongest runtime support is still for `opencode`, and the project als

## Rename status

This project is being renamed from `opencode-tmux` to `coding-agents-tmux`.

In this update:

- **preferred public name:** `coding-agents-tmux`
- **temporary compatibility aliases:** `opencode-tmux`, `@opencode-tmux-*`, and `OPENCODE_TMUX_*`

The legacy names still work for now, but they are transition aliases and are not intended to stay forever.
This project was previously named `opencode-tmux`. The current public name is `coding-agents-tmux`.

## Install

Expand Down Expand Up @@ -79,27 +72,18 @@ Requirements:

With the recommended settings above, the tmux plugin manages the bundled `opencode` plugin, the Pi extension, and the Codex and Claude hook installs for you.

It installs the bundled `opencode` plugin by creating these symlinks:
It installs the bundled `opencode` plugin at:

```text
~/.config/opencode/plugins/coding-agents-tmux.ts
~/.config/opencode/plugins/opencode-tmux.ts
```

The new path is preferred. The legacy path is kept as a temporary compatibility alias.

That plugin publishes normalized session state files under:

```text
~/.local/state/coding-agents-tmux/plugin-state
```

The runtime also continues reading legacy state under:

```text
~/.local/state/opencode-tmux/plugin-state
```

On first install, the tmux plugin also bootstraps the CLI runtime dependencies inside:

```text
Expand All @@ -112,24 +96,12 @@ It also installs or updates the bundled Pi extension under:
~/.pi/agent/extensions/coding-agents-tmux/index.ts
```

The legacy extension path is also kept during the transition:

```text
~/.pi/agent/extensions/opencode-tmux/index.ts
```

That extension publishes normalized Pi state files under:

```text
~/.local/state/coding-agents-tmux/pi-state
```

The runtime also continues reading legacy Pi state under:

```text
~/.local/state/opencode-tmux/pi-state
```

It also installs or updates Codex hook integration under:

```text
Expand Down Expand Up @@ -290,8 +262,6 @@ set -ag status-right " #[fg=colour81]󰚩 #[default]#{@coding-agents-tmux-status

`manual` mode is the default. `#{E:@catppuccin_status_agents}` gives Catppuccin users a native-looking module, `#{@coding-agents-tmux-status-inline-format}` gives other themes a tone-aware inline segment, and `#{@coding-agents-tmux-status-text}` gives a plain live summary text export for fully custom wrappers. `append` mode restores the old behavior and appends automatically.

`@catppuccin_status_opencode` still works as a compatibility alias for now.

## Configuration

Available tmux options:
Expand Down Expand Up @@ -323,8 +293,6 @@ Available tmux options:
- `@coding-agents-tmux-status-color-waiting` tmux color for waiting state, default `colour196`
- `@coding-agents-tmux-status-color-unknown` tmux color for unknown/none state, default `colour244`

Legacy `@opencode-tmux-*` tmux options still work for now as transition aliases.

## Providers

Recommended provider:
Expand Down Expand Up @@ -484,5 +452,3 @@ Useful commands:
./bin/coding-agents-tmux status --provider plugin --style tmux
./bin/coding-agents-tmux tmux-config --provider plugin
```

The legacy `./bin/opencode-tmux` alias still works for now during the rename transition.
13 changes: 0 additions & 13 deletions bin/opencode-tmux

This file was deleted.

266 changes: 104 additions & 162 deletions coding-agents-tmux.tmux

Large diffs are not rendered by default.

49 changes: 49 additions & 0 deletions docs/remove-legacy-name-plan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Remove legacy rename aliases plan

## Goal

Finish the public rename so `coding-agents-tmux` is the only documented and user-facing project name, except for one short README note that tells existing users the former name and that compatibility aliases may exist during the transition.

## Current target state

- README uses only `coding-agents-tmux` in install, setup, configuration, status, and CLI examples.
- Migration details move out of the README and stay in historical release/migration docs only while they are useful.
- Runtime compatibility aliases have been removed for the next release.
- Tests cover only the current public names.

## What is already done

- README title, install snippet, tmux options, status examples, and CLI examples prefer `coding-agents-tmux`.
- README no longer lists legacy plugin/state/extension paths outside the rename note.
- Canonical tmux entrypoint, package metadata, OpenCode plugin file, Pi extension path, state root, env vars, and tmux options have new-name support.

## Left to do

### Documentation

- [x] Keep only the short rename note in `README.md`; avoid adding legacy examples elsewhere in the README.
- [x] Keep `docs/rename-coding-agents-tmux-migration.md` in the repo as historical migration notes and update it as needed.
- [x] Update `docs/rename-coding-agents-tmux.md` after each cleanup milestone so it reflects current status instead of the original transition plan.
- [x] Audit all docs for accidental legacy-name promotion before release. Current legacy references are confined to README rename note, historical implementation/migration plans, and compatibility-context notes.

### Runtime cleanup

- [x] Decide the deprecation window for legacy CLI, env-var, tmux-option, state-dir, plugin-path, and extension-path aliases: remove them in the next release.
- [x] Decide whether legacy alias usage should emit runtime warnings before removal: no warnings needed because aliases are being removed in the next release.
- [x] Pick the exact release boundary for removing alias support: the next release is the removal boundary.
- [x] Remove legacy aliases only after the communicated transition window.

### Validation

- [x] Run `npm test`.
- [x] Run `npm run typecheck`.
- [x] Run `npm run lint`.
- [x] Run `npm run shell:check`.
- [x] Run `npm run fmt:check`.
- [x] Verify TPM install/reload with the renamed repo and entrypoint.

## Release note checklist

- [x] State that the main README now documents only the new public surfaces.
- [x] Link existing users to the migration guide or release notes if legacy aliases are still supported.
- [x] Clearly state whether aliases are supported, deprecated with warnings, or removed in that release.
Loading
Loading