@praesidia/neurogent 0.1.0 → 0.2.0
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 +153 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
# @praesidia/neurogent
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@praesidia/neurogent)
|
|
4
|
+
[](https://github.com/praesidia/neurogent/blob/main/LICENSE)
|
|
5
|
+
[](https://www.typescriptlang.org/)
|
|
6
|
+
|
|
7
|
+
**Multi-agent terminal shell and SDK for building A2A-ready AI agents** — run a team of specialists in one TUI session, or scaffold, develop, and ship agents with a single CLI.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @praesidia/neurogent
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Global CLI (recommended for `neurogent` / `neurogent-shell` on your `PATH`):
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install -g @praesidia/neurogent
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**Requirements:** Node.js **20+** (ESM). Set **`ANTHROPIC_API_KEY`** and/or **`OPENAI_API_KEY`** in your environment.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## What ships in this package
|
|
28
|
+
|
|
29
|
+
| Surface | Command or import | Purpose |
|
|
30
|
+
|--------|-------------------|---------|
|
|
31
|
+
| **Shell** | `neurogent-shell` | Full-screen multi-agent terminal (Ink/React). |
|
|
32
|
+
| **CLI** | `neurogent` | Scaffold projects, dev server, build AgentCard, deploy, ZeroClaw lifecycle, registry. |
|
|
33
|
+
| **Library** | `@praesidia/neurogent` | `createAgent`, tools, memory, MCP client, ZeroClaw runtime, types. |
|
|
34
|
+
| **Security** | `@praesidia/neurogent/security` | `PraesidiaHooks`, policy parsing (tree-shake friendly entry). |
|
|
35
|
+
|
|
36
|
+
Example YAML configs are included under **`examples/`** in the published tarball (see [Examples](#examples)).
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## Quick start: multi-agent shell
|
|
41
|
+
|
|
42
|
+
Point the shell at a bundled example (paths differ slightly for global vs local install).
|
|
43
|
+
|
|
44
|
+
**Global install:**
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
export ANTHROPIC_API_KEY=sk-ant-...
|
|
48
|
+
|
|
49
|
+
neurogent-shell --config "$(npm root -g)/@praesidia/neurogent/examples/dev-trio.yaml"
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
**Local install in a project:**
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
export ANTHROPIC_API_KEY=sk-ant-...
|
|
56
|
+
|
|
57
|
+
npx neurogent-shell --config ./node_modules/@praesidia/neurogent/examples/dev-trio.yaml
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
**Built-in packs** (copy into your repo):
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
neurogent-shell packs
|
|
64
|
+
neurogent-shell install dev-trio
|
|
65
|
+
# then: neurogent-shell --config ./dev-trio.yaml # or the path printed by install
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## CLI overview
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
neurogent --help
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
| Command | Description |
|
|
77
|
+
|---------|-------------|
|
|
78
|
+
| `neurogent init` | Scaffold a new Neuro agent project. |
|
|
79
|
+
| `neurogent dev` | Start a local A2A server with hot reload. |
|
|
80
|
+
| `neurogent build` | Validate config and generate an AgentCard. |
|
|
81
|
+
| `neurogent deploy` | Generate production Docker artifacts. |
|
|
82
|
+
| `neurogent register` | Publish your AgentCard to an A2A directory registry. |
|
|
83
|
+
| `neurogent start` | Start persistent ZeroClaw agent servers from a config file. |
|
|
84
|
+
| `neurogent connect` | Connect the shell to a remote ZeroClaw agent server. |
|
|
85
|
+
| `neurogent status` | Show health status of registered ZeroClaw agents. |
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## Programmatic usage
|
|
90
|
+
|
|
91
|
+
ESM only (`"type": "module"`).
|
|
92
|
+
|
|
93
|
+
### Agent, tools, and memory
|
|
94
|
+
|
|
95
|
+
```ts
|
|
96
|
+
import {
|
|
97
|
+
createAgent,
|
|
98
|
+
Tool,
|
|
99
|
+
ConversationBufferMemory,
|
|
100
|
+
parseAgentConfig,
|
|
101
|
+
} from '@praesidia/neurogent';
|
|
102
|
+
|
|
103
|
+
const config = parseAgentConfig(/* YAML string or object */);
|
|
104
|
+
const agent = createAgent(config);
|
|
105
|
+
// Use Tool, memory helpers, and streaming per your setup.
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### ZeroClaw (persistent runtime)
|
|
109
|
+
|
|
110
|
+
```ts
|
|
111
|
+
import {
|
|
112
|
+
createAgentServer,
|
|
113
|
+
sendMessage,
|
|
114
|
+
pingAgent,
|
|
115
|
+
} from '@praesidia/neurogent';
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### Security hooks (optional dedicated import)
|
|
119
|
+
|
|
120
|
+
```ts
|
|
121
|
+
import { PraesidiaHooks, parsePolicy } from '@praesidia/neurogent/security';
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
Types are published with the package (`dist/*.d.ts`).
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## Examples
|
|
129
|
+
|
|
130
|
+
These files are published with the package:
|
|
131
|
+
|
|
132
|
+
| File | Use |
|
|
133
|
+
|------|-----|
|
|
134
|
+
| `examples/dev-trio.yaml` | Small engineering + security + review team. |
|
|
135
|
+
| `examples/dev-trio-openai.yaml` | Same idea, OpenAI-oriented. |
|
|
136
|
+
| `examples/full-team.yaml` | Larger multi-agent org. |
|
|
137
|
+
| `examples/marketing-team.yaml` | Marketing-focused agents. |
|
|
138
|
+
| `examples/solo-researcher.yaml` | Single deep-research agent. |
|
|
139
|
+
|
|
140
|
+
Use them as `--config` for `neurogent-shell` or as templates for your own YAML.
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## Documentation and support
|
|
145
|
+
|
|
146
|
+
- **Repository & full guide:** [github.com/praesidia/neurogent](https://github.com/praesidia/neurogent)
|
|
147
|
+
- **Issues:** [github.com/praesidia/neurogent/issues](https://github.com/praesidia/neurogent/issues)
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
## License
|
|
152
|
+
|
|
153
|
+
MIT. See the [license file](https://github.com/praesidia/neurogent/blob/main/LICENSE) in the repository.
|