|
9 | 9 | </p> |
10 | 10 |
|
11 | 11 | <p align="center"> |
12 | | - <a href="#features">Features</a> • |
13 | | - <a href="#installation">Installation</a> • |
14 | | - <a href="#usage">Usage</a> • |
15 | | - <a href="#contributing">Contributing</a> |
| 12 | + <a href="https://github.com/yeasy/ask/releases"><img src="https://img.shields.io/github/v/release/yeasy/ask?style=flat-square&color=blue" alt="Release"></a> |
| 13 | + <a href="https://github.com/yeasy/ask/blob/main/LICENSE"><img src="https://img.shields.io/github/license/yeasy/ask?style=flat-square" alt="License"></a> |
| 14 | + <a href="https://github.com/yeasy/ask/stargazers"><img src="https://img.shields.io/github/stars/yeasy/ask?style=flat-square" alt="Stars"></a> |
| 15 | + <a href="https://github.com/yeasy/ask/actions"><img src="https://img.shields.io/github/actions/workflow/status/yeasy/ask/release.yml?style=flat-square" alt="Build"></a> |
| 16 | + <img src="https://img.shields.io/badge/Go-1.21+-00ADD8?style=flat-square&logo=go" alt="Go Version"> |
| 17 | +</p> |
| 18 | + |
| 19 | +<p align="center"> |
| 20 | + <a href="#-quick-start">Quick Start</a> · |
| 21 | + <a href="#-commands">Commands</a> · |
| 22 | + <a href="#-skill-sources">Sources</a> · |
| 23 | + <a href="docs/README.md">Docs</a> |
16 | 24 | </p> |
17 | 25 |
|
18 | 26 | <p align="center"> |
|
21 | 29 |
|
22 | 30 | --- |
23 | 31 |
|
24 | | -**ASK** (Agent Skills Kit) is a command-line interface (CLI) designed to be the package manager for AI Agent Skills. Similar to how `brew` manages macOS packages or `npm` manages Node.js dependencies, `ask` helps you discover, install, and manage capabilities for your AI agents. |
| 32 | +**ASK** (Agent Skills Kit) is the package manager for AI Agent Skills. Just like `brew` manages macOS packages or `npm` manages Node.js dependencies, `ask` helps you discover, install, and manage capabilities for your AI agents. |
| 33 | + |
| 34 | +## ✨ Key Features |
| 35 | + |
| 36 | +### 📦 Smart Package Management |
| 37 | +Install, uninstall, update, and list skills with intuitive commands. Version locking via `ask.lock` ensures reproducible environments across teams. |
| 38 | + |
| 39 | +### 🔍 Multi-Source Discovery |
| 40 | +Search skills from multiple sources simultaneously — community topics, official repositories, and scientific domains. See which skills you already have installed. |
25 | 41 |
|
26 | | -## Features |
| 42 | +### ⚡ Lightning Fast |
| 43 | +Built with Go, compiling to a single static binary with zero runtime dependencies. Parallel search across all sources. Git sparse checkout for minimal downloads. |
27 | 44 |
|
28 | | -- **📦 Package Management**: Install, uninstall, and list skills with ease. |
29 | | -- **🔍 Discovery**: Search GitHub for skills from multiple sources (topic-based and directory-based). |
30 | | -- **🌐 Multiple Sources**: Built-in support for the `agent-skill` topic and [Anthropics Skills](https://github.com/anthropics/skills). |
31 | | -- **⚡️ Fast & Native**: Built with Go, compiling to a single static binary with no runtime dependencies. |
32 | | -- **🛠 Project-Local**: Manages dependencies via `ask.yaml`, keeping your projects reproducible. |
| 45 | +### 🔒 Version Locking |
| 46 | +Pin specific versions with `skill@v1.0` syntax. Track exact commits in `ask.lock` for reproducible installations. |
33 | 47 |
|
34 | | -## Installation |
| 48 | +### 📊 Progress Tracking |
| 49 | +Real-time progress bars during installation and updates. Clear feedback on what's happening. |
| 50 | + |
| 51 | +--- |
| 52 | + |
| 53 | +## 🚀 Quick Start |
| 54 | + |
| 55 | +**① Install ASK** |
35 | 56 |
|
36 | | -### macOS (Homebrew) |
37 | 57 | ```bash |
| 58 | +# macOS (Homebrew) |
38 | 59 | brew tap yeasy/ask |
39 | 60 | brew install ask |
| 61 | + |
| 62 | +# Or build from source |
| 63 | +git clone https://github.com/yeasy/ask.git && cd ask |
| 64 | +make build && mv ask /usr/local/bin/ |
40 | 65 | ``` |
41 | 66 |
|
42 | | -### Manual |
43 | | -Download the latest release from the [Releases](https://github.com/yeasy/ask/releases) page, or build from source: |
| 67 | +**② Initialize Your Project** |
44 | 68 |
|
45 | 69 | ```bash |
46 | | -git clone https://github.com/yeasy/ask.git |
47 | | -cd ask |
48 | | -make build |
49 | | -mv ask /usr/local/bin/ |
| 70 | +ask init # Creates ask.yaml in current directory |
50 | 71 | ``` |
51 | 72 |
|
52 | | -## Usage |
| 73 | +**③ Search & Install Skills** |
53 | 74 |
|
54 | | -### 1. Initialize a Project |
55 | | -Start by initializing `ask` in your agent's root directory: |
56 | 75 | ```bash |
57 | | -ask init |
| 76 | +ask skill search browser # Search across all sources |
| 77 | +ask skill install browser-use # Install a skill |
| 78 | +ask skill list # View installed skills |
58 | 79 | ``` |
59 | | -This creates an `ask.yaml` file to track your skills. |
60 | 80 |
|
61 | | -### 2. Search for Skills |
62 | | -Find skills relevant to your needs: |
63 | | -```bash |
64 | | -ask search browser |
65 | | -# Returns skills like: browser-use, web-surfer, etc. |
66 | | -``` |
| 81 | +--- |
67 | 82 |
|
68 | | -### 3. Install a Skill |
69 | | -Install a skill directly from GitHub: |
70 | | -```bash |
71 | | -ask install browser-use/browser-use |
72 | | -``` |
73 | | -This will: |
74 | | -- Clone the repository into `./skills/browser-use` |
75 | | -- Add the dependency to `ask.yaml` |
| 83 | +## 📋 Commands |
| 84 | + |
| 85 | +| Command | Description | |
| 86 | +|---------|-------------| |
| 87 | +| `ask init` | Initialize project, create `ask.yaml` | |
| 88 | +| **Skill Management** | | |
| 89 | +| `ask skill search <keyword>` | Search skills across all sources | |
| 90 | +| `ask skill install <skill>` | Install a skill to `./skills/` | |
| 91 | +| `ask skill install skill@v1.0` | Install specific version | |
| 92 | +| `ask skill uninstall <skill>` | Remove a skill | |
| 93 | +| `ask skill list` | List installed skills | |
| 94 | +| `ask skill info <skill>` | Show skill details | |
| 95 | +| `ask skill update [skill]` | Update skill(s) to latest | |
| 96 | +| `ask skill outdated` | Check for updates | |
| 97 | +| `ask skill create <name>` | Create new skill template | |
| 98 | +| **Repository Management** | | |
| 99 | +| `ask repo list` | List skill sources | |
| 100 | +| `ask repo add <url>` | Add custom source | |
| 101 | +| `ask repo remove <name>` | Remove a source | |
76 | 102 |
|
77 | | -### 4. Uninstall a Skill |
78 | | -Remove a skill you no longer need: |
79 | | -```bash |
80 | | -ask uninstall browser-use |
81 | | -``` |
82 | | -or |
83 | | -```bash |
84 | | -ask uninstall browser-use/browser-use |
85 | | -``` |
86 | | -This will: |
87 | | -- Remove the directory `skills/browser-use` |
88 | | -- Remove the dependency from `ask.yaml` |
| 103 | +--- |
89 | 104 |
|
90 | | -### 5. List Installed Skills |
91 | | -See what your agent is equipped with: |
92 | | -```bash |
93 | | -ask list |
| 105 | +## 🌐 Skill Sources |
| 106 | + |
| 107 | +ASK searches these sources by default: |
| 108 | + |
| 109 | +| Source | Type | Description | |
| 110 | +|--------|------|-------------| |
| 111 | +| **Community** | topic | GitHub repos with `agent-skill` topic | |
| 112 | +| **Anthropics** | dir | Official [anthropics/skills](https://github.com/anthropics/skills) | |
| 113 | +| **MCP-Servers** | dir | [modelcontextprotocol/servers](https://github.com/modelcontextprotocol/servers) | |
| 114 | +| **Scientific** | dir | Research skills from [K-Dense-AI](https://github.com/K-Dense-AI/claude-scientific-skills) | |
| 115 | +| **Superpowers** | dir | Core skills from [obra/superpowers](https://github.com/obra/superpowers) | |
| 116 | +| **OpenAI** | dir | Codex skills from [openai/skills](https://github.com/openai/skills) | |
| 117 | + |
| 118 | +### Add Custom Sources |
| 119 | + |
| 120 | +```yaml |
| 121 | +# ask.yaml |
| 122 | +repos: |
| 123 | + - name: my-team |
| 124 | + type: dir |
| 125 | + url: my-org/agent-skills/skills |
94 | 126 | ``` |
95 | 127 |
|
96 | | -## Directory Structure |
97 | | -When you use `ask`, your project will look like this: |
| 128 | +--- |
| 129 | +
|
| 130 | +## 📂 Project Structure |
| 131 | +
|
| 132 | +After using ASK, your project looks like: |
98 | 133 |
|
99 | | -```text |
| 134 | +``` |
100 | 135 | my-agent/ |
101 | 136 | ├── ask.yaml # Manifest file |
| 137 | +├── ask.lock # Version lock file |
102 | 138 | ├── main.py # Your agent code |
103 | | -└── skills/ # Managed skills directory |
104 | | - ├── browser-use/ |
105 | | - └── web-surfer/ |
| 139 | +└── .agent/ |
| 140 | + └── skills/ # Managed skills |
| 141 | + ├── browser-use/ |
| 142 | + └── web-surfer/ |
106 | 143 | ``` |
107 | 144 |
|
108 | | -## Skill Sources |
109 | | -By default, `ask` searches these sources: |
110 | | - |
111 | | -1. **Community** (`topic`): GitHub repos with the `agent-skill` topic. |
112 | | -2. **Anthropics** (`dir`): Skills from [anthropics/skills](https://github.com/anthropics/skills/tree/main/skills). |
| 145 | +--- |
113 | 146 |
|
114 | | -You can customize sources in your `ask.yaml`: |
| 147 | +## 🛠 Development |
115 | 148 |
|
116 | | -```yaml |
117 | | -version: "1.0" |
118 | | -skills: |
119 | | - - browser-use |
120 | | -sources: |
121 | | - - name: community |
122 | | - type: topic |
123 | | - url: agent-skill |
124 | | - - name: anthropics |
125 | | - type: dir |
126 | | - url: anthropics/skills/skills |
| 149 | +```bash |
| 150 | +make build # Build binary |
| 151 | +make test # Run tests |
| 152 | +make fmt # Format code |
| 153 | +make vet # Check code |
| 154 | +make install # Install to $GOPATH/bin |
127 | 155 | ``` |
128 | 156 |
|
129 | | -## Development |
130 | | -This project includes a `Makefile` to simplify common development tasks: |
| 157 | +--- |
| 158 | + |
| 159 | +## 📚 Documentation |
| 160 | + |
| 161 | +See the [docs/](docs/README.md) directory for detailed documentation: |
| 162 | + |
| 163 | +- [Installation Guide](docs/installation.md) |
| 164 | +- [Command Reference](docs/commands.md) |
| 165 | +- [Skill Sources](docs/skill-sources.md) |
| 166 | +- [SKILL.md Format](docs/skill-format.md) |
| 167 | +- [Configuration](docs/configuration.md) |
131 | 168 |
|
132 | | -- `make build`: Compiles the binary to `ask`. |
133 | | -- `make test`: Runs unit tests. |
134 | | -- `make clean`: Removes the binary and runs `go clean`. |
135 | | -- `make run`: Runs `go run main.go`. |
136 | | -- `make deps`: Downloads dependencies (`go mod download`). |
137 | | -- `make fmt`: Formats code (`go fmt ./...`). |
138 | | -- `make vet`: Vets code (`go vet ./...`). |
139 | | -- `make install`: Installs the binary to `$GOPATH/bin` (`go install`). |
| 169 | +--- |
| 170 | + |
| 171 | +## 🤝 Contributing |
| 172 | + |
| 173 | +We welcome contributions! Please see our [Contribution Guidelines](CONTRIBUTING.md). |
| 174 | + |
| 175 | +--- |
140 | 176 |
|
141 | | -## Contributing |
142 | | -We welcome contributions! Please check out our [Contribution Guidelines](CONTRIBUTING.md). |
| 177 | +## 📄 License |
143 | 178 |
|
144 | | -## License |
145 | 179 | MIT |
0 commit comments