create-syrinx-agent 4.4.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/LICENSE +22 -0
- package/README.md +91 -0
- package/dist/index.js +1100 -0
- package/dist/index.js.map +7 -0
- package/package.json +45 -0
- package/src/cli.ts +76 -0
- package/src/exit-codes.ts +20 -0
- package/src/generate.ts +35 -0
- package/src/help.ts +45 -0
- package/src/index.ts +16 -0
- package/src/options.test.ts +130 -0
- package/src/options.ts +176 -0
- package/src/providers/realtime.ts +31 -0
- package/src/providers/reasoner.ts +69 -0
- package/src/providers/stt.ts +68 -0
- package/src/providers/tts.ts +69 -0
- package/src/providers/types.ts +58 -0
- package/src/providers/vad-endpointing.ts +36 -0
- package/src/templates/agent-module.ts +188 -0
- package/src/templates/agents-md.ts +65 -0
- package/src/templates/cloudflare-worker.ts +172 -0
- package/src/templates/dev-server.ts +104 -0
- package/src/templates/env-example.ts +58 -0
- package/src/templates/fixture.ts +34 -0
- package/src/templates/package-json.ts +119 -0
- package/src/templates/tsconfig.ts +25 -0
- package/src/version.ts +5 -0
- package/src/write-project.test.ts +163 -0
- package/src/write-project.ts +59 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Kuralle
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
package/README.md
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# create-syrinx-agent
|
|
2
|
+
|
|
3
|
+
Scaffold a [Syrinx](https://github.com/kuralle/syrinx) voice agent project.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm create syrinx-agent my-agent -- --stt deepgram --reasoner aisdk --tts cartesia
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
One generator with conditional emission, not a directory of templates. You pick a provider
|
|
10
|
+
per pipeline stage and get back a project that depends on **exactly those** providers, with
|
|
11
|
+
a `.env.example` naming exactly the keys they need.
|
|
12
|
+
|
|
13
|
+
## Pick a pipeline
|
|
14
|
+
|
|
15
|
+
**Cascade** — speech in, text through a reasoner, speech out:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm create syrinx-agent my-agent -- \
|
|
19
|
+
--stt deepgram --reasoner aisdk --tts cartesia
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
| Flag | Options |
|
|
23
|
+
| --- | --- |
|
|
24
|
+
| `--stt` | `deepgram` · `google` · `elevenlabs` · `grok` |
|
|
25
|
+
| `--tts` | `cartesia` · `elevenlabs` · `gemini` · `openai-tts` · `grok` |
|
|
26
|
+
| `--reasoner` | `aisdk` (any `ai@6` model) · `kuralle` · `mastra` |
|
|
27
|
+
| `--vad` | `silero-vad` — optional; provider STT owns it by default |
|
|
28
|
+
| `--endpointing` | `pipecat-smart-turn` · `vap` — optional |
|
|
29
|
+
|
|
30
|
+
**Speech-to-speech** — one model hears and speaks, no separate stages:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npm create syrinx-agent my-agent -- --realtime realtime
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
`--realtime` is exclusive with `--stt`/`--tts`, and passing them together is refused rather
|
|
37
|
+
than silently ignored — a speech-to-speech pipeline has no separate stages to configure.
|
|
38
|
+
|
|
39
|
+
## Transport and runtime
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
--transport browser|twilio|telnyx|smartpbx # default: browser
|
|
43
|
+
--runtime node|cloudflare # default: node
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
`--runtime cloudflare --transport telnyx` generates, but warns: Telnyx is not yet bound on
|
|
47
|
+
the Workers edge, so that combination is deploy-unverified.
|
|
48
|
+
|
|
49
|
+
## Presets
|
|
50
|
+
|
|
51
|
+
Flag bundles, and an explicit flag always wins:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npm create syrinx-agent support-line -- --preset phone --tts elevenlabs
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Other options
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
--name <project-name> default: the target directory's basename
|
|
61
|
+
--yes accept defaults, never prompt
|
|
62
|
+
--no-install write the project, skip npm install
|
|
63
|
+
--dry-run print the file list and exit
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## What you get
|
|
67
|
+
|
|
68
|
+
```
|
|
69
|
+
src/agent.ts createAgent() — the --agent seam's factory export
|
|
70
|
+
scripts/dev-server.ts pnpm dev — local server, mic in the browser
|
|
71
|
+
test/fixtures/ a fixture for the headless check
|
|
72
|
+
.env.example exactly the keys your combination needs
|
|
73
|
+
AGENTS.md what a coding agent can and cannot verify here
|
|
74
|
+
package.json only the providers you chose
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
The generated project wires to the same `--agent <module>#<export>` seam that Syrinx's dev
|
|
78
|
+
server and [`@kuralle-syrinx/cli`](https://www.npmjs.com/package/@kuralle-syrinx/cli) use, so
|
|
79
|
+
`pnpm dev` and `syrinx turn` drive the identical agent.
|
|
80
|
+
|
|
81
|
+
## Two operators
|
|
82
|
+
|
|
83
|
+
The generated `AGENTS.md` is written for a coding agent, and it is explicit about the line
|
|
84
|
+
it cannot cross. An agent can assert transcripts, exit codes and latency numbers. It cannot
|
|
85
|
+
judge whether barge-in feels natural, whether a pause reads as thinking or as a hang, or
|
|
86
|
+
whether a voice sounds warm. Those need a person listening in the studio, and pretending
|
|
87
|
+
otherwise is how a green check becomes false confidence.
|
|
88
|
+
|
|
89
|
+
## License
|
|
90
|
+
|
|
91
|
+
MIT
|