@kirosnn/mosaic 0.0.9 → 0.0.91
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +83 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,21 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<img src="docs/
|
|
2
|
+
<img src="docs/logo_white.svg" width="200" />
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
<h1 align="center">Mosaic CLI</h1>
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
<p align="center">
|
|
8
|
+
<strong>Version 0.0.91</strong>
|
|
9
|
+
</p>
|
|
10
|
+
|
|
11
|
+
<p align="center">
|
|
12
|
+
<a href="#installation">Installation</a> •
|
|
13
|
+
<a href="#quick-start">Quick Start</a> •
|
|
14
|
+
<a href="#ai-providers">Providers</a> •
|
|
15
|
+
<a href="#contributing">Contributing</a>
|
|
16
|
+
</p>
|
|
17
|
+
|
|
18
|
+
---
|
|
8
19
|
|
|
9
20
|
Mosaic is an open-source, AI-powered coding agent for the terminal. It combines a React-based TUI (OpenTUI) with a tool-driven agent architecture to deliver a fast, context-aware development workflow. A web UI is also available for those who prefer a browser experience.
|
|
10
21
|
|
|
@@ -19,9 +30,30 @@ Mosaic is an open-source, AI-powered coding agent for the terminal. It combines
|
|
|
19
30
|
|
|
20
31
|
## Requirements
|
|
21
32
|
|
|
22
|
-
- [Bun](https://bun.sh)
|
|
33
|
+
- [Bun](https://bun.sh) (required at runtime)
|
|
34
|
+
- Node.js >= 18 (for npm installation)
|
|
23
35
|
|
|
24
|
-
## Installation
|
|
36
|
+
## Installation
|
|
37
|
+
|
|
38
|
+
### Via npm (recommended)
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npm install -g @kirosnn/mosaic
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Then run from any directory:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
mosaic
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Via npx (no install)
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
npx @kirosnn/mosaic
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### From source
|
|
25
57
|
|
|
26
58
|
```bash
|
|
27
59
|
git clone https://github.com/kirosnn/mosaic.git
|
|
@@ -42,6 +74,8 @@ If you prefer not to link globally:
|
|
|
42
74
|
bun run mosaic
|
|
43
75
|
```
|
|
44
76
|
|
|
77
|
+
> **Note:** Mosaic requires Bun at runtime. If Bun is not installed, the CLI will prompt you to install it.
|
|
78
|
+
|
|
45
79
|
## Quick Start
|
|
46
80
|
|
|
47
81
|
1. Run `mosaic` in a project directory.
|
|
@@ -73,6 +107,18 @@ mosaic web
|
|
|
73
107
|
|
|
74
108
|
Open http://127.0.0.1:8192 in your browser.
|
|
75
109
|
|
|
110
|
+
## Slash Commands
|
|
111
|
+
|
|
112
|
+
| Command | Description |
|
|
113
|
+
|-------------|--------------------------------------|
|
|
114
|
+
| `/init` | Initialize project context (MOSAIC.md) |
|
|
115
|
+
| `/help` | Show available commands |
|
|
116
|
+
| `/undo` | Undo last file change |
|
|
117
|
+
| `/redo` | Redo undone change |
|
|
118
|
+
| `/sessions` | Manage conversation sessions |
|
|
119
|
+
| `/web` | Open web interface |
|
|
120
|
+
| `/echo` | Echo a message (debug) |
|
|
121
|
+
|
|
76
122
|
## Configuration
|
|
77
123
|
|
|
78
124
|
Mosaic stores global settings in `~/.mosaic/`:
|
|
@@ -92,24 +138,36 @@ Project-specific settings live in `.mosaic/` at the repository root.
|
|
|
92
138
|
|
|
93
139
|
Mosaic relies on a tool registry that exposes safe, focused capabilities to the agent:
|
|
94
140
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
141
|
+
| Tool | Description |
|
|
142
|
+
|------------|------------------------------------------|
|
|
143
|
+
| `read` | Read file contents |
|
|
144
|
+
| `write` | Create or overwrite files |
|
|
145
|
+
| `edit` | Apply targeted edits to files |
|
|
146
|
+
| `bash` | Execute shell commands |
|
|
147
|
+
| `glob` | Find files by pattern |
|
|
148
|
+
| `grep` | Search code with regex |
|
|
149
|
+
| `list` | List directory contents |
|
|
150
|
+
| `question` | Ask clarifying questions to the user |
|
|
151
|
+
|
|
152
|
+
**Safety Features:**
|
|
153
|
+
- Write and edit operations require user approval before execution
|
|
154
|
+
- Built-in undo/redo system tracks all file changes (SQLite-backed)
|
|
155
|
+
- Project context via `MOSAIC.md` helps the agent understand your codebase
|
|
102
156
|
|
|
103
157
|
## AI Providers
|
|
104
158
|
|
|
105
159
|
Mosaic uses the Vercel AI SDK and currently supports:
|
|
106
160
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
161
|
+
| Provider | Models |
|
|
162
|
+
|------------|-------------------------------|
|
|
163
|
+
| OpenAI | GPT-5, GPT-4, GPT-3.5 |
|
|
164
|
+
| Anthropic | Claude Sonnet, Haiku, Opus |
|
|
165
|
+
| Google | Gemini 3 and others |
|
|
166
|
+
| Mistral | Mistral Large, Mixtral |
|
|
167
|
+
| xAI | Grok |
|
|
168
|
+
| Ollama | Any local model |
|
|
169
|
+
|
|
170
|
+
Configure your preferred provider on first run or edit `~/.mosaic/mosaic.jsonc`.
|
|
113
171
|
|
|
114
172
|
## Development
|
|
115
173
|
|
|
@@ -124,4 +182,10 @@ Issues and pull requests are welcome. Please include clear reproduction steps an
|
|
|
124
182
|
|
|
125
183
|
## License
|
|
126
184
|
|
|
127
|
-
MIT
|
|
185
|
+
MIT - see [LICENSE](LICENSE) for details.
|
|
186
|
+
|
|
187
|
+
---
|
|
188
|
+
|
|
189
|
+
<p align="center">
|
|
190
|
+
Made with Bun, React, and OpenTUI
|
|
191
|
+
</p>
|