ai-docs/assets/README.md
2026-02-11 11:44:55 -06:00

87 lines
2.4 KiB
Markdown

# Assets (Staging)
This folder stages non-guide assets for a future migration to a dedicated distribution repo.
Contents:
- agents/: Agent prompt files
- instructions/: Repo-level instruction files
- ios-skills.yaml, android-skills.yaml, shared-skills.yaml: Curated skills lists
- sync-skills.sh: Installs skills from a curated list using the skills CLI
Do not add handbook content here. Use docs/ai for the guide.
## Install Skills (Platform Lists)
Run the sync script with the list you want. Restart your editor if skills do not appear.
### iOS
```bash
SKILLS_FILE=./assets/ios-skills.yaml ./assets/sync-skills.sh
```
### Android
```bash
SKILLS_FILE=./assets/android-skills.yaml ./assets/sync-skills.sh
```
### Shared (All Platforms)
```bash
SKILLS_FILE=./assets/shared-skills.yaml ./assets/sync-skills.sh
```
### iOS + Shared
```bash
SKILLS_FILE=./assets/shared-skills.yaml ./assets/sync-skills.sh
SKILLS_FILE=./assets/ios-skills.yaml ./assets/sync-skills.sh
```
### Android + Shared
```bash
SKILLS_FILE=./assets/shared-skills.yaml ./assets/sync-skills.sh
SKILLS_FILE=./assets/android-skills.yaml ./assets/sync-skills.sh
```
## Run Without Cloning The Repo (Optional)
If you prefer not to clone the repo, you can download the script and a list file directly, then run it locally. Replace the placeholders with your real repo and raw file URLs.
```bash
curl -fsSL <raw-url-to-sync-skills.sh> -o /tmp/sync-skills.sh
curl -fsSL <raw-url-to-ios-skills.yaml> -o /tmp/ios-skills.yaml
chmod +x /tmp/sync-skills.sh
SKILLS_FILE=/tmp/ios-skills.yaml /tmp/sync-skills.sh
```
Notes:
- The sync script reads the list file you pass in `SKILLS_FILE`.
- Cloning the repo is still recommended if you want updates and version history.
## Install Agents
Agents are prompt files that live under assets/agents.
### Clone And Copy (Recommended)
```bash
git clone git@<host>:org/ai-assets.git
mkdir -p ~/.agents/agents
cp -R ai-assets/agents/* ~/.agents/agents/
```
### No-Clone (Raw Files)
```bash
mkdir -p ~/.agents/agents
curl -fsSL <raw-url-to-agent-file> -o ~/.agents/agents/<agent-file>.agent.md
```
## Install Instructions
Instructions are repo-level rule files. Copy them into your project.
### Clone And Copy (Recommended)
```bash
git clone git@<host>:org/ai-assets.git
mkdir -p ./instructions
cp -R ai-assets/instructions/* ./instructions/
```
### No-Clone (Raw Files)
```bash
mkdir -p ./instructions
curl -fsSL <raw-url-to-instruction-file> -o ./instructions/<name>.instructions.md
```