OopenJiuwen-botdocs(jiuwenswarm): Update documents related to JiuwenSwarm

JiuwenSwarm install guide

Important: Finishing installation does not mean the app is ready to use. You must complete model configuration first. See Configuration (Chinese) for model setup.

Prerequisites

Before installing JiuwenSwarm, make sure your system meets the following requirements:

Dependency	Version	Notes
OS	Windows 10/11, macOS 10.15+, Linux	Common desktop OS supported
Python	≥3.11, below 3.14	Python 3.11 recommended
Node.js	18.x or newer	Used for the web UI
Git	Latest	Required for source install

Environment check

Run these commands in a terminal:

# Check Python
python --version
# Expect: Python 3.11.x or Python 3.12.x

# Check Node.js
node --version
# Expect: v18.x.x or newer

# Check Git
git --version
# Expect: git version 2.x.x

First-time installation

Option 1: pip install

1. Installation steps

# Create a virtual environment (recommended)
python -m venv jiuwenswarm-env

# Activate the virtual environment
# Windows:
jiuwenswarm-env\Scripts\activate
# macOS/Linux:
source jiuwenswarm-env/bin/activate

# Install JiuwenSwarm
pip install jiuwenswarm

2. First launch

# Initialize JiuwenSwarm (first run)
jiuwenswarm-init
# Start JiuwenSwarm
jiuwenswarm-start

After the first start, the app creates the config directory ~/.jiuwenswarm/.

3. Post-start verification

After a successful start, verify the installation:

Open the Web UI: in your browser go to http://localhost:5173
Open configuration: in the left sidebar choose Configuration
Configure the model: follow Configuration to set up your model API
Confirm it works:
- The Web UI loads
- After model configuration you can run a basic chat (tools/MCP may be used depending on your setup)

Example: Web UI connected with a successful verification chat

💡 Tip: If the Web UI does not load, check ~/.jiuwenswarm/logs/ for errors.

4. Restarting the service

If you closed JiuwenSwarm and want to run it again:

# Start again
jiuwenswarm-start

Option 2: Install from source (uv)

1. Environment setup

Install uv first. If it is not installed, follow the uv documentation.

# Check that uv is installed
uv --version
# Expect: uv 0.x.x

2. Clone and install

# Clone the repository
git clone https://gitcode.com/openJiuwen/jiuwenswarm.git

# Enter project directory
cd jiuwenswarm

# Create venv and install dependencies with uv
uv venv
uv pip install -e .

3. Build the front end

⚠️ Important: With a source (editable) install you must build the front end manually, or startup will fail with dist directory not found.

# Enter front-end directory (repo root is jiuwenswarm)
cd jiuwenswarm/channels/web

# Install front-end dependencies
npm install

# Build
npm run build

# Copy build output into the user workspace
# Windows:
xcopy /E /I dist %USERPROFILE%\.jiuwenswarm\channels\web\frontend\dist
# macOS/Linux:
cp -r dist ~/.jiuwenswarm/channels/web/frontend/dist

# Back to repo root
cd ..

Notes:

uv pip install -e . is an editable install that points at your source tree.
web/dist is ignored by .gitignore and is not shipped in the repo.
You must build and copy artifacts to ~/.jiuwenswarm/channels/web/frontend/dist.

4. First launch

# Activate virtual environment
# Windows:
.venv\Scripts\activate
# macOS/Linux:
source .venv/bin/activate

# Initialize JiuwenSwarm (first run)
jiuwenswarm-init
# Start
jiuwenswarm-start

5. Post-start verification (same as Option 1)

Use the checklist under Post-start verification.

6. Restarting the service

# After activating the virtual environment
jiuwenswarm-start

Option 3: Install from source (conda)

1. Environment setup

Install conda first. If it is not installed, follow the Miniconda documentation.

# Check that conda is installed
conda --version
# Expect: conda 23.x.x or newer

2. Create the conda environment

# Create environment
conda create -n jiuwenswarm python=3.11

# Initialize conda (first time)
conda init
# After init, close the window and open a new session before activate

# Activate environment
conda activate jiuwenswarm

3. Clone and install

# Clone the repository
git clone https://gitcode.com/openJiuwen/jiuwenswarm.git

# Enter project directory
cd jiuwenswarm

# Install dependencies
pip install -e .

4. Build the front end

⚠️ Important: With a source (editable) install you must build the front end manually, or startup will fail with dist directory not found.

# Enter front-end directory (repo root is jiuwenswarm)
cd jiuwenswarm/channels/web

# Install front-end dependencies
npm install

# Build
npm run build

# Copy build output into the user workspace
# Windows:
xcopy /E /I dist %USERPROFILE%\.jiuwenswarm\channels\web\frontend\dist
# macOS/Linux:
cp -r dist ~/.jiuwenswarm/channels/web/frontend/dist

# Back to repo root
cd ..

Notes:

pip install -e . is an editable install that points at your source tree.
web/dist is ignored by .gitignore and is not shipped in the repo.
You must build and copy artifacts to ~/.jiuwenswarm/channels/web/frontend/dist.

5. First launch

# Initialize JiuwenSwarm (first run)
jiuwenswarm-init
# Start
jiuwenswarm-start

6. Post-start verification (same as Option 1)

Use the checklist under Post-start verification.

7. Restarting the service

# Activate environment, then start
conda activate jiuwenswarm
jiuwenswarm-start

Version upgrades

Current range	Approach	Notes
Routine (e.g. 0.1.8 → 0.1.9, does not cross 0.1.7)	Routine version upgrades	Upgrade directly; no backup required
Major (e.g. <0.1.7 → ≥0.1.7, crosses 0.1.7)	Major version upgrades	Back up data first

Routine version upgrades

pip install upgrade

# Activate your virtual environment
# Then upgrade
pip install --upgrade jiuwenswarm

Source install upgrade

# Enter project directory
cd jiuwenswarm

# Pull latest
git pull

# Reinstall
pip install -e .

# Rebuild the front end (if it was updated)
cd jiuwenswarm/channels/web
npm install
npm run build

# Copy build output
# Windows:
xcopy /E /I dist %USERPROFILE%\.jiuwenswarm\channels\web\frontend\dist
# macOS/Linux:
cp -r dist ~/.jiuwenswarm/channels/web/frontend/dist

cd ..

Major version upgrades

⚠️ Always back up your data before upgrading across major versions.

1. Data backup

Windows:

# Back up the whole config and data directory
xcopy "%USERPROFILE%\.jiuwenswarm" "%USERPROFILE%\.jiuwenswarm_backup" /E /I

# Or with PowerShell (recommended)
Copy-Item -Path "$env:USERPROFILE\.jiuwenswarm" -Destination "$env:USERPROFILE\.jiuwenswarm_backup" -Recurse

macOS/Linux:

# Back up the whole config and data directory
cp -r ~/.jiuwenswarm ~/.jiuwenswarm_backup

# Or with rsync (recommended; preserves permissions)
rsync -av ~/.jiuwenswarm ~/.jiuwenswarm_backup

What to back up:

Path	Description
`config/config.yaml`	Main config (models, API keys, etc.)
`config/.env`	Environment variables
`agent/memory/`	User memory data
`agent/home/`	Identity and task data
`agent/skills/`	Skills library (custom skills and config)
`agent/workspace/`	Workspace files

2. Perform the upgrade

Pick the steps that match how you installed JiuwenSwarm:

pip install upgrade

Follow the same steps as Routine version upgrade – pip install upgrade (activate your virtual environment, then run pip install --upgrade jiuwenswarm).

Source install upgrade

Follow the same steps as Routine version upgrade – source install upgrade (pull, reinstall, rebuild the front end when needed, and copy dist as described there).

3. Data migration

After upgrading, migrate data so config and stores match the new version.

Step 1: Review config changes

# View the new config template (source install)
cat docs/config_template.yaml

# Or read the changelog
# https://gitcode.com/openJiuwen/jiuwenswarm/blob/develop/docs/CHANGELOG.md

Step 2: Migrate configuration

Compare old and new config shape

New releases may add or remove options. Check:
- New required keys in config.yaml
- New variables in .env
- Deprecated or renamed keys

Migrate by hand

# Back up the new default config
cp ~/.jiuwenswarm/config/config.yaml ~/.jiuwenswarm/config/config.yaml.new

# Restore from backup (use with care)
# Prefer diff/merge in an editor instead of blind overwrite

Common migration cases

Case	What to do
New model support	Add the new model block in `config.yaml`
API endpoint change	Update URLs in `.env`
Renamed keys	Map old → new using the changelog
Removed keys	Delete obsolete entries

Step 3: Migrate memory data

Memory is usually backward compatible; still verify:

# Inspect memory layout
ls ~/.jiuwenswarm/agent/memory/

# If something looks wrong, restore from backup
cp -r ~/.jiuwenswarm_backup/agent/memory/* ~/.jiuwenswarm/agent/memory/

Step 4: Verify migration

# Start the service
jiuwenswarm-start

# Watch logs for config errors
# Logs: ~/.jiuwenswarm/logs/

Migration checklist:

Service starts cleanly
Model config works (chat OK)
Historical memory is readable
Custom settings carried over
No serious errors or warnings

FAQ

Q: On start I see "Python version not supported"

Use Python ≥3.11 and below 3.14 (e.g. 3.11, 3.12, or 3.13).

Q: On start I see "Node.js not found"

Install Node.js 18.x or newer.

Q: How do I check the installed version?

jiuwenswarm --version

Q: How do I uninstall?

pip uninstall jiuwenswarm

Repository: https://gitcode.com/openJiuwen/jiuwenswarm
Issues: https://gitcode.com/openJiuwen/jiuwenswarm/issues
Docs: https://gitcode.com/openJiuwen/jiuwenswarm/tree/develop/docs

Last updated: 2026-05-08

JiuwenSwarm install guide

Prerequisites

Environment check

First-time installation

Option 1: pip install

1. Installation steps

2. First launch

3. Post-start verification

4. Restarting the service

Option 2: Install from source (uv)

1. Environment setup

2. Clone and install

3. Build the front end

4. First launch

5. Post-start verification (same as Option 1)

6. Restarting the service

Option 3: Install from source (conda)

1. Environment setup

2. Create the conda environment

3. Clone and install

4. Build the front end

5. First launch

6. Post-start verification (same as Option 1)

7. Restarting the service

Version upgrades

Routine version upgrades

pip install upgrade

Source install upgrade

Major version upgrades

1. Data backup

2. Perform the upgrade

pip install upgrade

Source install upgrade

3. Data migration

Step 1: Review config changes

Step 2: Migrate configuration

Step 3: Migrate memory data

Step 4: Verify migration

FAQ

Q: On start I see "Python version not supported"

Q: On start I see "Node.js not found"

Q: How do I check the installed version?

Q: How do I uninstall?

Related links