synapse-orch-ai 2.0.8 → 2.0.9
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
CHANGED
|
@@ -5,34 +5,63 @@
|
|
|
5
5
|
</p>
|
|
6
6
|
|
|
7
7
|
<p align="center">
|
|
8
|
-
<a href="https://synapseorch.com"><img src="https://img.shields.io/badge/Website-synapseorch.com-0f71b0" alt="Website"></a>
|
|
9
|
-
<a href="https://docs.synapseorch.com"><img src="https://img.shields.io/badge/Docs-docs.synapseorch.com-0f71b0" alt="Docs"></a>
|
|
10
|
-
<a href="https://discord.gg/9UN45qyGh8"><img src="https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white" alt="Discord"></a>
|
|
11
|
-
<a href="https://github.com/synapseorch-ai/synapse-ai"><img src="https://img.shields.io/github/stars/synapseorch-ai/synapse-ai?style=social" alt="GitHub stars"></a>
|
|
12
|
-
<br />
|
|
13
|
-
<a href="https://pypi.org/project/synapse-orch-ai/"><img src="https://img.shields.io/pypi/v/synapse-orch-ai?logo=pypi&logoColor=white&label=pypi&color=0f71b0" alt="PyPI"></a>
|
|
14
|
-
<a href="https://www.npmjs.com/package/synapse-orch-ai"><img src="https://img.shields.io/npm/v/synapse-orch-ai?logo=npm&label=npm&color=0f71b0" alt="npm"></a>
|
|
15
|
-
<a href="https://hub.docker.com/r/synapseorchai/synapse-ai"><img src="https://img.shields.io/docker/pulls/synapseorchai/synapse-ai?logo=docker&logoColor=white&label=docker&color=0f71b0" alt="Docker pulls"></a>
|
|
16
8
|
<a href="LICENSE"><img src="https://img.shields.io/badge/license-AGPL--3.0-0f71b0" alt="License: AGPL-3.0"></a>
|
|
9
|
+
<a href="https://pypi.org/project/synapse-orch-ai/"><img src="https://img.shields.io/pypi/v/synapse-orch-ai?label=pypi&color=0f71b0" alt="PyPI version"></a>
|
|
10
|
+
<a href="https://discord.gg/9UN45qyGh8"><img src="https://img.shields.io/badge/Discord-join-5865F2?logo=discord&logoColor=white" alt="Discord"></a>
|
|
17
11
|
</p>
|
|
18
12
|
|
|
19
|
-
**
|
|
13
|
+
**SynapseOrch builds and runs AI workflows that take a fixed path.** Describe a job in plain words and it shows you a
|
|
14
|
+
plan: the steps, the model for each, what a run should cost, and where a person signs off. Nothing is built until you
|
|
15
|
+
approve it, and every run then follows that path. Models do the work inside the steps; they don't decide which step
|
|
16
|
+
comes next.
|
|
20
17
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
18
|
+
**It's for** developers and automation builders, working for their own team or for clients, who need an AI workflow
|
|
19
|
+
to behave the same on its fiftieth run as on its first. Self-hosted, any model, AGPL-3.0: no account, no licence
|
|
20
|
+
check, no telemetry.
|
|
24
21
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
22
|
+
## Install
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
curl -LsSf https://synapseorch.com/install.sh | bash # macOS, Linux
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
```powershell
|
|
29
|
+
irm https://synapseorch.com/install.ps1 | iex # Windows (PowerShell)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
It brings its own Python (and Node.js, if yours is missing or older than 20.9), needs no sudo, keeps everything in
|
|
33
|
+
`~/.synapse`, and ends with a link to open. [pip, npm and Docker ↓](#more-ways-to-install)
|
|
34
|
+
|
|
35
|
+
## Your first workflow, without an account
|
|
36
|
+
|
|
37
|
+
1. **Choose a model when the installer asks "Which AI should Synapse use?"** Synapse AI, the assistant that builds
|
|
38
|
+
workflows from a description, needs a capable model: paste a key for Anthropic, OpenAI, Gemini, Groq, OpenRouter,
|
|
39
|
+
DeepSeek, Mistral or another provider. No key yet? A free Gemini key from
|
|
40
|
+
[Google AI Studio](https://aistudio.google.com/apikey) takes a few minutes (your prompts go to Google).
|
|
41
|
+
2. **Open the link it prints.** Synapse AI's chat opens. Describe a job, for example: *"Every weekday at 9, read the
|
|
42
|
+
Hacker News front page, pick the three stories about AI agents, summarise each in two lines, and ask me before
|
|
43
|
+
saving the summary to the vault."*
|
|
44
|
+
3. **Read the plan, approve it, then run the workflow.** The run stops at your sign-off: answer it under **Needs
|
|
45
|
+
you** on Home, or from the terminal with `synapse runs answer`.
|
|
31
46
|
|
|
32
|
-
|
|
47
|
+
**Only local models?** The installer finds [Ollama](https://ollama.com/download) and its models, and workflow steps
|
|
48
|
+
run well on them, with your prompts staying on your machine. Building with Synapse AI on a small local model doesn't
|
|
49
|
+
work well yet, so draw the workflow in the editor, or give Synapse AI a hosted model in Settings → Models and keep
|
|
50
|
+
the steps local. [Models and providers →](https://docs.synapseorch.com/llm-providers/overview)
|
|
51
|
+
|
|
52
|
+
<!-- DEMO VIDEO: a shorter MP4 can replace the GIF: drag demo.mp4 into a GitHub comment box, and paste the user-attachments link it gives on its own line here, so it plays inline. -->
|
|
33
53
|
|
|
34
54
|
<p align="center">
|
|
35
55
|
<img src="https://raw.githubusercontent.com/synapseorch-ai/synapse-ai/master/.github/assets/readme/demo.gif" alt="One sentence to Synapse AI: it asks where the notes live, shows a plan with its cost, and builds the workflow; then the workflow runs, waits for you to approve the summary and the save, and finishes with what each step cost" width="100%" />
|
|
56
|
+
<br />
|
|
57
|
+
<sub>A real session on a hosted Claude model, the model’s waits sped up: one sentence to a built workflow, then a run that waits for a sign-off.</sub>
|
|
58
|
+
</p>
|
|
59
|
+
|
|
60
|
+
<p align="center">
|
|
61
|
+
<a href="https://docs.synapseorch.com"><strong>Documentation</strong></a> ·
|
|
62
|
+
<a href="#how-it-compares"><strong>How it compares</strong></a> ·
|
|
63
|
+
<a href="https://discord.gg/9UN45qyGh8"><strong>Discord</strong></a> ·
|
|
64
|
+
<a href="https://synapseorch.com/cloud"><strong>SynapseOrch Cloud</strong></a>
|
|
36
65
|
</p>
|
|
37
66
|
|
|
38
67
|
---
|
|
@@ -44,7 +73,7 @@ Free and open source under AGPL-3.0, with no account and no licence check.
|
|
|
44
73
|
- **Approve it.** Read every step. When a run reaches yours, it waits for your yes — in the app, or in Slack,
|
|
45
74
|
Telegram or another chat channel.
|
|
46
75
|
- **Rely on it.** It runs on schedule exactly as you approved, and shows what each step did and what it cost. A run
|
|
47
|
-
|
|
76
|
+
stops once it reaches the spending limit you set.
|
|
48
77
|
|
|
49
78
|
<table>
|
|
50
79
|
<tr>
|
|
@@ -75,32 +104,35 @@ Free and open source under AGPL-3.0, with no account and no licence check.
|
|
|
75
104
|
| **Apps and tools** | MCP servers (local or remote, OAuth included), REST and OpenAPI, Python functions, SQL databases, web fetch and scraping. |
|
|
76
105
|
| **Channels** | Your agents on Slack, Discord, Telegram, Microsoft Teams, WhatsApp, a website chat widget, or a phone number (Twilio). |
|
|
77
106
|
| **Any model** | Your own keys for 23+ providers, any OpenAI-compatible endpoint, local models through Ollama, or the Claude Code, Codex, Gemini and Copilot CLIs you already use. A different model at every step. |
|
|
78
|
-
| **Costs you can read** | An estimate before a run, what each step cost after it, and a
|
|
107
|
+
| **Costs you can read** | An estimate before a run, what each step cost after it, and a spending cap per run, checked before each step. |
|
|
79
108
|
| **Use it from anywhere** | A command line, a versioned REST API, an MCP server for Claude, ChatGPT and Cursor, and an OpenAI-compatible endpoint where every agent answers as a model. |
|
|
80
109
|
| **Scale mode** | Redis queue, a worker fleet, Postgres checkpoints and S3 storage, for when one process is not enough. |
|
|
81
110
|
|
|
82
|
-
|
|
111
|
+
## How it compares
|
|
83
112
|
|
|
84
|
-
|
|
113
|
+
| | What it is | You build it by | Licence |
|
|
114
|
+
|---|---|---|---|
|
|
115
|
+
| **SynapseOrch** | An app that builds and runs AI workflows, with a UI, REST API, CLI and MCP server | Describing it (Synapse AI drafts a plan you approve) or drawing it | AGPL-3.0 |
|
|
116
|
+
| n8n | A workflow automation app with 500+ integrations | Drawing it, code nodes, or its Assistant (in preview) | Sustainable Use License (source-available) |
|
|
117
|
+
| Dify | An LLM app platform with a visual workflow canvas | Drawing it | Apache 2.0 with added conditions |
|
|
118
|
+
| LangGraph | A library for agent graphs in Python and JavaScript | Writing code | MIT |
|
|
119
|
+
| CrewAI | A Python framework for teams of agents | Writing code | MIT |
|
|
120
|
+
| Temporal | A durable-execution engine for workflows written in code | Writing code | MIT |
|
|
85
121
|
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
```
|
|
122
|
+
If you need hundreds of ready integrations, n8n has far more than we do. If an engineer will own the agent in code,
|
|
123
|
+
a library is the better fit, and your code can still start SynapseOrch runs through the API. Where each one is the
|
|
124
|
+
better choice: [synapseorch.com/compare](https://synapseorch.com/compare/).
|
|
90
125
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
```
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## More ways to install
|
|
95
129
|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
and [setup.ps1](https://github.com/synapseorch-ai/synapse-ai/releases/latest/download/setup.ps1).
|
|
130
|
+
The one-line installer above asks which AI to use (and whether to start on login) while it installs; add `--yes`
|
|
131
|
+
(`curl … | bash -s -- --yes`) to take every default. The short addresses redirect to the scripts on the latest GitHub
|
|
132
|
+
release: [setup.sh](https://github.com/synapseorch-ai/synapse-ai/releases/latest/download/setup.sh) and
|
|
133
|
+
[setup.ps1](https://github.com/synapseorch-ai/synapse-ai/releases/latest/download/setup.ps1).
|
|
101
134
|
|
|
102
|
-
|
|
103
|
-
<summary><strong>npm, pip or Docker</strong></summary>
|
|
135
|
+
**npm, pip or Docker**
|
|
104
136
|
|
|
105
137
|
```bash
|
|
106
138
|
npm install -g synapse-orch-ai && synapse # the first run uses the same installer
|
|
@@ -116,7 +148,6 @@ docker run -d --name synapse -p 3000:3000 -p 127.0.0.1:8765:8765 \
|
|
|
116
148
|
|
|
117
149
|
Then open `http://localhost:3000`. The backend's port (`8765`) is published on this machine only: it serves an
|
|
118
150
|
internal API, so never publish it on `0.0.0.0`.
|
|
119
|
-
</details>
|
|
120
151
|
|
|
121
152
|
**Optional parts.** Knowledge brings Docling and a CPU build of PyTorch, so it is added only when you ask:
|
|
122
153
|
|
|
Binary file
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
2ce89537e38caa2957a24dfa97f6465a35c237f2ab993ade98bc7342efcea8bd synapse-install.pyz
|