Skip to content

Commit 459e06c

Browse files
committed
Update README for global skills distribution
1 parent 8b41a4f commit 459e06c

File tree

1 file changed

+29
-34
lines changed

1 file changed

+29
-34
lines changed

README.md

Lines changed: 29 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ AI agent skills for Bkper development. These skills provide procedural knowledge
1212

1313
## What are Skills?
1414

15-
Skills are markdown files that teach AI assistants how to work with specific technologies and patterns. Unlike static project documentation (`AGENTS.md`), skills contain dynamic, procedural knowledge that can be automatically updated across projects.
15+
Skills are markdown files that teach AI assistants how to work with specific technologies and patterns. Unlike static project documentation (`AGENTS.md`), skills contain dynamic, procedural knowledge that can be automatically updated.
1616

1717
## Available Skills
1818

@@ -22,38 +22,36 @@ Skills are markdown files that teach AI assistants how to work with specific tec
2222
| `bkper-web-dev` | Web development, @bkper/web-* packages, Lit components, auth |
2323
| `bkper-script-dev` | Local scripting, CLI usage, bulk operations |
2424

25-
## Usage
25+
## Distribution
2626

27-
### In Bkper App Projects
27+
Skills are distributed **globally** to `~/.claude/skills/` and managed automatically by the Bkper CLI.
2828

29-
Skills are automatically installed when you create a new app with `bkper init`. They are stored in `.claude/skills/` and configured in `bkperapp.yaml`:
29+
### Automatic Updates
3030

31-
```yaml
32-
# bkperapp.yaml
33-
skills:
34-
autoUpdate: true
35-
installed:
36-
- bkper-app-dev
37-
- bkper-web-dev
38-
```
39-
40-
### Manual Installation
31+
The CLI checks for updates and syncs all skills when running:
32+
- `bkper apps init <name>` - when creating a new app
33+
- `bkper mcp start` - when starting the MCP server
4134

42-
Copy the desired skill folder to your project:
43-
44-
```bash
45-
cp -r skills/bkper-app-dev .claude/skills/
46-
```
35+
### How It Works
4736

48-
### Auto-Update
37+
1. CLI fetches `version.txt` from this repository
38+
2. Compares with local version in `~/.config/bkper/skills.yaml`
39+
3. If version differs (or skills are missing), downloads all `bkper-*` skills
40+
4. Skills are available to all projects via the global location
4941

50-
When `autoUpdate: true` (default), the Bkper CLI will check for skill updates when running `bkper dev` and sync them automatically.
42+
### Version Tracking
5143

52-
To disable auto-update:
44+
```
45+
~/.claude/skills/
46+
├── bkper-app-dev/
47+
│ └── SKILL.md
48+
├── bkper-web-dev/
49+
│ └── SKILL.md
50+
└── bkper-script-dev/
51+
└── SKILL.md
5352
54-
```yaml
55-
skills:
56-
autoUpdate: false
53+
~/.config/bkper/skills.yaml
54+
└── version: 1
5755
```
5856

5957
## Skill Format
@@ -67,24 +65,21 @@ skills/
6765
```
6866

6967
The `SKILL.md` file contains:
70-
- Skill metadata (name, description, version)
7168
- Procedural knowledge and patterns
7269
- Code examples and best practices
7370

7471
## Contributing
7572

7673
When updating skills:
7774

78-
1. Edit the relevant `SKILL.md` file
79-
2. Update the version in the skill metadata
80-
3. Test with a sample project
81-
4. Commit and push
82-
83-
Changes will propagate to projects with `autoUpdate: true` on their next `bkper dev` run.
75+
1. Edit the relevant `SKILL.md` file in `skills/`
76+
2. Commit and push to `main`
77+
3. GitHub Action auto-increments `version.txt`
78+
4. Changes propagate to users on next CLI command
8479

8580
## Compatibility
8681

8782
Skills are compatible with:
88-
- Claude Code (`.claude/skills/`)
89-
- OpenCode (`.claude/skills/` or `.opencode/skills/`)
83+
- Claude Code (`~/.claude/skills/`)
84+
- OpenCode (`~/.claude/skills/`)
9085
- Other Agent Skills-compatible tools

0 commit comments

Comments
 (0)