8f0f0df7d6
- Single script handles skills, agents, and instructions - Works locally (cloned repo) and remotely (curl, no clone) - Auto-generated manifests (agents.list, instructions.list) - update-lists command regenerates manifests from directory contents - Removed sync-skills.sh (folded into setup.sh) - Rewrote assets README to be concise and actionable - Updated all references in Agents.md and skills.md
97 lines
2.8 KiB
Markdown
97 lines
2.8 KiB
Markdown
# AI Assets
|
|
|
|
One script installs everything. No manual copy/paste. No cloning required.
|
|
|
|
## Quick Start
|
|
|
|
### Option 1 — You Cloned This Repo
|
|
|
|
```bash
|
|
# Install everything for iOS
|
|
./assets/setup.sh all ios
|
|
|
|
# Or pick what you need
|
|
./assets/setup.sh skills ios
|
|
./assets/setup.sh agents
|
|
./assets/setup.sh instructions
|
|
```
|
|
|
|
### Option 2 — No Clone (Run Remotely)
|
|
|
|
Point the script at the repo and run. Nothing to download first.
|
|
|
|
```bash
|
|
# Set the base URL once (get this from your team lead)
|
|
export ASSETS_BASE_URL="https://gitlab.com/<org>/mobile-ai-docs/-/raw/develop/assets"
|
|
|
|
# Install everything for iOS — one command
|
|
bash <(curl -fsSL "$ASSETS_BASE_URL/setup.sh") all ios
|
|
|
|
# Or pick what you need
|
|
bash <(curl -fsSL "$ASSETS_BASE_URL/setup.sh") skills ios
|
|
bash <(curl -fsSL "$ASSETS_BASE_URL/setup.sh") agents
|
|
bash <(curl -fsSL "$ASSETS_BASE_URL/setup.sh") instructions
|
|
```
|
|
|
|
That's it.
|
|
|
|
---
|
|
|
|
## Commands
|
|
|
|
| Command | What It Does |
|
|
|---------|-------------|
|
|
| `setup.sh skills [platform]` | Install skills from a curated YAML list |
|
|
| `setup.sh agents` | Install all agent prompt files |
|
|
| `setup.sh instructions` | Install all instruction rule files |
|
|
| `setup.sh all [platform]` | All of the above in one shot |
|
|
| `setup.sh update-lists` | Regenerate manifests from directory contents (local only) |
|
|
| `setup.sh help` | Print usage |
|
|
|
|
### Platforms (for skills)
|
|
|
|
| Platform | List File |
|
|
|----------|-----------|
|
|
| `ios` | ios-skills.yaml |
|
|
| `android` | android-skills.yaml |
|
|
| `shared` (default) | shared-skills.yaml |
|
|
|
|
## Where Things Get Installed
|
|
|
|
| Asset | Default Location | Override |
|
|
|-------|-----------------|----------|
|
|
| Skills | Managed by `npx skills` CLI | — |
|
|
| Agents | `~/.copilot/agents/` | `AGENTS_DIR` |
|
|
| Instructions | `./instructions/` | `INSTRUCTIONS_DIR` |
|
|
|
|
## Adding New Assets
|
|
|
|
When you add a new agent or instruction file to `assets/agents/` or `assets/instructions/`, run:
|
|
|
|
```bash
|
|
./assets/setup.sh update-lists
|
|
```
|
|
|
|
This regenerates `agents.list` and `instructions.list` so remote installs pick up the new files. Commit the updated lists.
|
|
|
|
## Folder Structure
|
|
|
|
```
|
|
assets/
|
|
setup.sh ← the installer
|
|
agents.list ← auto-generated manifest
|
|
instructions.list ← auto-generated manifest
|
|
ios-skills.yaml ← curated iOS skills
|
|
android-skills.yaml ← curated Android skills
|
|
shared-skills.yaml ← curated cross-platform skills
|
|
agents/ ← agent prompt files
|
|
instructions/ ← instruction rule files
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
| Variable | Purpose | Required? |
|
|
|----------|---------|-----------|
|
|
| `ASSETS_BASE_URL` | Base URL for remote downloads | Only without a clone |
|
|
| `AGENTS_DIR` | Custom agents install path | No |
|
|
| `INSTRUCTIONS_DIR` | Custom instructions install path | No | |