Skip to content
Open
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
89 changes: 89 additions & 0 deletions README.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<br>

<p align="center">
<a name="readme-top"></a>
<a href="https://github.com/maxktz/hitch">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="assets/logo-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="assets/logo-light.svg">
<img alt="Hitch" src="assets/logo-light.svg" height="68">
</picture>
</a>
</p>

<p align="center">
<a href="README.md">English</a> · <a href="README.zh-CN.md">简体中文</a> · <strong>日本語</strong>
</p>

<h3 align="center">コーディングエージェントとターミナルを共有</h3>

<p align="center">
すでに実行中のターミナルをエージェントが確認し、操作できるようにします。
</p>

<p align="center">
<a href="https://github.com/maxktz/hitch"><strong>GitHub</strong></a> ·
<a href="https://www.npmjs.com/package/hitch-cli"><strong>NPM</strong></a> ·
<a href="https://x.com/maxktz"><strong>作者</strong></a>
</p>

<p align="center">
<a href="https://www.npmjs.com/package/hitch-cli"><img src="https://img.shields.io/npm/v/hitch-cli?style=flat-square&color=333" alt="npm バージョン"></a>
<a href="https://www.npmjs.com/package/hitch-cli"><img src="https://img.shields.io/npm/l/hitch-cli?style=flat-square&color=333" alt="ライセンス"></a>
<a href="https://www.npmjs.com/package/hitch-cli"><img src="https://img.shields.io/npm/dt/hitch-cli?style=flat-square&color=333" alt="npm ダウンロード数"></a>
</p>

<p align="center">
<img alt="Hitch のプレビュー" src="assets/preview.jpg" width="900">
</p>

---

## Hitch とは?

Hitch は、実際のターミナルを AI コーディングエージェントと共有するための軽量 CLI です。`hitch` を実行すると、エージェントはターミナルのコンテキストを取得し、キー入力やコマンドを実行して、出力を確認できるようになります。

エージェントが開発サーバーやトンネルを重複して起動することや、ログをエージェントへコピー&ペーストする手間を減らします。

`tmux` のようなターミナルマルチプレクサ UI ではありません。ターミナルは通常のシェルとしてそのまま使えます。Hitch は入出力を中継し、有用なコンテキストを記録して、エージェント向けのコマンドを公開するだけです。

## インストール

```sh
npm install -g hitch-cli
hitch
```

初回実行時のウィザードが、[skills.sh](https://skills.sh) CLI を使用して `SKILL.md` の設定を支援します。

> 対応プラットフォーム:arm64 または x64 の macOS と Linux。

## 使い方

現在のターミナルの共有を開始:

```sh
hitch
```

共有を停止:

```sh
unhitch
# or
hitch off
```

> ユーザーが必要とする操作はこれだけです!残りのコマンドはエージェント向けに用意されています。

## SKILL.md

このファイルは起動時の Hitch インストールをエージェントに案内します。再インストールまたは更新するには、次を実行してください:

```sh
hitch setup # recommended, uses 'npx skills'
# or
npx skills add https://github.com/maxktz/hitch skill hitch
```

> エージェント側での仕組みに興味がある場合は、`hitch --skill` を実行して内容を確認してください :D
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
</a>
</p>

<p align="center">
<strong>English</strong> · <a href="README.zh-CN.md">简体中文</a> · <a href="README.ja.md">日本語</a>
</p>

<h3 align="center">Share your terminal with coding agents</h3>

<p align="center">
Expand Down
89 changes: 89 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<br>

<p align="center">
<a name="readme-top"></a>
<a href="https://github.com/maxktz/hitch">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="assets/logo-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="assets/logo-light.svg">
<img alt="Hitch" src="assets/logo-light.svg" height="68">
</picture>
</a>
</p>

<p align="center">
<a href="README.md">English</a> · <strong>简体中文</strong> · <a href="README.ja.md">日本語</a>
</p>

<h3 align="center">与编程智能体共享你的终端</h3>

<p align="center">
让智能体检查并控制你已经在运行的终端。
</p>

<p align="center">
<a href="https://github.com/maxktz/hitch"><strong>GitHub</strong></a> ·
<a href="https://www.npmjs.com/package/hitch-cli"><strong>NPM</strong></a> ·
<a href="https://x.com/maxktz"><strong>作者</strong></a>
</p>

<p align="center">
<a href="https://www.npmjs.com/package/hitch-cli"><img src="https://img.shields.io/npm/v/hitch-cli?style=flat-square&color=333" alt="npm 版本"></a>
<a href="https://www.npmjs.com/package/hitch-cli"><img src="https://img.shields.io/npm/l/hitch-cli?style=flat-square&color=333" alt="许可证"></a>
<a href="https://www.npmjs.com/package/hitch-cli"><img src="https://img.shields.io/npm/dt/hitch-cli?style=flat-square&color=333" alt="npm 下载量"></a>
</p>

<p align="center">
<img alt="Hitch 预览" src="assets/preview.jpg" width="900">
</p>

---

## Hitch 是什么?

Hitch 是一个轻量级 CLI,用于与 AI 编程智能体共享真实终端。运行 `hitch` 后,智能体即可获取终端上下文、发送按键或执行命令,并检查输出。

它能避免智能体重复启动开发服务器或隧道,也省去了将日志复制粘贴给智能体的麻烦。

它不是 `tmux` 那样的终端多路复用器 UI。你的终端仍然像普通 shell 一样使用;Hitch 只会代理输入/输出、记录有用的上下文,并提供对智能体友好的命令。

## 安装

```sh
npm install -g hitch-cli
hitch
```

首次运行时,向导会使用 [skills.sh](https://skills.sh) CLI 帮助你配置 `SKILL.md`。

> 支持的平台:采用 arm64 或 x64 架构的 macOS 和 Linux。

## 使用方法

开始共享当前终端:

```sh
hitch
```

停止共享:

```sh
unhitch
# or
hitch off
```

> 对用户来说,这些就是所需的全部操作!其余命令是为智能体提供的。

## SKILL.md

该文件会帮助智能体在启动时安装 Hitch;如需重新安装或更新,请运行:

```sh
hitch setup # recommended, uses 'npx skills'
# or
npx skills add https://github.com/maxktz/hitch skill hitch
```

> 如果你想了解智能体如何使用 Hitch,请运行 `hitch --skill` 查看其内容 :D