Skip to content

Commit 6ed6a6d

Browse files
committed
docs: update README and bump rust-search-ui version
1 parent 38607ce commit 6ed6a6d

3 files changed

Lines changed: 84 additions & 80 deletions

File tree

README.md

Lines changed: 82 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# claude-code-tools
22

3+
> ⚠️ **README Under Construction** — This documentation is being actively revised. Some sections may be incomplete or outdated.
4+
35
A collection of practical tools, hooks, and utilities for enhancing Claude Code
46
and other CLI coding agents.
57

@@ -45,8 +47,8 @@ All session tools are now under `aichat`. Use `aichat search` instead of
4547
## Table of Contents
4648

4749
- [🚀 Quick Start](#quick-start)
48-
- [🎮 tmux-cli — Terminal Automation](#tmux-cli-terminal-automation)
4950
- [💬 aichat — Session Management](#aichat-session-management)
51+
- [🎮 tmux-cli — Terminal Automation](#tmux-cli-terminal-automation)
5052
- [🚀 lmsh (Experimental) — natural language shell](#lmsh-experimental)
5153
- [🔐 Utilities](#utilities)
5254
- [🛡️ Claude Code Safety Hooks](#claude-code-safety-hooks)
@@ -56,83 +58,6 @@ All session tools are now under `aichat`. Use `aichat search` instead of
5658
- [🛠️ Development](#development)
5759
- [📄 License](#license)
5860

59-
<a id="tmux-cli-terminal-automation"></a>
60-
# 🎮 tmux-cli — Terminal Automation
61-
62-
> **Note**: While the description below focuses on Claude Code, tmux-cli works with any CLI coding agent.
63-
64-
![tmux-cli demo](demos/tmux-cli-demo-short.gif)
65-
66-
**Think Playwright for terminals** - Terminal automation for AI agents.
67-
68-
tmux-cli enables Claude Code to programmatically control terminal applications:
69-
test interactive scripts, debug with pdb, launch and interact with other CLI agents.
70-
71-
**Important**: You don't need to learn tmux-cli commands. Claude Code handles
72-
everything automatically—just describe what you want.
73-
74-
**Works anywhere**: Automatically handles both local tmux panes and remote sessions.
75-
76-
<a id="tmux-cli-deep-dive"></a>
77-
## 🎮 tmux-cli Deep Dive
78-
79-
### What Claude Code Can Do With tmux-cli
80-
81-
1. **Test Interactive Scripts** - CC can run and interact with scripts that
82-
require user input, answering prompts automatically based on your instructions.
83-
84-
2. **UI Development & Testing** - CC can launch web servers and coordinate with
85-
browser automation tools to test your applications.
86-
87-
3. **Interactive Debugging** - CC can use debuggers (pdb, node inspect, gdb) to
88-
step through code, examine variables, and help you understand program flow.
89-
90-
4. **Claude-to-Claude Communication** - CC can launch another Claude Code instance
91-
to get specialized help or code reviews.
92-
93-
Claude Code knows how to use tmux-cli through its built-in help. You just describe
94-
what you want, and CC handles the technical details.
95-
96-
For complete command reference, see [docs/tmux-cli-instructions.md](docs/tmux-cli-instructions.md).
97-
98-
### Setting up tmux-cli for Claude Code
99-
100-
To enable CC to use tmux-cli, add this snippet to your global
101-
`~/.claude/CLAUDE.md` file:
102-
103-
```markdown
104-
# tmux-cli Command to interact with CLI applications
105-
106-
`tmux-cli` is a bash command that enables Claude Code to control CLI applications
107-
running in separate tmux panes - launch programs, send input, capture output,
108-
and manage interactive sessions. Run `tmux-cli --help` for detailed usage
109-
instructions.
110-
111-
Example uses:
112-
- Interact with a script that waits for user input
113-
- Launch another Claude Code instance to have it perform some analysis or review or
114-
debugging etc
115-
- Run a Python script with the Pdb debugger to step thru its execution, for
116-
code-understanding and debugging
117-
- Launch web apps and test them with browser automation MCP tools like Playwright or
118-
Chrome Dev Tools.
119-
```
120-
121-
More frequently, I use this method: I launch another CLI-agent (say Codex-CLI)
122-
in another tmux pane, and say something like this to the first agent:
123-
124-
> There's another coding agent "Codex" running in tmux Pane 3. Feel free to use Codex
125-
to help you with your task or review your work. You can communicate with Codex using
126-
the tmux-cli command; you can do tmux-cli --help to see how to use it.
127-
128-
## Tmux-cli skill
129-
130-
To make it easier to have Claude-Code use this command, there's a **tmux-cli plugin** in this repo; once you install it, you can simply say "use your tmux-cli skill to get help from Codex running in tmux pane 3".
131-
132-
For detailed instructions, see [docs/tmux-cli-instructions.md](docs/tmux-cli-instructions.md).
133-
134-
All of this assumes you're familiar and comfortable with tmux, and (like me) run
135-
all CLI coding sessions inside tmux sessions.
13661

13762
<a id="aichat-session-management"></a>
13863
# 💬 aichat — Session Management
@@ -353,6 +278,85 @@ Direct commands that skip the menu:
353278

354279
Run `aichat <command> --help` for options
355280

281+
<a id="tmux-cli-terminal-automation"></a>
282+
# 🎮 tmux-cli — Terminal Automation
283+
284+
> **Note**: While the description below focuses on Claude Code, tmux-cli works with any CLI coding agent.
285+
286+
![tmux-cli demo](demos/tmux-cli-demo-short.gif)
287+
288+
**Think Playwright for terminals** - Terminal automation for AI agents.
289+
290+
tmux-cli enables Claude Code to programmatically control terminal applications:
291+
test interactive scripts, debug with pdb, launch and interact with other CLI agents.
292+
293+
**Important**: You don't need to learn tmux-cli commands. Claude Code handles
294+
everything automatically—just describe what you want.
295+
296+
**Works anywhere**: Automatically handles both local tmux panes and remote sessions.
297+
298+
<a id="tmux-cli-deep-dive"></a>
299+
## 🎮 tmux-cli Deep Dive
300+
301+
### What Claude Code Can Do With tmux-cli
302+
303+
1. **Test Interactive Scripts** - CC can run and interact with scripts that
304+
require user input, answering prompts automatically based on your instructions.
305+
306+
2. **UI Development & Testing** - CC can launch web servers and coordinate with
307+
browser automation tools to test your applications.
308+
309+
3. **Interactive Debugging** - CC can use debuggers (pdb, node inspect, gdb) to
310+
step through code, examine variables, and help you understand program flow.
311+
312+
4. **Claude-to-Claude Communication** - CC can launch another Claude Code instance
313+
to get specialized help or code reviews.
314+
315+
Claude Code knows how to use tmux-cli through its built-in help. You just describe
316+
what you want, and CC handles the technical details.
317+
318+
For complete command reference, see [docs/tmux-cli-instructions.md](docs/tmux-cli-instructions.md).
319+
320+
### Setting up tmux-cli for Claude Code
321+
322+
To enable CC to use tmux-cli, add this snippet to your global
323+
`~/.claude/CLAUDE.md` file:
324+
325+
```markdown
326+
# tmux-cli Command to interact with CLI applications
327+
328+
`tmux-cli` is a bash command that enables Claude Code to control CLI applications
329+
running in separate tmux panes - launch programs, send input, capture output,
330+
and manage interactive sessions. Run `tmux-cli --help` for detailed usage
331+
instructions.
332+
333+
Example uses:
334+
- Interact with a script that waits for user input
335+
- Launch another Claude Code instance to have it perform some analysis or review or
336+
debugging etc
337+
- Run a Python script with the Pdb debugger to step thru its execution, for
338+
code-understanding and debugging
339+
- Launch web apps and test them with browser automation MCP tools like Playwright or
340+
Chrome Dev Tools.
341+
```
342+
343+
More frequently, I use this method: I launch another CLI-agent (say Codex-CLI)
344+
in another tmux pane, and say something like this to the first agent:
345+
346+
> There's another coding agent "Codex" running in tmux Pane 3. Feel free to use Codex
347+
to help you with your task or review your work. You can communicate with Codex using
348+
the tmux-cli command; you can do tmux-cli --help to see how to use it.
349+
350+
## Tmux-cli skill
351+
352+
To make it easier to have Claude-Code use this command, there's a **tmux-cli plugin** in this repo; once you install it, you can simply say "use your tmux-cli skill to get help from Codex running in tmux pane 3".
353+
354+
For detailed instructions, see [docs/tmux-cli-instructions.md](docs/tmux-cli-instructions.md).
355+
356+
All of this assumes you're familiar and comfortable with tmux, and (like me) run
357+
all CLI coding sessions inside tmux sessions.
358+
359+
356360
<a id="lmsh-experimental"></a>
357361
# 🚀 lmsh (Experimental)
358362

rust-search-ui/Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

rust-search-ui/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "aichat-search"
3-
version = "0.1.1"
3+
version = "0.1.2"
44
edition = "2021"
55
description = "Fast full-text search TUI for Claude Code and Codex sessions using Tantivy"
66
license = "MIT"

0 commit comments

Comments
 (0)