Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18, 20, 22]
node-version: [20, 22]

steps:
- uses: actions/checkout@v4
Expand Down
40 changes: 31 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,52 @@
# Yavy CLI

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

## Installation

```bash
npm install -g @yavydev/cli
```

Requires Node.js >= 18.
Requires Node.js >= 20.

## Quick Start

```bash
# Authenticate with your Yavy account
# Interactive setup: authenticate, select projects, configure AI tools
yavy init

# Or authenticate manually
yavy login

# Search your indexed documentation
yavy search "how do I get started?"

# List your projects
yavy projects

# Generate a skill for a project
yavy generate my-org/my-project
```

## Commands

### `yavy init`

Interactive setup wizard that authenticates, selects projects, and configures your AI tools (skills + MCP config) in one step.

| Flag | Description |
| --------------- | ------------------------------------------------------- |
| `--tool <name>` | Configure a specific tool only |
| `--yes` | Non-interactive mode: all detected tools + all projects |

### `yavy search <query>`

Search your indexed documentation directly from the terminal.

| Flag | Description |
| ------------------------- | ---------------------------------- |
| `--project <org/project>` | Scope search to a specific project |
| `--limit <number>` | Maximum results (1-20, default 10) |
| `--json` | Output as JSON |

### `yavy login`

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

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

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

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

## License

Expand Down
Loading
Loading