Yavy CLI
Installation
npm install -g @yavydev/cli
Note: Requires Node.js >= 20
Quick Start
yavy init
Interactive setup that authenticates, selects projects, and configures your AI tools in one step.
| Flag | Description |
|---|---|
| --tool |
Configure a specific tool only |
| --yes | Non-interactive mode: all detected tools + all projects |
For standalone authentication: yavy login / yavy logout
Search
yavy search "your query"
Search your indexed documentation directly from the terminal. Results are returned in a readable format optimized for LLM consumption.
| Flag | Description |
|---|---|
| --project <org/project> | Scope search to a specific project |
| --limit |
Maximum number of results (default: 10) |
| --json | Output as JSON for scripting |
Without --project, the search runs across all your indexed projects.
List Projects
yavy projects
| Flag | Description |
|---|---|
| --json | Output as JSON |
Generate Skills
yavy generate <org>/<project>
Generates a Skills package from a project's indexed documentation.
| Flag | Description |
|---|---|
| --global | Save to global skills directory (~/.claude/skills/) |
| --output |
Custom output path |
| --force | Overwrite existing skill files |
| --json | Output as JSON |
Default output:.claude/skills/<project>/ in the current directory.
Configuration
| Variable | Description | Default |
|---|---|---|
| YAVY_BASE_URL | Override API base URL | https://yavy.dev |
| YAVY_CLIENT_ID | Override OAuth client ID | (built-in) |
CI/CD Example
In CI/CD environments, pre-populate credentials before running CLI commands. Authenticate locally with yavy login, then use the generated skill files committed to your repository. For fresh generation, run yavy generate in your pipeline after authenticating.
github-actions.yml
- name: Generate Yavy Skills
run: |
npm install -g @yavydev/cli
yavy generate my-org/my-project --force