Skip to content

Commit abbcc29

Browse files
committed
feat: initial yavy cli
0 parents  commit abbcc29

File tree

18 files changed

+2555
-0
lines changed

18 files changed

+2555
-0
lines changed

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules
2+
dist
3+
.DS_Store
4+
.omc
5+
*.log
6+
*.tgz

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Yavy
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Yavy CLI
2+
3+
Generate AI skills from your indexed documentation on [Yavy](https://yavy.dev).
4+
5+
## Installation
6+
7+
```bash
8+
npm install -g @yavydev/cli
9+
```
10+
11+
Requires Node.js >= 18.
12+
13+
## Quick Start
14+
15+
```bash
16+
# Authenticate with your Yavy account
17+
yavy login
18+
19+
# List your projects
20+
yavy projects
21+
22+
# Generate a skill for a project
23+
yavy generate my-org/my-project
24+
```
25+
26+
## Commands
27+
28+
### `yavy login`
29+
30+
Opens your browser to authenticate with your Yavy account. Credentials are stored in `~/.yavy/credentials.json`.
31+
32+
### `yavy logout`
33+
34+
Clears stored credentials.
35+
36+
### `yavy projects`
37+
38+
Lists all projects you have access to across your organizations.
39+
40+
| Flag | Description |
41+
|------|-------------|
42+
| `--json` | Output as JSON |
43+
44+
### `yavy generate <org/project>`
45+
46+
Generates a skill file from a project's indexed documentation.
47+
48+
| Flag | Description |
49+
|------|-------------|
50+
| `--global` | Save to global skills directory (`~/.claude/skills/`) |
51+
| `--output <path>` | Custom output path |
52+
| `--force` | Force regeneration even if cached |
53+
| `--json` | Output as JSON |
54+
55+
By default, skills are saved to `.claude/skills/<project>/SKILL.md` in the current directory.
56+
57+
## How It Works
58+
59+
1. Yavy indexes your documentation sources (websites, GitHub repos, Confluence, Notion)
60+
2. The CLI calls the Yavy API to generate a skill using the indexed content
61+
3. The skill file is saved locally for your AI coding tools to discover
62+
4. AI coding assistants automatically activate the skill when working with relevant code
63+
64+
## Related
65+
66+
- [Yavy Claude Code Plugin](https://github.com/yavydev/claude-code) — Claude Code plugin with interactive setup
67+
- [Yavy](https://yavy.dev) — Index documentation, generate AI skills
68+
69+
## License
70+
71+
[MIT](LICENSE)

bin/yavy.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/usr/bin/env node
2+
import '../dist/index.js';

0 commit comments

Comments
 (0)