Unified Agent + reusable Go agent core.
docs: tighten readme copy
+47
-48
+21
-22
README.md
+21
-22
README.md
···
1
1
# Mister Morph
2
2
3
-
Desktop app, CLI, and reusable Go runtime for running local or channel-connected agents.
3
+
Desktop app, CLI, and reusable Go runtime for AI agents.
4
4
5
5
Other languages: [简体中文](docs/zh-CN/README.md) | [日本語](docs/ja-JP/README.md)
6
6
7
-
If you just want to try Mister Morph, start with the desktop App from the [GitHub Releases](https://github.com/quailyquaily/mistermorph/releases) page. It bundles the Console UI, starts the local backend for you, and walks you through first-run setup.
7
+
To try Mister Morph, start with the desktop App from [GitHub Releases](https://github.com/quailyquaily/mistermorph/releases). It includes the Console UI, starts the local backend, and guides first-run setup.
8
8
9
9
## Why Mister Morph
10
10
11
-
- 🖥️ App-first onboarding: the desktop App removes the old multi-terminal setup path, but the CLI is still there when you want it.
12
-
- 🧩 Reusable Go core: run Mister Morph as a desktop App, CLI, Console backend, or embed it into another Go project.
13
-
- 🔀 One backend, multiple entrypoints: desktop App, Console server, CLI, and channel runtimes all build on the same core runtime.
14
-
- 🛠️ Practical extension model: built-in tools, `SKILL.md` skills, and Go embedding cover local use, automation, and integration.
15
-
- 🔒 Security-minded by design: auth profiles, outbound policy controls, approvals, and redaction are built into the runtime model.
11
+
- 🖥️ App-first setup: use the desktop App to get started; use the CLI when you need a server or script.
12
+
- 🧩 Reusable Go core: run Mister Morph as an App, CLI, or Console backend, or embed it in your projects.
13
+
- 🤝 Connection: [Aqua](https://mistermorph.com/aqua) lets agents talk to each other, so multiple agents can plan and work together.
14
+
- 🛠️ Practical extensions: built-in tools, `SKILL.md` skills, and Go embedding cover local use and automation.
15
+
- 🔒 Security-minded: auth profiles, outbound policy, approvals, and redaction are built in.
16
16
17
17
## Quick Start
18
18
···
22
22
- macOS: `mistermorph-desktop-darwin-arm64.dmg`
23
23
- Linux: `mistermorph-desktop-linux-amd64.AppImage`
24
24
- Windows: `mistermorph-desktop-windows-amd64.zip`
25
-
2. Launch the App.
26
-
3. Complete the setup flow inside the App.
27
-
4. Use the Console UI. You do not need to run `mistermorph console serve` manually.
25
+
2. Open the App.
26
+
3. Use the Agent.
28
27
29
28
Build, packaging, and platform notes: [docs/app.md](docs/app.md)
30
29
31
30
### CLI
32
31
33
-
Install a CLI binary:
32
+
Install the CLI:
34
33
35
34
```bash
36
35
curl -fsSL -o /tmp/install-mistermorph.sh https://raw.githubusercontent.com/quailyquaily/mistermorph/refs/heads/master/scripts/install-release.sh
···
43
42
go install github.com/quailyquaily/mistermorph/cmd/mistermorph@latest
44
43
```
45
44
46
-
Bootstrap a workspace, set an API key, and run one task:
45
+
Set up a workspace, set an API key, and run one task:
47
46
48
47
```bash
49
48
mistermorph install
···
51
50
mistermorph run --task "Hello!"
52
51
```
53
52
54
-
If `config.yaml` does not exist yet, `mistermorph install` launches the setup wizard and writes the initial workspace files for you.
53
+
If `config.yaml` is missing, `mistermorph install` starts the setup wizard and writes the first workspace files.
55
54
56
55
CLI modes and configuration details: [docs/modes.md](docs/modes.md), [docs/configuration.md](docs/configuration.md)
57
56
58
-
## What Mister Morph Includes
57
+
## What It Includes
59
58
60
-
- A desktop App for local use with first-run setup and an embedded Console UI.
61
-
- A CLI for one-shot tasks, scripting, automation, and server modes.
62
-
- A local Console server for browser-based setup, runtime management, and monitoring.
59
+
- A desktop App with first-run setup and the Console UI.
60
+
- A CLI for one-shot tasks, scripts, automation, and server modes.
61
+
- A local Console server for setup, runtime management, and monitoring.
63
62
- Channel runtimes for Telegram, Slack, LINE, and Lark.
64
-
- A reusable Go integration layer for embedding Mister Morph into other projects.
63
+
- A Go integration layer for embedding Mister Morph into other projects.
65
64
- Built-in tools and a `SKILL.md`-based skills system.
66
65
- Security controls for auth profiles, outbound policies, approvals, and redaction.
67
66
···
94
93
95
94
## Development
96
95
97
-
Useful local commands:
96
+
Useful commands:
98
97
99
98
```bash
100
99
./scripts/build-backend.sh --output ./bin/mistermorph
···
102
101
go test ./...
103
102
```
104
103
105
-
The Console frontend uses `pnpm` under `web/console/`. See [docs/console.md](docs/console.md) and [docs/app.md](docs/app.md) for local build details.
104
+
The Console frontend lives in `web/console/` and uses `pnpm`. See [docs/console.md](docs/console.md) and [docs/app.md](docs/app.md) for build details.
106
105
107
106
## Configuration Template
108
107
109
-
The canonical config template lives at [assets/config/config.example.yaml](assets/config/config.example.yaml).
110
-
Environment variables use the `MISTER_MORPH_` prefix. Full configuration notes and common flags are in [docs/configuration.md](docs/configuration.md).
108
+
The canonical config template is [assets/config/config.example.yaml](assets/config/config.example.yaml).
109
+
Environment variables use the `MISTER_MORPH_` prefix. Full config notes and common flags are in [docs/configuration.md](docs/configuration.md).
111
110
112
111
## Star History
113
112
+1
-1
docs/README.md
+1
-1
docs/README.md
+17
-17
docs/app.md
+17
-17
docs/app.md
···
1
1
# Desktop App
2
2
3
-
Mister Morph ships a desktop App that wraps the existing Console backend and UI into a single local experience.
3
+
Mister Morph includes a desktop App that wraps the existing Console backend and UI.
4
4
5
5
## User Quick Start
6
6
7
-
Download a release asset from the [GitHub Releases](https://github.com/quailyquaily/mistermorph/releases) page:
7
+
Download a release asset from [GitHub Releases](https://github.com/quailyquaily/mistermorph/releases):
8
8
9
9
- macOS `arm64`: `mistermorph-desktop-darwin-arm64.dmg`
10
10
- Linux `amd64`: `mistermorph-desktop-linux-amd64.AppImage`
···
12
12
13
13
Then:
14
14
15
-
1. launch the App
16
-
2. complete the setup flow inside the App
17
-
3. let the App start and host the local Console for you
15
+
1. open the App
16
+
2. finish setup
17
+
3. use the local Console
18
18
19
-
You do not need to run `mistermorph console serve` manually when using the App.
19
+
You do not need to run `mistermorph console serve`.
20
20
21
21
## Current Shape
22
22
23
-
The desktop code lives under `desktop/wails` and is built with `wailsdesktop production`.
23
+
The desktop code lives in `desktop/wails` and builds with `wailsdesktop production`.
24
24
25
25
- the Wails process owns the native window and Go bindings
26
26
- a child process runs `mistermorph console serve`
27
-
- the App routes WebView traffic to that local child process
27
+
- the App routes WebView traffic to that child process
28
28
29
-
The wrapper stays intentionally thin: lifecycle, process hosting, restart flow, and local proxying only.
29
+
The wrapper only handles lifecycle, process management, restart, and proxying.
30
30
31
31
## Architecture
32
32
···
80
80
-> frontend calls App.RestartApp()
81
81
```
82
82
83
-
`App.RestartApp()` starts a new copy of the current desktop executable and then quits the old one.
83
+
`App.RestartApp()` starts a new copy of the desktop executable, then quits the old one.
84
84
85
85
## Paths and Configuration
86
86
87
-
- Console frontend assets are embedded in the bundled `mistermorph` backend by default.
87
+
- Console assets are embedded in the bundled `mistermorph` backend by default.
88
88
- You can override static assets with:
89
89
- `console.static_dir`
90
90
- `--console-static-dir /abs/path/to/dist`
···
98
98
sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.1-dev
99
99
```
100
100
101
-
Build the backend binary used by the desktop wrapper:
101
+
Build the backend binary:
102
102
103
103
```bash
104
104
./scripts/build-backend.sh --output ./bin/mistermorph
···
116
116
go run -tags 'wailsdesktop production' ./desktop/wails
117
117
```
118
118
119
-
Build only the desktop wrapper directly:
119
+
Build only the desktop wrapper:
120
120
121
121
```bash
122
122
go build -tags 'wailsdesktop production' -o ./bin/mistermorph-desktop ./desktop/wails
···
136
136
- Linux `amd64`: `mistermorph-desktop-linux-amd64.AppImage`
137
137
- Windows `amd64`: `mistermorph-desktop-windows-amd64.zip`
138
138
139
-
The packaged desktop App includes a sibling `mistermorph` backend binary so the wrapper can start `console serve` locally without a first-run download.
139
+
The package includes a sibling `mistermorph` backend binary, so the wrapper can start `console serve` locally without a first-run download.
140
140
141
-
That bundled backend is intentionally built with `CGO_ENABLED=0`. Keep it that way unless there is a deliberate packaging plan to change the constraint.
141
+
That backend is built with `CGO_ENABLED=0` on purpose. Keep it that way unless you have a packaging plan to change it.
142
142
143
143
## Known Gaps
144
144
145
145
- No notarization or codesign flow yet for the macOS DMG.
146
146
- Windows ships as a zip bundle, not an installer.
147
-
- No dedicated UI yet for detailed backend startup failures.
148
-
- The desktop wrapper still reuses the CLI backend through child-process orchestration rather than an in-process console module.
147
+
- No dedicated UI yet for backend startup failures.
148
+
- The wrapper still reuses the CLI backend through child-process orchestration rather than an in-process console module.
+6
-6
docs/configuration.md
+6
-6
docs/configuration.md
···
1
1
# Configuration
2
2
3
-
This page collects the configuration details that do not need to live on the top-level README.
3
+
This page holds the config details moved out of the top-level README.
4
4
5
5
The canonical config template is [../assets/config/config.example.yaml](../assets/config/config.example.yaml).
6
6
7
7
## Sources and Precedence
8
8
9
-
`mistermorph` uses Viper, so you can configure it with:
9
+
`mistermorph` uses Viper. You can configure it with:
10
10
11
11
- CLI flags
12
12
- environment variables
13
13
- a config file
14
14
15
-
Precedence for config-sourced values is:
15
+
Precedence:
16
16
17
17
`CLI flag > MISTER_MORPH_* env > config.yaml > default`
18
18
···
24
24
- `.toml`
25
25
- `.ini`
26
26
27
-
Environment variable rules:
27
+
Env var rules:
28
28
29
29
- prefix: `MISTER_MORPH_`
30
30
- nested keys: replace `.` and `-` with `_`
···
137
137
- `MISTER_MORPH_SLACK_APP_TOKEN`
138
138
- `MISTER_MORPH_FILE_CACHE_DIR`
139
139
140
-
Provider-specific values follow the same mapping. Examples:
140
+
Provider-specific values use the same mapping. Examples:
141
141
142
142
- `llm.azure.deployment` -> `MISTER_MORPH_LLM_AZURE_DEPLOYMENT`
143
143
- `llm.bedrock.model_arn` -> `MISTER_MORPH_LLM_BEDROCK_MODEL_ARN`
···
190
190
- `auth_profiles.<id>.credential.secret` holds the secret value.
191
191
- Use `${ENV_VAR}` for secret references.
192
192
193
-
If at least one allowlisted auth profile is configured, `bash` still works but `curl` is denied by default. Authenticated HTTP should go through `url_fetch` with an auth profile.
193
+
If you configure at least one allowlisted auth profile, `bash` still works but `curl` is denied by default. Use `url_fetch` for authenticated HTTP.
194
194
195
195
## Example
196
196
+1
-1
docs/ja-JP/README.md
+1
-1
docs/ja-JP/README.md
···
10
10
11
11
- 🖥️ App 起点で始めやすい: デスクトップ App によって以前のような複数ターミナル前提の導入が不要になり、必要なら CLI もそのまま使えます。
12
12
- 🧩 再利用可能な Go コア: デスクトップ App、CLI、Console バックエンドとして動かすだけでなく、他の Go プロジェクトへ組み込むこともできます。
13
-
- 🔀 1 つのバックエンドを複数入口で共有: デスクトップ App、Console server、CLI、各チャネル runtime が同じ中核ランタイムを使います。
13
+
- 🤝 Connection: [Aqua](https://mistermorph.com/aqua) により、複数の agent が会話し、いっしょに計画し、協調できます。
14
14
- 🛠️ 実用的な拡張モデル: 組み込みツール、`SKILL.md` ベースのスキル、Go への組み込みでローカル利用から自動化、統合までカバーします。
15
15
- 🔒 セキュリティを前提にした設計: auth profiles、送信先ポリシー、承認、秘匿化がランタイムモデルに組み込まれています。
16
16
+1
-1
docs/zh-CN/README.md
+1
-1
docs/zh-CN/README.md
···
10
10
11
11
- 🖥️ App 优先的上手路径：桌面 App 去掉了过去那种多终端启动流程，但 CLI 仍然保留，适合脚本和自动化。
12
12
- 🧩 可复用的 Go 核心：既可以把 Mister Morph 当桌面 App、CLI、Console 后端来运行，也可以嵌入到其他 Go 项目里。
13
-
- 🔀 一个后端，多种入口：桌面 App、Console server、CLI、各类渠道 runtime 都建立在同一套核心运行时之上。
13
+
- 🤝 Connection：基于 [Aqua](https://mistermorph.com/aqua)，多个 agent 可以彼此对话，一起规划和协作。
14
14
- 🛠️ 实用的扩展模型：内置工具、`SKILL.md` 技能系统，以及 Go 嵌入层，覆盖本地使用、自动化和集成。
15
15
- 🔒 从设计上考虑安全：auth profiles、出站策略、审批与脱敏都属于运行时模型的一部分。
16
16