afv-library/README.md

72 lines
2.7 KiB
Markdown
Raw Normal View History

2025-11-08 01:28:35 +08:00
# Agentforce Vibes Library
2026-04-14 23:37:37 +08:00
This repository provides a curated collection of Salesforce agent skills for building applications. It includes skills for Agentforce agents, Lightning apps, Flow, Apex, SOQL, Lightning Web Components (LWC), UI bundles, objects and fields, permission sets, and related areas.
2026-04-14 03:40:32 +08:00
2026-04-14 23:37:37 +08:00
The skills are contributed by Salesforce and the broader community. Its optimized for Agentforce Vibes and can be used with any AI tool that supports skills.
2026-01-29 05:03:14 +08:00
## 🗂️ Structure
```
afv-library/
├── skills/ # Directory-based executable workflows
│ ├── generating-apex/
│ ├── generating-custom-object/
│ ├── generating-flow/
2026-01-29 05:03:14 +08:00
│ └── ...
2026-02-28 04:56:57 +08:00
├── samples/ # Synced sample apps (e.g. from npm)
│ └── ui-bundle-template-app-react-sample-b2e/
│ └── ...
2026-03-31 20:32:29 +08:00
├── scripts/
│ └── ...
2026-01-29 05:03:14 +08:00
└── README.md
```
2025-11-08 01:28:35 +08:00
2026-04-14 03:40:32 +08:00
## 🚀 Usage
2026-04-14 23:37:37 +08:00
| **Tool** | **Usage** |
2026-04-14 03:40:32 +08:00
|----------|-------------|
| **Agentforce Vibes** | Skills are auto-installed and auto-updated |
2026-04-14 23:37:37 +08:00
| **OpenCode, Claude Code, Codex, Cursor, [more](https://agentskills.io/)** | `npx skills add forcedotcom/afv-library` |
2025-11-08 01:28:35 +08:00
2026-04-14 03:40:32 +08:00
## 📦 Samples
2026-02-28 04:56:57 +08:00
2026-04-14 23:37:37 +08:00
The `samples/` folder contains synced sample apps. For example, `samples/ui-bundle-template-app-react-sample-b2e/` tracks the npm package `@salesforce/ui-bundle-template-app-react-sample-b2e` (nightly and on manual trigger via GitHub Actions).
To run the same sync locally from the repository root:
2026-02-28 04:56:57 +08:00
```bash
npm install
npm run sync-react-b2e-sample
```
2026-04-14 23:37:37 +08:00
The GitHub Action runs the same commands and opens a pull request when the npm package version changes. For more information, see [samples/README.md](samples/README.md).
2026-01-29 05:03:14 +08:00
## 🛠️ Agent Skills
2026-01-29 05:03:14 +08:00
2026-04-14 23:37:37 +08:00
Agent Skills package executable workflows, scripts, and reference material into self-contained directories. This repository follows the open [Agent Skills specification](https://agentskills.io/) and can be used with OpenCode, Claude Code, Codex, Cursor, and other tools that support skills.
2026-01-29 05:03:14 +08:00
### Directory Structure
2026-04-14 23:37:37 +08:00
Each skill is a folder that can include:
- `SKILL.md` (required): Instructions and YAML front matter.
- `scripts/` (optional): Executable scripts (For example, Python, Bash, or JavaScript).
- `references/` (optional): Extra reference documentation.
- `assets/` (optional): Templates, schemas, and lookup data
2025-11-08 01:28:35 +08:00
2025-11-13 21:08:57 +08:00
## 🤝 Contributing
2026-04-14 23:37:37 +08:00
See [Contributing](./CONTRIBUTING.md).
2026-01-29 05:03:14 +08:00
2026-04-14 03:40:32 +08:00
## 💬 Feedback
2025-11-13 21:08:57 +08:00
2026-04-14 23:37:37 +08:00
- Open an issue in this repository
- Open a pull request with suggested changes
- Use GitHub Discussions or the pull request thread for broader conversation
## Project Governance & Support
2025-11-13 21:08:57 +08:00
2026-04-14 23:37:37 +08:00
- [License](./LICENSE.txt)
- [Code of Conduct](./CODE_OF_CONDUCT.md)
- [Contributing](./CONTRIBUTING.md)
- [Security](./SECURITY.md)