Skip to content

Commit 7538d5f

Browse files
authored
Merge pull request #2 from yavydev/issue-152-cli-search
feat: add search command for querying indexed documentation
2 parents f3181e9 + 33a5d33 commit 7538d5f

40 files changed

+4343
-1141
lines changed

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
runs-on: ubuntu-latest
1212
strategy:
1313
matrix:
14-
node-version: [18, 20, 22]
14+
node-version: [20, 22]
1515

1616
steps:
1717
- uses: actions/checkout@v4

README.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,52 @@
11
# Yavy CLI
22

3-
Generate AI skills from your indexed documentation on [Yavy](https://yavy.dev).
3+
Search and manage your AI-ready documentation on [Yavy](https://yavy.dev).
44

55
## Installation
66

77
```bash
88
npm install -g @yavydev/cli
99
```
1010

11-
Requires Node.js >= 18.
11+
Requires Node.js >= 20.
1212

1313
## Quick Start
1414

1515
```bash
16-
# Authenticate with your Yavy account
16+
# Interactive setup: authenticate, select projects, configure AI tools
17+
yavy init
18+
19+
# Or authenticate manually
1720
yavy login
1821

22+
# Search your indexed documentation
23+
yavy search "how do I get started?"
24+
1925
# List your projects
2026
yavy projects
21-
22-
# Generate a skill for a project
23-
yavy generate my-org/my-project
2427
```
2528

2629
## Commands
2730

31+
### `yavy init`
32+
33+
Interactive setup wizard that authenticates, selects projects, and configures your AI tools (skills + MCP config) in one step.
34+
35+
| Flag | Description |
36+
| --------------- | ------------------------------------------------------- |
37+
| `--tool <name>` | Configure a specific tool only |
38+
| `--yes` | Non-interactive mode: all detected tools + all projects |
39+
40+
### `yavy search <query>`
41+
42+
Search your indexed documentation directly from the terminal.
43+
44+
| Flag | Description |
45+
| ------------------------- | ---------------------------------- |
46+
| `--project <org/project>` | Scope search to a specific project |
47+
| `--limit <number>` | Maximum results (1-20, default 10) |
48+
| `--json` | Output as JSON |
49+
2850
### `yavy login`
2951

3052
Opens your browser to authenticate with your Yavy account using OAuth (PKCE). Credentials are stored in `~/.yavy/credentials.json`.
@@ -57,8 +79,8 @@ By default, skills are saved to `.claude/skills/<project>/` in the current direc
5779
## How It Works
5880

5981
1. Yavy indexes your documentation sources (websites, GitHub repos, Confluence, Notion)
60-
2. The CLI calls the Yavy API to download a skill using the indexed content
61-
3. The skill file is saved locally for your AI coding tools to discover
82+
2. The CLI calls the Yavy API to search or download skills using the indexed content
83+
3. Skills and MCP configs are saved locally for your AI coding tools to discover
6284
4. AI coding assistants automatically activate the skill when working with relevant code
6385

6486
## Configuration
@@ -71,7 +93,7 @@ By default, skills are saved to `.claude/skills/<project>/` in the current direc
7193
## Related
7294

7395
- [Yavy Claude Code Plugin](https://github.com/yavydev/claude-code) — Claude Code plugin with interactive setup
74-
- [Yavy](https://yavy.dev) — Index documentation, generate AI skills
96+
- [Yavy](https://yavy.dev) — Index documentation, search with AI
7597

7698
## License
7799

0 commit comments

Comments
 (0)