nsflow - A FastAPI powered client and IDE for Neuro-San
A fastapi and react based developer-oriented client and IDE that enables users to explore, visualize, and interact with smart agent networks. It integrates with NeuroSan for intelligent agent-based interactions.
Intro
nsflow comes with an Agent Network Designer that embodies the agentic design philosophy, making the neuro-san
library accessible to both developers and non-developers alike. This transforms nsflow from a simple interactive chat
client into a well-featured agent orchestration platform with visual design capabilities.
Enabling/Disabling text-to-speech and speech-to-text
For local development (when running the backend and frontend separately), you can toggle text-to-speech and speech-to-text by setting the VITE_USE_SPEECH variable in the nsflow/frontend/.env.development file to "true" or "false". The frontend development server reads this file directly.
Installation & Running nsflow
nsflow can be installed and run in two different ways:
1️⃣ Run nsflow using pypi package
To simplify execution, nsflow provides a CLI command to start both the backend and frontend simultaneously.
Step 1: Create and source a virtual environment
python -m venv .venv
source .venv/bin/activate
Step 2: Install nsflow from pip
pip install nsflow
Step 3: Run Everything with a Single Command
python -m nsflow.run
By default, this will start:
- backend (FastAPI + NeuroSan) here:
http://127.0.0.1:4173/docsorhttp://127.0.0.1:4173/redoc - frontend (React) here:
http://127.0.0.1:4173
2️⃣ Development & Contribution (Manually Start Frontend & Backend)
If you want to contribute, ensure you have the necessary dependencies installed. To start the frontend and backend separately, follow these steps:
Step 1: Clone the Repository
git clone https://github.com/cognizant-ai-lab/nsflow.git
cd nsflow
Step 2: Install Dependencies
-
Make sure you have Python 3.12 or newer installed.
python -m venv .venv source .venv/bin/activate pip install -r requirements.txt pip install -r requirements-build.txt
Step 3: Start the Backend in dev mode & Frontend separately
-
Ensure that you have a few example hocon files in your
registriesand the same mapped inregistries/manifest. -
[Optional] Ensure that you have the necessary coded tools in the
coded_toolsdir. -
From the root start Backend:
python -m nsflow.run --dev
-
Start Frontend:
-
Ensure that you have Node.js (with Yarn) installed.
-
Follow the instructions to setup the frontend here: ./nsflow/frontend/README.md
-
On another terminal window
cd nsflow/frontend; yarn install yarn dev
-
-
By default:
- backend will be available at:
http://127.0.0.1:8005 - frontend will be available at:
http://127.0.0.1:5173 - You may change the host/port configs using environment variables for fastapi (refer run.py) and using frontend/.env.development for react app
- backend will be available at:
Step 4
To make sure your changes to frontend take effect in the wheel, run the script
-
To build the Frontend
sh build_scripts/build_frontend.sh
Note: The above script's output should show that ./nsflow dir contains a module prebuilt_frontend
-
To build and test the wheel locally
sh build_scripts/build_wheel.sh
For using Text-to-Speech and Speech-to-Text
Prerequisite: install ffmpeg for text-to-speech and speech-to-text support
- On Mac
brew install ffmpeg
- On Linux
sudo apt install ffmpeg
- On windows, follow the instructions here.
Enabling Visual Question Answering (VQA) http endpoints
Follow these instructions
Connecting OAuth-protected MCP servers
Connect MCP servers that require OAuth (e.g. You.com, Linear, GitHub, Salesforce) from the Connectors tab — nsflow runs the OAuth flow, stores the tokens locally, and injects them into agent networks automatically. See these instructions.
2 maintainers
Metadata
2 maintainers
Release files for nsflow 0.7.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| nsflow-0.7.4.tar.gz | 837.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nsflow-0.7.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.7 MB
Release files / nsflow-0.7.4.tar.gz
| Download URL | nsflow-0.7.4.tar.gz |
|---|---|
| Size | 837.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
67f3ccddd60042652d73e931b3fe3095e76827c605f10732718d857009ab87a6
|
|
BLAKE2b-256 checksum How to use checksums |
6324e11ce211becdc00d99268c5a040a73e4b9ffaeb4c4173ffad723e1c78145
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 1, 2026.
Transparency logRelease files / nsflow-0.7.4-py3-none-any.whl
| Download URL | nsflow-0.7.4-py3-none-any.whl |
|---|---|
| Size | 862.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
36510dec0f2013211956d6470c16f183bf5478cbbb0a497d15d5b7641c389342
|
|
BLAKE2b-256 checksum How to use checksums |
e216a0e4015245d86a014af8e1d32186d57f882f4f67765c238b9befb9f1d554
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 1, 2026.
Transparency log
