Skip to content

Commit d6319f6

Browse files
committed
Update README
1 parent 83d5ddd commit d6319f6

1 file changed

Lines changed: 23 additions & 36 deletions

File tree

README.md

Lines changed: 23 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@
99

1010
**Track AI skills and agents declaratively, like dependencies. Pin them. Patch them. Deploy everywhere.**
1111

12-
Declare everything in one file. Lock to exact commits. Sync across 8 agentic coding platforms. Customize without losing upstream updates. And even browse for 110K+ community skills without leaving the CLI!
12+
Declare your skills in a manifest. Pinned to exact commits. Deploys to Claude Code, Cursor, Gemini, and 5 more. Customize without losing upstream updates. Search 110K+ skills from the terminal.
1313

1414
![demo](https://github.com/eljulians/skillfile/raw/master/docs/demo.gif)
1515

16-
You found a great skill on GitHub and copied the markdown into `.claude/skills/`. Or maybe you found one on [agentskill.sh](https://agentskill.sh) and used their installer. Either way:
16+
You found a great skill on GitHub and copied the markdown into `.claude/skills/`. Maybe you grabbed one from [agentskill.sh](https://agentskill.sh). So what now?
1717

1818
- Each hub has its own install tool
1919
- Nothing tracks what you installed
@@ -42,50 +42,39 @@ Single binary, 3.5 MB, no runtime dependencies.
4242
## Quick Start
4343

4444
```bash
45-
skillfile init # pick your platforms
46-
skillfile search "code review" # browse 110K+ community skills
47-
skillfile add # wizard to add skills from GitHub/URLs/local/other registries
48-
skillfile add github skill anthropics/skills skills/slack-gif-creator # Or add a specific skill from github
45+
skillfile init # pick your platforms
46+
skillfile add # guided wizard
47+
skillfile add github skill anthropics/courses skills/ # or add directly
4948
```
5049

51-
On a fresh clone, `skillfile install` reads `Skillfile.lock` and reproduces the exact same install, every file pinned to its commit SHA.
50+
That's it. Skills are fetched, locked to exact SHAs, and deployed. On a fresh clone, `skillfile install` reproduces the exact same setup.
5251

53-
## Search 110K+ community skills
52+
> Looking for skills to install? See [awesome-agents-and-skills](https://github.com/eljulians/awesome-agents-and-skills) for a curated collection with a ready-to-use Skillfile.
5453
55-
Browse [agentskill.sh](https://agentskill.sh/), [skills.sh](https://skills.sh/), and [skillhub.club](https://skillhub.club/) without leaving the terminal. Results are sorted by popularity, deduplicated, and include security scores.
54+
## Add skills from anywhere
55+
56+
Run `skillfile add` for a guided wizard, or use the explicit CLI for any source:
5657

5758
```bash
58-
skillfile search "code review" # interactive TUI with preview
59-
skillfile search docker --min-score 80 # only high-trust results
60-
skillfile search testing --registry agentskill.sh # target a single registry
61-
skillfile search testing --json # machine-readable output
59+
skillfile add # wizard: GitHub, search, local, URL
60+
skillfile add github skill anthropics/courses # discover all skills in a repo
61+
skillfile add github skill anthropics/courses skills/research # add one specific skill
62+
skillfile add local skill skills/my-custom/SKILL.md # track a local file
63+
skillfile add url skill https://example.com/skill.md # add from a URL
6264
```
6365

64-
Select a result and skillfile walks you through adding it to your manifest.
66+
When discovering from a GitHub repo, skillfile opens a split-pane TUI where you can browse entries, preview SKILL.md content, and multi-select what to install. Each selected skill becomes an independent manifest line you can pin, update, or remove individually.
6567

66-
## Bulk-add from any repo
68+
## Search community registries
6769

68-
Point at a directory in a GitHub repo and skillfile discovers every skill inside it, even in deeply nested author-namespaced structures. Pick what you want from a split-pane TUI with SKILL.md preview, and all selected entries get added and installed in one shot.
70+
Browse [agentskill.sh](https://agentskill.sh/), [skills.sh](https://skills.sh/), and [skillhub.club](https://skillhub.club/) without leaving the terminal. Results are sorted by popularity, deduplicated, and include security scores.
6971

7072
```bash
71-
# Discover all skills under skills/ in a repo (note the trailing /)
72-
skillfile add github skill anthropics/courses skills/
73-
74-
# Found 12 skills under skills/
75-
# ┌──────────────────────────────────────────────────┐
76-
# │ Select skills │ SKILL.md preview │
77-
# │ [x] browser │ # Browser Skill │
78-
# │ [x] code-review │ Expert code review... │
79-
# │ [ ] commit │ │
80-
# │ [ ] debugging │ │
81-
# └──────────────────────────────────────────────────┘
82-
# Added 2 entries to Skillfile.
73+
skillfile search "code review" # interactive TUI with preview
74+
skillfile search docker --min-score 80 # only high-trust results
75+
skillfile search testing --registry agentskill.sh # target a single registry
8376
```
8477

85-
Or just run `skillfile add` with no arguments for a guided wizard that walks you through every source type.
86-
87-
Each discovered skill becomes a normal, independent manifest line. No magic expansion, no hidden state. Pin, update, and remove them individually.
88-
8978
## Customize without losing upstream updates
9079

9180
Edit an installed skill to fit your workflow, then `pin` it. Your changes survive upstream updates automatically.
@@ -215,7 +204,7 @@ The lock file pins entries to exact commit SHAs. The same SHA always produces th
215204

216205
Review what you install. The risk profile is the same as `git clone`.
217206

218-
## Contributing
207+
## Development
219208

220209
```bash
221210
cargo test --workspace # unit + integration tests
@@ -224,6 +213,4 @@ cargo clippy --all-targets -- -D warnings # lint
224213
cargo fmt --check # format check
225214
```
226215

227-
## License
228-
229-
[Apache 2.0](LICENSE)
216+
PRs are very welcome!

0 commit comments

Comments
 (0)