mbrucedogs/ai-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: simplify assets no-clone flow

Browse Source
This commit is contained in:
Matt Bruce 2026-02-11 11:48:28 -06:00
parent f477014a47
commit 5f296fcd54
1 changed files with 20 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
assets/README.md
View File

@ -40,48 +40,47 @@ 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.
## Run Without Cloning The Repo (All Assets)
This installs skills, agents, and instructions without cloning. Set the base URL once and reuse it. If your host needs a token, put it in one place.
```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
export ASSETS_TOKEN="<token-if-needed>"
export ASSETS_BASE_URL="https://<host>/org/ai-assets/raw/main/assets"
curl -fsSL -H "Authorization: Bearer $ASSETS_TOKEN" \
"$ASSETS_BASE_URL/sync-skills.sh" -o /tmp/sync-skills.sh
curl -fsSL -H "Authorization: Bearer $ASSETS_TOKEN" \
"$ASSETS_BASE_URL/ios-skills.yaml" -o /tmp/ios-skills.yaml
chmod +x /tmp/sync-skills.sh
SKILLS_FILE=/tmp/ios-skills.yaml /tmp/sync-skills.sh
mkdir -p ~/.agents/agents ./instructions
curl -fsSL -H "Authorization: Bearer $ASSETS_TOKEN" \
"$ASSETS_BASE_URL/agents/<agent-file>.agent.md" -o ~/.agents/agents/<agent-file>.agent.md
curl -fsSL -H "Authorization: Bearer $ASSETS_TOKEN" \
"$ASSETS_BASE_URL/instructions/<name>.instructions.md" -o ./instructions/<name>.instructions.md
```
Notes:
- The sync script reads the list file you pass in `SKILLS_FILE`.
- The token and base URL are only defined once.
- Remove the Authorization header if your host does not require it.
- Cloning the repo is still recommended if you want updates and version history.
## Install Agents
## Install Agents (Clone And Copy)
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
## Install Instructions (Clone And Copy)
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
```