@tspappsen/elamax 1.2.3 → 1.2.5
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 +10 -1
- package/dist/copilot/system-message.js +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ curl -fsSL https://raw.githubusercontent.com/burkeholland/max/main/install.sh |
|
|
|
11
11
|
Or install directly with npm:
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
npm install -g elamax
|
|
14
|
+
npm install -g @tspappsen/elamax
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
## Quick Start
|
|
@@ -189,6 +189,15 @@ max tui
|
|
|
189
189
|
|
|
190
190
|
On Windows, prefer `node dist/cli.js setup` for local development rather than the shell installer.
|
|
191
191
|
|
|
192
|
+
### Publish to npm
|
|
193
|
+
|
|
194
|
+
```bash
|
|
195
|
+
npm version patch
|
|
196
|
+
npm publish
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
The package is published as `@tspappsen/elamax`, and `prepublishOnly` runs `npm run build` automatically.
|
|
200
|
+
|
|
192
201
|
### Running as a background service with pm2
|
|
193
202
|
|
|
194
203
|
To keep Max running even after you close the terminal, use [pm2](https://pm2.keymetrics.io/):
|
|
@@ -25,16 +25,16 @@ This restriction does NOT apply to:
|
|
|
25
25
|
- Any files outside the Max installation directory
|
|
26
26
|
`;
|
|
27
27
|
const osName = getOsName();
|
|
28
|
-
return `You are Max, a personal AI assistant for developers running 24/7 on the user's machine (${osName}).
|
|
28
|
+
return `You are Max, a personal AI assistant for developers running 24/7 on the user's machine (${osName}).
|
|
29
29
|
|
|
30
30
|
## Your Architecture
|
|
31
31
|
|
|
32
32
|
You are a Node.js daemon process built with the Copilot SDK. Here's how you work:
|
|
33
33
|
|
|
34
|
-
- **Telegram bot**: Your primary interface.
|
|
35
|
-
- **Discord bot**: Your other interface.
|
|
34
|
+
- **Telegram bot**: Your primary interface. Your human collaborator messages you from Telegram, often on a phone or desktop client. Messages arrive tagged with \`[via telegram]\`. Keep responses concise and mobile-friendly — short paragraphs, no huge code blocks.
|
|
35
|
+
- **Discord bot**: Your other interface. Your human collaborator messages you on Discord. Messages arrive tagged with \`[via discord]\`. Keep responses concise — sensible paragraphs, but no huge code blocks.
|
|
36
36
|
- **Local TUI**: A terminal readline interface on the local machine. Messages arrive tagged with \`[via tui]\`. You can be more verbose here since it's a full terminal.
|
|
37
|
-
- **Background tasks**: Messages tagged \`[via background]\` are results from worker sessions you dispatched. Summarize and relay these to
|
|
37
|
+
- **Background tasks**: Messages tagged \`[via background]\` are results from worker sessions you dispatched. Summarize and relay these to your human collaborator.
|
|
38
38
|
- **HTTP API**: You expose a local API on port ${config.apiPort} for programmatic access.
|
|
39
39
|
|
|
40
40
|
When no source tag is present, assume Telegram.
|