tmpl/multi-agent-mux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add Step 0 provisioning to BOOTSTRAP.md and update README.md with curl installer

Browse Source
This commit is contained in:
Godopu
2026-06-28 09:34:52 +09:00
parent dd9500a271
commit 81474ac3f7
3 changed files with 72 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
BOOTSTRAP.md
+27 -9
View File
@@ -31,11 +31,29 @@ Before cloning this project into a new environment, you must first understand th
---
## 2. Environment Configuration (.env)
## 2. Workspace Provisioning (Step 0 — Reference Only)
Before any agent can read this guide, the workspace must be provisioned. This step has already been performed by the human developer using the installer. It is documented here strictly as a reference for verifying agents to understand how the assets arrived.
### Step 0.1: Run the Installer One-Liner (Pre-Cloned/Provisioned)
The human developer bootstrapped the workspace by running:
```bash
curl -fsSL https://git.godopu.com/tmpl/multi-agent-mux/raw/branch/main/deploy/install.sh | bash
```
The installer verified system dependencies, staged the repository, copied the runtime `.agents/` scaffolding and documentation files (including this `BOOTSTRAP.md`), and set up the default `.env` and `.venv` environments.
> [!NOTE]
> **Verify Only**: AI agents reading this guide must **not** attempt to run the installation script again. Proceed directly to configuration and verification steps.
---
## 3. Environment Configuration (.env)
To set up the messaging broker and execution paths, you must create and modify a local environment configuration file (`.env`).
### Step 2.1: Run the Generation Script
### Step 3.1: Run the Generation Script
Run the environment template copy script provided in the project root:
```bash
@@ -46,7 +64,7 @@ Run the environment template copy script provided in the project root:
./scripts/generate-env.sh --force
```
### Step 2.2: Modify Environment Variables
### Step 3.2: Modify Environment Variables
Open the generated `.env` file to configure settings as needed.
> [!NOTE]
@@ -66,11 +84,11 @@ Open the generated `.env` file to configure settings as needed.
---
## 3. Dependency and Virtualenv Setup
## 4. Dependency and Virtualenv Setup
Set up the Python 3 dependencies required to run the orchestration and MQTT messaging backplane.
### Step 3.1: Build Python Virtual Environment
### Step 4.1: Build Python Virtual Environment
Create and activate a `.venv` virtual environment in the project root:
```bash
@@ -81,7 +99,7 @@ python3 -m venv .venv
source .venv/bin/activate
```
### Step 3.2: Install Dependency Packages
### Step 4.2: Install Dependency Packages
Install the required packages listed in `requirements.txt` under `multi-agent-mux-delegate-job`:
```bash
@@ -91,7 +109,7 @@ pip install -r .agents/skills/multi-agent-mux-delegate-job/requirements.txt
---
## 4. Directory Structure and Security Audit Guide
## 5. Directory Structure and Security Audit Guide
Ensure that the local registry directories required to track agent states and jobs are successfully created:
@@ -112,7 +130,7 @@ Ensure that the local registry directories required to track agent states and jo
---
## 5. Execution Verification and Bootstrap Tests
## 6. Execution Verification and Bootstrap Tests
To verify that the environment has been successfully built without runtime errors, run the following verification checklist.
@@ -161,7 +179,7 @@ rm -f ".mam/jobs/$JID.json" ".mam/jobs/$JID.lock"
---
## 6. Onboarding Collaborating Agents (New Agent Onboarding)
## 7. Onboarding Collaborating Agents (New Agent Onboarding)
Once the setup is verified, onboarding agents should immediately read the **[AGENT.md](.agents/AGENT.md)** guidelines in the .agents/ directory.