refactor(deploy): consolidate install scripts and INSTALL.md into deploy/
- Move scripts/install_mam.sh → deploy/install_mam.sh (local-clone installer) - Move scripts/generate-env.sh → deploy/generate-env.sh (env helper) - Move .agents/INSTALL.md → deploy/INSTALL.md (user manual) - Update install_mam.sh to copy INSTALL.md + generate-env.sh from new paths - Ship INSTALL.md via deploy/install.sh remote path too (manifest-tracked) - Update README/BOOTSTRAP generate-env.sh references & repository ASCII layout - Extend deploy/README.md structure section; extend gitea-ci.yml lint list - Remove now-empty scripts/ directory - Fix duplicate ### 2. subsection headers in deploy/README.md (address B-2) - Correct deploy/INSTALL.md dependency description to match actual checks (address M-1) - Add local-clone lifecycle caveat (no update.sh/remove.sh) (address M-2) Closes the deploy consolidation plan and addresses Planner / Reviewer feedback.
This commit is contained in:
+16
-3
@@ -6,7 +6,10 @@ This directory contains packaging templates and installation scripts to deploy t
|
||||
|
||||
## 📁 Deployment Directory Structure
|
||||
|
||||
* **`install.sh`**: A self-contained, idempotent shell installer that checks system requirements (`tmux`, `python3`, `pip3`), detects NFS/network filesystem mounts, sets up a local python virtual environment (`.venv`), and initializes environment configuration (`.env`).
|
||||
* **`install.sh`**: A self-contained, idempotent remote shell installer (via curl) that checks system requirements (`tmux`, `python3`), detects NFS/network filesystem mounts, sets up a local python virtual environment (`.venv`), and initializes environment configuration (`.env`).
|
||||
* **`install_mam.sh`**: A local-clone installer that copies rules/skills (`.agents/`), `AGENTS.md`, and sets up environment bootstrap on target projects.
|
||||
* **`generate-env.sh`**: Environment configuration bootstrap helper.
|
||||
* **`INSTALL.md`**: Detailed installation and quick-start user manual.
|
||||
* **`plugin.json`**: Metadata declaration file to register MAM as an installable plugin for AI Agent coding platforms (such as Claude Code, Antigravity, or other TUI clients).
|
||||
* **`gitea-ci.yml`**: CI/CD pipeline definition template for Gitea Actions (running ShellCheck linting on bash scripts, validation on python scripts, and compilation tests).
|
||||
|
||||
@@ -26,7 +29,17 @@ Alternatively, if they have cloned the repository, they can execute:
|
||||
bash deploy/install.sh
|
||||
```
|
||||
|
||||
### 2. Custom Fork / Private Mirror Installations
|
||||
### 2. Local-Clone Installation
|
||||
If you already have cloned this repository locally, you can port MAM to other local target projects:
|
||||
```bash
|
||||
bash deploy/install_mam.sh --target /path/to/your/project
|
||||
```
|
||||
Refer to **`INSTALL.md`** inside this directory for the full instructions and workflows.
|
||||
|
||||
> [!NOTE]
|
||||
> The local-clone installer does not ship `update.sh`/`remove.sh` to targets. To enable in-place updates, re-run the remote installer (`curl ... | bash`) or copy `deploy/update.sh` + `deploy/remove.sh` manually.
|
||||
|
||||
### 3. Custom Fork / Private Mirror Installations
|
||||
If you run a private mirror or fork, you can override the source URLs during installation using environment variables:
|
||||
|
||||
```bash
|
||||
@@ -40,7 +53,7 @@ curl -fsSL https://my-mirror.example.com/.../install.sh \
|
||||
MAM_INSTALLER_URL=https://my-mirror.example.com/.../install.sh bash deploy/update.sh
|
||||
```
|
||||
|
||||
### 2. Registering as a Workspace Plugin
|
||||
### 4. Registering as a Workspace Plugin
|
||||
To register these skills globally or for a specific workspace:
|
||||
* **Workspace Level**: Copy the `.agents/` folder into your project root.
|
||||
* **Global Level (Gemini/Antigravity)**: Register the plugin path in your global config file at `~/.gemini/config/skills.json`:
|
||||
|
||||
Reference in New Issue
Block a user