morpheus-cli 0.1.1 → 0.1.2
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 +61 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,6 +8,61 @@
|
|
|
8
8
|
|
|
9
9
|
Morpheus is a local AI agent for developers, running as a CLI daemon that connects to **LLMs**, **local tools**, and **MCPs**, enabling interaction via **Terminal, Telegram, and Discord**. Inspired by the character Morpheus from *The Matrix*, the project acts as an **intelligent orchestrator**, bridging the gap between the developer and complex systems.
|
|
10
10
|
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
Install Morpheus globally via npm:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install -g morpheus-cli
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Quick Start
|
|
20
|
+
|
|
21
|
+
### 1. Initialize
|
|
22
|
+
|
|
23
|
+
Set up your configuration (API keys, preferences):
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
morpheus init
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### 2. Start the Agent
|
|
30
|
+
|
|
31
|
+
Run the background daemon and Web UI:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
morpheus start
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
This will:
|
|
38
|
+
- Start the agent process
|
|
39
|
+
- Launch the Web UI at http://localhost:3333
|
|
40
|
+
|
|
41
|
+
### Other Commands
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
# Check if Morpheus is running
|
|
45
|
+
morpheus status
|
|
46
|
+
|
|
47
|
+
# Stop the agent
|
|
48
|
+
morpheus stop
|
|
49
|
+
|
|
50
|
+
# Diagnose issues
|
|
51
|
+
morpheus doctor
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Troubleshooting
|
|
55
|
+
|
|
56
|
+
### Command not found
|
|
57
|
+
|
|
58
|
+
If you installed successfully but can't run the `morpheus` command:
|
|
59
|
+
|
|
60
|
+
1. **Check your PATH**: Ensure your global npm bin directory is in your system PATH.
|
|
61
|
+
- Run `npm bin -g` to see the folder.
|
|
62
|
+
- On Windows, this is usually `%APPDATA%\npm`.
|
|
63
|
+
- On Linux/Mac, verify `echo $PATH`.
|
|
64
|
+
2. **Restart Terminal**: New installations might not be visible until you restart your shell.
|
|
65
|
+
|
|
11
66
|
## Technical Overview
|
|
12
67
|
|
|
13
68
|
Morpheus is built with **Node.js** and **TypeScript**, using **LangChain** as the orchestration engine. It runs as a background daemon process, managing connections to LLM providers (OpenAI, Anthropic, Ollama) and external channels (Telegram, Discord).
|
|
@@ -19,16 +74,16 @@ Morpheus is built with **Node.js** and **TypeScript**, using **LangChain** as th
|
|
|
19
74
|
- **Configuration (`src/config/`)**: Singleton-based configuration manager using `zod` for validation and `js-yaml` for persistence (`~/.morpheus/config.yaml`).
|
|
20
75
|
- **Channels (`src/channels/`)**: Adapters for external communication. Currently supports Telegram (`telegraf`) with strict user whitelisting.
|
|
21
76
|
|
|
22
|
-
##
|
|
77
|
+
## Development Setup
|
|
78
|
+
|
|
79
|
+
This guide is for developers contributing to the Morpheus codebase.
|
|
80
|
+
|
|
81
|
+
### Prerequisites
|
|
23
82
|
|
|
24
83
|
- **Node.js**: >= 18.x
|
|
25
84
|
- **npm**: >= 9.x
|
|
26
85
|
- **TypeScript**: >= 5.x
|
|
27
86
|
|
|
28
|
-
## Getting Started (Development)
|
|
29
|
-
|
|
30
|
-
This guide is for developers contributing to the Morpheus codebase.
|
|
31
|
-
|
|
32
87
|
### 1. Clone & Install
|
|
33
88
|
|
|
34
89
|
```bash
|
|
@@ -62,7 +117,7 @@ npm start -- status
|
|
|
62
117
|
|
|
63
118
|
### 4. Configuration
|
|
64
119
|
|
|
65
|
-
The configuration file is located at `~/.morpheus/config.yaml`. You can edit it manually or use the
|
|
120
|
+
The configuration file is located at `~/.morpheus/config.yaml`. You can edit it manually or use the `morpheus config` command.
|
|
66
121
|
|
|
67
122
|
```yaml
|
|
68
123
|
agent:
|