Skip to content
This repository was archived by the owner on Dec 17, 2025. It is now read-only.

Commit ba42fed

Browse files
committed
Friendlier readme
1 parent bce8446 commit ba42fed

File tree

1 file changed

+55
-43
lines changed

1 file changed

+55
-43
lines changed

README.md

Lines changed: 55 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,84 @@
1-
# Skills
1+
# Sleuth Skills
22

3-
A CLI tool for managing Sleuth skills - reusable units of AI agent behavior.
3+
Sleuth Skills is a package manager for AI coding assistants. Create, version, and distribute reusable AI
4+
tools across your entire team. Think NPM for AI agents -- install once, use everywhere.
45

5-
## Installation
6+
## Why Sleuth Skills?
7+
- Onboard new developers instantly with your team's tribal knowledge
8+
- Expand successful AI use from experts to everyone
9+
- Spread best practices to any AI tool (coming soon)
10+
11+
## Quickstart
612

713
```bash
814
curl -fsSL https://raw.githubusercontent.com/sleuth-io/skills/main/install.sh | bash
915
```
1016

11-
This downloads and installs the pre-built binary for your platform.
12-
13-
## Getting Started
14-
15-
Initialize your skills configuration:
17+
then
1618

1719
```bash
20+
# Initialize
1821
skills init
19-
```
20-
21-
This creates a configuration file in your home directory and installs a global Claude Code hook to
22-
automatically install skills for new sessions.
2322

24-
### Repository Types
23+
# Add a skill from your repository
24+
skills add /path/to/my-skill
2525

26-
During initialization, you'll choose from three repository types:
26+
# Install skills to your current project
27+
skills install
28+
```
2729

28-
1. **Local Path** (default) - Store skills in a local directory
29-
- Easiest option for getting started
30-
- Great for development and testing
31-
- Directory will be created automatically if it doesn't exist
30+
## What can you build and share?
3231

33-
2. **Git Repository** - Store skills in a Git repository
34-
- Uses your local Git credentials
35-
- Ideal for small team collaboration and version control
36-
- Skills are synced via standard Git operations
32+
- **Skills** - Custom prompts and behaviors for specific tasks
33+
- **Agents** - Autonomous AI agents with specific goals
34+
- **Commands** - Slash commands for quick actions
35+
- **Hooks** - Automation triggers for lifecycle events
36+
- **MCP Servers** - Model Context Protocol (MCP) servers for external integrations
3737

38-
3. **Sleuth Server** - Connect to Sleuth for centralized skill management
39-
- Provides a UI for managing, creating, and discovering new skills in your code
40-
- No authentication credentials needed - handled automatically
41-
- Best for teams wanting a centralized skill registry with visual management
38+
## Distribution models
4239

43-
## Usage
40+
Choose the right distribution model for your team:
4441

45-
### Adding Skills
42+
### Local (Personal)
4643

47-
Add a skill from a local directory or zip file:
44+
Perfect for easily sharing personal tools across multiple personal projects
4845

4946
```bash
50-
skills add /path/to/skill
51-
skills add skill.zip
47+
skills init --type path --path my/repository/path
5248
```
5349

54-
### Managing Dependencies
50+
### Git repository (Small teams)
5551

56-
Install skills:
52+
Share skills through a shared git repository
5753

5854
```bash
59-
skills install
55+
skills init --type git --repo [email protected]:yourteam/skills.git
6056
```
6157

62-
### Help
58+
### Sleuth (Large teams and enterprise)
6359

64-
View all available commands:
60+
Centralized, effortless management with a UI for discovery, creation, and sharing at scale
6561

6662
```bash
67-
skills --help
68-
skills <command> --help
63+
skills init --type sleuth
6964
```
7065

71-
## Documentation
66+
## How it works
7267

73-
- [Repository Spec](docs/repository-spec.md) - Skills repository structure
74-
- [Metadata Spec](docs/metadata-spec.md) - Skill metadata format
75-
- [Requirements Spec](docs/requirements-spec.md) - Dependency requirements
76-
- [Lock Spec](docs/lock-spec.md) - Lock file format
68+
Sleuth Skills uses a lock file, like package-lock.json, for deterministic installations in the right context:
69+
70+
1. **Create** skills with metadata (name, version, dependencies)
71+
2. **Publish** to your chosen repository
72+
3. **Share** the skill globally, per repository, or even per path in a repository (monorepo support!)
73+
4. **Auto-install** on new Claude Code sessions
74+
5. **Stay synchronized** - everyone gets the same tools automatically
75+
76+
## Roadmap
77+
- ✅ Local, Git, and Sleuth repositories
78+
- ✅ Claude Code support
79+
- **Multi-client support** - Use the same skills in Cursor, Windsurf, Cline
80+
- **Skill discovery** - Use Sleuth to discover relevant skills from your code and architecture
81+
- **Analytics** - Track skill usage and impact
7782

7883
## License
7984

@@ -86,6 +91,13 @@ See LICENSE file for details.
8691
<details>
8792
<summary>Click to expand development instructions</summary>
8893

94+
### Documentation
95+
96+
- [Repository Spec](docs/repository-spec.md) - Skills repository structure
97+
- [Metadata Spec](docs/metadata-spec.md) - Skill metadata format
98+
- [Lock Spec](docs/lock-spec.md) - Lock file format
99+
100+
89101
### Prerequisites
90102

91103
Go 1.25 or later is required. Install using [gvm](https://github.com/moovweb/gvm):

0 commit comments

Comments
 (0)